blob: c3b000eab9df4cec44b4b404f93a292e16cfa760 [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 Moolenaara9b579f2016-07-17 18:29:19 +020032static char *e_funcdict = N_("E717: Dictionary entry already exists");
33static char *e_funcref = N_("E718: Funcref required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +020034
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020035static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010036static void func_clear(ufunc_T *fp, int force);
37static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020056 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010058 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram 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,
91 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010092 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010093
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010094 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
95 return arg;
96 if (newargs != NULL)
97 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010098 int c;
99 int i;
100
101 c = *p;
102 *p = NUL;
103 arg_copy = vim_strsave(arg);
104 if (arg_copy == NULL)
105 {
106 *p = c;
107 return arg;
108 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200109 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200110 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 // Check for duplicate argument name.
112 for (i = 0; i < newargs->ga_len; ++i)
113 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
114 {
115 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
116 vim_free(arg_copy);
117 return arg;
118 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100119 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
120 newargs->ga_len++;
121
122 *p = c;
123 }
124
125 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100126 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100127 {
128 char_u *type = NULL;
129
Bram Moolenaar6e949782020-04-13 17:21:00 +0200130 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
131 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200132 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200133 arg_copy == NULL ? arg : arg_copy);
134 p = skipwhite(p);
135 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100136 if (*p == ':')
137 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200138 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100139 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100141 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 return arg;
143 }
144 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200145 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100146 if (!skip)
147 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100148 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200149 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200150 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200151 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 arg_copy == NULL ? arg : arg_copy);
153 return arg;
154 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100155 if (!skip)
156 {
157 if (type == NULL && types_optional)
158 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200159 type = vim_strsave((char_u *)
160 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100161 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
162 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100163 }
164
165 return p;
166}
167
168/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000169 * Handle line continuation in function arguments or body.
170 * Get a next line, store it in "eap" if appropriate and use "line_to_free" to
171 * handle freeing the line later.
172 */
173 static char_u *
174get_function_line(
175 exarg_T *eap,
176 char_u **line_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000177 int indent,
178 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000179{
180 char_u *theline;
181
182 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000183 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000184 else
185 theline = eap->getline(':', eap->cookie, indent, getline_options);
186 if (theline != NULL)
187 {
188 if (*eap->cmdlinep == *line_to_free)
189 *eap->cmdlinep = theline;
190 vim_free(*line_to_free);
191 *line_to_free = theline;
192 }
193
194 return theline;
195}
196
197/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200198 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100199 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100200 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203get_function_args(
204 char_u **argp,
205 char_u endchar,
206 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100207 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100208 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100209 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200210 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200211 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200212 int skip,
213 exarg_T *eap,
214 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200215{
216 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100217 char_u *arg;
218 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200219 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200220 int any_default = FALSE;
221 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100222 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200223
224 if (newargs != NULL)
225 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100226 if (argtypes != NULL)
227 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200228 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200229 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230
231 if (varargs != NULL)
232 *varargs = FALSE;
233
234 /*
235 * Isolate the arguments: "arg1, arg2, ...)"
236 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100237 arg = skipwhite(*argp);
238 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200239 while (*p != endchar)
240 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200241 while (eap != NULL && eap->getline != NULL
242 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200243 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200244 // End of the line, get the next one.
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000245 char_u *theline = get_function_line(eap, line_to_free, 0,
246 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000247
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200248 if (theline == NULL)
249 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200250 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 p = skipwhite(theline);
252 }
253
254 if (mustend && *p != endchar)
255 {
256 if (!skip)
257 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100258 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200259 }
260 if (*p == endchar)
261 break;
262
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200263 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
264 {
265 if (varargs != NULL)
266 *varargs = TRUE;
267 p += 3;
268 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100269
270 if (argtypes != NULL)
271 {
272 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200273 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100275 if (!skip)
276 emsg(_(e_missing_name_after_dots));
277 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100278 }
279
280 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100281 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200282 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100283 if (p == arg)
284 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100285 if (*skipwhite(p) == '=')
286 {
287 emsg(_(e_cannot_use_default_for_variable_arguments));
288 break;
289 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200291 }
292 else
293 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200294 char_u *np;
295
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200296 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100297 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200298 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100299 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200300 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301
Bram Moolenaar015cf102021-06-26 21:52:02 +0200302 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200303 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200304 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200305 if (*np == '=' && np[1] != '=' && np[1] != '~'
306 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200307 {
308 typval_T rettv;
309
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100310 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200311 any_default = TRUE;
312 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200313 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 p = skipwhite(p);
315 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200316 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200318 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200319 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200320 if (ga_grow(default_args, 1) == FAIL)
321 goto err_ret;
322
323 // trim trailing whitespace
324 while (p > expr && VIM_ISWHITE(p[-1]))
325 p--;
326 c = *p;
327 *p = NUL;
328 expr = vim_strsave(expr);
329 if (expr == NULL)
330 {
331 *p = c;
332 goto err_ret;
333 }
334 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200335 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200336 default_args->ga_len++;
337 *p = c;
338 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200339 }
340 else
341 mustend = TRUE;
342 }
343 else if (any_default)
344 {
345 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200346 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200347 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200348
349 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
350 {
351 // Be tolerant when skipping
352 if (!skip)
353 {
354 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
355 goto err_ret;
356 }
357 p = skipwhite(p);
358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200359 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200360 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200361 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200362 // Don't give this error when skipping, it makes the "->" not
363 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100364 // Allow missing space after comma in legacy functions.
365 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200366 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
367 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100368 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 goto err_ret;
370 }
371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200372 else
373 mustend = TRUE;
374 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200375 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200376 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200378
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200379 if (*p != endchar)
380 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100381 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200382
383 *argp = p;
384 return OK;
385
386err_ret:
387 if (newargs != NULL)
388 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200389 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200390 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200391 return FAIL;
392}
393
394/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100395 * Parse the argument types, filling "fp->uf_arg_types".
396 * Return OK or FAIL.
397 */
398 static int
399parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
400{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200401 int len = 0;
402
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100403 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
404 if (argtypes->ga_len > 0)
405 {
406 // When "varargs" is set the last name/type goes into uf_va_name
407 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200408 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100409
410 if (len > 0)
411 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
412 if (fp->uf_arg_types != NULL)
413 {
414 int i;
415 type_T *type;
416
417 for (i = 0; i < len; ++ i)
418 {
419 char_u *p = ((char_u **)argtypes->ga_data)[i];
420
421 if (p == NULL)
422 // will get the type from the default value
423 type = &t_unknown;
424 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100425 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 if (type == NULL)
427 return FAIL;
428 fp->uf_arg_types[i] = type;
429 }
430 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100431 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200432
433 if (varargs)
434 {
435 char_u *p;
436
437 // Move the last argument "...name: type" to uf_va_name and
438 // uf_va_type.
439 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
440 [fp->uf_args.ga_len - 1];
441 --fp->uf_args.ga_len;
442 p = ((char_u **)argtypes->ga_data)[len];
443 if (p == NULL)
444 // TODO: get type from default value
445 fp->uf_va_type = &t_list_any;
446 else
447 {
448 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
449 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
450 {
451 semsg(_(e_variable_arguments_type_must_be_list_str),
452 ((char_u **)argtypes->ga_data)[len]);
453 return FAIL;
454 }
455 }
456 if (fp->uf_va_type == NULL)
457 return FAIL;
458 }
459
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100460 return OK;
461}
462
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100463 static int
464parse_return_type(ufunc_T *fp, char_u *ret_type)
465{
466 if (ret_type == NULL)
467 fp->uf_ret_type = &t_void;
468 else
469 {
470 char_u *p = ret_type;
471
472 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
473 if (fp->uf_ret_type == NULL)
474 {
475 fp->uf_ret_type = &t_void;
476 return FAIL;
477 }
478 }
479 return OK;
480}
481
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100482/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200483 * Register function "fp" as using "current_funccal" as its scope.
484 */
485 static int
486register_closure(ufunc_T *fp)
487{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200488 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100489 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200490 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200491 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 fp->uf_scoped = current_funccal;
493 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
496 return FAIL;
497 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
498 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 return OK;
500}
501
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100502 static void
503set_ufunc_name(ufunc_T *fp, char_u *name)
504{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100505 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
506 // actually extends beyond the struct.
507 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100508
509 if (name[0] == K_SPECIAL)
510 {
511 fp->uf_name_exp = alloc(STRLEN(name) + 3);
512 if (fp->uf_name_exp != NULL)
513 {
514 STRCPY(fp->uf_name_exp, "<SNR>");
515 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
516 }
517 }
518}
519
Bram Moolenaar58016442016-07-31 18:30:22 +0200520/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200521 * Get a name for a lambda. Returned in static memory.
522 */
523 char_u *
524get_lambda_name(void)
525{
526 static char_u name[30];
527 static int lambda_no = 0;
528
529 sprintf((char*)name, "<lambda>%d", ++lambda_no);
530 return name;
531}
532
Bram Moolenaar801ab062020-06-25 19:27:56 +0200533#if defined(FEAT_LUA) || defined(PROTO)
534/*
535 * Registers a native C callback which can be called from Vim script.
536 * Returns the name of the Vim script function.
537 */
538 char_u *
539register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
540{
541 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200542 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200543
544 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
545 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200546 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200547
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200548 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200549 fp->uf_refcount = 1;
550 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000551 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552 fp->uf_calls = 0;
553 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200554 fp->uf_cb = cb;
555 fp->uf_cb_free = cb_free;
556 fp->uf_cb_state = state;
557
558 set_ufunc_name(fp, name);
559 hash_add(&func_hashtab, UF2HIKEY(fp));
560
561 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562}
563#endif
564
Bram Moolenaar04b12692020-05-04 23:24:44 +0200565/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100566 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100568 * If "white_error" is not NULL check for correct use of white space and set
569 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100570 * Return NULL if no valid arrow found.
571 */
572 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100573skip_arrow(
574 char_u *start,
575 int equal_arrow,
576 char_u **ret_type,
577 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100578{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100579 char_u *s = start;
580 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581
582 if (equal_arrow)
583 {
584 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100585 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100586 if (white_error != NULL && !VIM_ISWHITE(s[1]))
587 {
588 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100589 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100592 s = skipwhite(s + 1);
593 *ret_type = s;
594 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100595 if (s == *ret_type)
596 {
597 emsg(_(e_missing_return_type));
598 return NULL;
599 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100600 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100601 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100602 s = skipwhite(s);
603 if (*s != '=')
604 return NULL;
605 ++s;
606 }
607 if (*s != '>')
608 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100609 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
610 || !IS_WHITE_OR_NUL(s[1])))
611 {
612 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100613 semsg(_(e_white_space_required_before_and_after_str_at_str),
614 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 return NULL;
616 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100617 return skipwhite(s + 1);
618}
619
620/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100621 * Check if "*cmd" points to a function command and if so advance "*cmd" and
622 * return TRUE.
623 * Otherwise return FALSE;
624 * Do not consider "function(" to be a command.
625 */
626 static int
627is_function_cmd(char_u **cmd)
628{
629 char_u *p = *cmd;
630
631 if (checkforcmd(&p, "function", 2))
632 {
633 if (*p == '(')
634 return FALSE;
635 *cmd = p;
636 return TRUE;
637 }
638 return FALSE;
639}
640
641/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200642 * Called when defining a function: The context may be needed for script
643 * variables declared in a block that is visible now but not when the function
644 * is compiled or called later.
645 */
646 static void
647function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
648{
649 if (cstack != NULL && cstack->cs_idx >= 0)
650 {
651 int count = cstack->cs_idx + 1;
652 int i;
653
654 fp->uf_block_ids = ALLOC_MULT(int, count);
655 if (fp->uf_block_ids != NULL)
656 {
657 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
658 sizeof(int) * count);
659 fp->uf_block_depth = count;
660 }
661
662 // Set flag in each block to indicate a function was defined. This
663 // is used to keep the variable when leaving the block, see
664 // hide_script_var().
665 for (i = 0; i <= cstack->cs_idx; ++i)
666 cstack->cs_flags[i] |= CSF_FUNC_DEF;
667 }
668}
669
670/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100671 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200672 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100673 * "newlines" must already have been initialized.
674 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
675 */
676 static int
677get_function_body(
678 exarg_T *eap,
679 garray_T *newlines,
680 char_u *line_arg_in,
681 char_u **line_to_free)
682{
683 linenr_T sourcing_lnum_top = SOURCING_LNUM;
684 linenr_T sourcing_lnum_off;
685 int saved_wait_return = need_wait_return;
686 char_u *line_arg = line_arg_in;
687 int vim9_function = eap->cmdidx == CMD_def
688 || eap->cmdidx == CMD_block;
689#define MAX_FUNC_NESTING 50
690 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100692 int nesting = 0;
693 getline_opt_T getline_options;
694 int indent = 2;
695 char_u *skip_until = NULL;
696 int ret = FAIL;
697 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200698 int heredoc_concat_len = 0;
699 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 char_u *heredoc_trimmed = NULL;
701
Bram Moolenaar20677332021-06-06 17:02:53 +0200702 ga_init2(&heredoc_ga, 1, 500);
703
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100704 // Detect having skipped over comment lines to find the return
705 // type. Add NULL lines to keep the line count correct.
706 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
707 if (SOURCING_LNUM < sourcing_lnum_off)
708 {
709 sourcing_lnum_off -= SOURCING_LNUM;
710 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
711 goto theend;
712 while (sourcing_lnum_off-- > 0)
713 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
714 }
715
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200716 nesting_def[0] = vim9_function;
717 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100718 getline_options = vim9_function
719 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
720 for (;;)
721 {
722 char_u *theline;
723 char_u *p;
724 char_u *arg;
725
726 if (KeyTyped)
727 {
728 msg_scroll = TRUE;
729 saved_wait_return = FALSE;
730 }
731 need_wait_return = FALSE;
732
733 if (line_arg != NULL)
734 {
735 // Use eap->arg, split up in parts by line breaks.
736 theline = line_arg;
737 p = vim_strchr(theline, '\n');
738 if (p == NULL)
739 line_arg += STRLEN(line_arg);
740 else
741 {
742 *p = NUL;
743 line_arg = p + 1;
744 }
745 }
746 else
747 {
Bram Moolenaar7473a842021-12-28 17:55:26 +0000748 theline = get_function_line(eap, line_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100749 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100750 }
751 if (KeyTyped)
752 lines_left = Rows - 1;
753 if (theline == NULL)
754 {
755 // Use the start of the function for the line number.
756 SOURCING_LNUM = sourcing_lnum_top;
757 if (skip_until != NULL)
758 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200759 else if (nesting_inline[nesting])
760 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100761 else if (eap->cmdidx == CMD_def)
762 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100763 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000764 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100765 goto theend;
766 }
767
768 // Detect line continuation: SOURCING_LNUM increased more than one.
769 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
770 if (SOURCING_LNUM < sourcing_lnum_off)
771 sourcing_lnum_off -= SOURCING_LNUM;
772 else
773 sourcing_lnum_off = 0;
774
775 if (skip_until != NULL)
776 {
777 // Don't check for ":endfunc"/":enddef" between
778 // * ":append" and "."
779 // * ":python <<EOF" and "EOF"
780 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
781 if (heredoc_trimmed == NULL
782 || (is_heredoc && skipwhite(theline) == theline)
783 || STRNCMP(theline, heredoc_trimmed,
784 STRLEN(heredoc_trimmed)) == 0)
785 {
786 if (heredoc_trimmed == NULL)
787 p = theline;
788 else if (is_heredoc)
789 p = skipwhite(theline) == theline
790 ? theline : theline + STRLEN(heredoc_trimmed);
791 else
792 p = theline + STRLEN(heredoc_trimmed);
793 if (STRCMP(p, skip_until) == 0)
794 {
795 VIM_CLEAR(skip_until);
796 VIM_CLEAR(heredoc_trimmed);
797 getline_options = vim9_function
798 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
799 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200800
801 if (heredoc_concat_len > 0)
802 {
803 // Replace the starting line with all the concatenated
804 // lines.
805 ga_concat(&heredoc_ga, theline);
806 vim_free(((char_u **)(newlines->ga_data))[
807 heredoc_concat_len - 1]);
808 ((char_u **)(newlines->ga_data))[
809 heredoc_concat_len - 1] = heredoc_ga.ga_data;
810 ga_init(&heredoc_ga);
811 heredoc_concat_len = 0;
812 theline += STRLEN(theline); // skip the "EOF"
813 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100814 }
815 }
816 }
817 else
818 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200819 int c;
820 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100821
822 // skip ':' and blanks
823 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
824 ;
825
826 // Check for "endfunction", "enddef" or "}".
827 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200828 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100829 ? *p == '}'
830 : (checkforcmd(&p, nesting_def[nesting]
831 ? "enddef" : "endfunction", 4)
832 && *p != ':'))
833 {
834 if (nesting-- == 0)
835 {
836 char_u *nextcmd = NULL;
837
838 if (*p == '|' || *p == '}')
839 nextcmd = p + 1;
840 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
841 nextcmd = line_arg;
842 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100843 && (vim9_function || p_verbose > 0))
844 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200845 SOURCING_LNUM = sourcing_lnum_top
846 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100847 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000848 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100849 else
850 give_warning2((char_u *)
851 _("W22: Text found after :endfunction: %s"),
852 p, TRUE);
853 }
854 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100855 {
856 // Another command follows. If the line came from "eap"
857 // we can simply point into it, otherwise we need to
858 // change "eap->cmdlinep".
859 eap->nextcmd = nextcmd;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +0000860 if (*line_to_free != NULL
861 && *eap->cmdlinep != *line_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100862 {
863 vim_free(*eap->cmdlinep);
864 *eap->cmdlinep = *line_to_free;
865 *line_to_free = NULL;
866 }
867 }
868 break;
869 }
870 }
871
872 // Check for mismatched "endfunc" or "enddef".
873 // We don't check for "def" inside "func" thus we also can't check
874 // for "enddef".
875 // We continue to find the end of the function, although we might
876 // not find it.
877 else if (nesting_def[nesting])
878 {
879 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
880 emsg(_(e_mismatched_endfunction));
881 }
882 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
883 emsg(_(e_mismatched_enddef));
884
885 // Increase indent inside "if", "while", "for" and "try", decrease
886 // at "end".
887 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
888 indent -= 2;
889 else if (STRNCMP(p, "if", 2) == 0
890 || STRNCMP(p, "wh", 2) == 0
891 || STRNCMP(p, "for", 3) == 0
892 || STRNCMP(p, "try", 3) == 0)
893 indent += 2;
894
895 // Check for defining a function inside this function.
896 // Only recognize "def" inside "def", not inside "function",
897 // For backwards compatibility, see Test_function_python().
898 c = *p;
899 if (is_function_cmd(&p)
900 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
901 {
902 if (*p == '!')
903 p = skipwhite(p + 1);
904 p += eval_fname_script(p);
905 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
906 NULL, NULL));
907 if (*skipwhite(p) == '(')
908 {
909 if (nesting == MAX_FUNC_NESTING - 1)
910 emsg(_(e_function_nesting_too_deep));
911 else
912 {
913 ++nesting;
914 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200915 nesting_inline[nesting] = FALSE;
916 indent += 2;
917 }
918 }
919 }
920
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200921 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200922 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200923 // Not a comment line: check for nested inline function.
924 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200925 while (end > p && VIM_ISWHITE(*end))
926 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200927 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200928 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200929 int is_block;
930
931 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200932 --end;
933 while (end > p && VIM_ISWHITE(*end))
934 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200935 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
936 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200937 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200938 char_u *s = p;
939
940 // check for line starting with "au" for :autocmd or
941 // "com" for :command, these can use a {} block
942 is_block = checkforcmd_noparen(&s, "autocmd", 2)
943 || checkforcmd_noparen(&s, "command", 3);
944 }
945
946 if (is_block)
947 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200948 if (nesting == MAX_FUNC_NESTING - 1)
949 emsg(_(e_function_nesting_too_deep));
950 else
951 {
952 ++nesting;
953 nesting_def[nesting] = TRUE;
954 nesting_inline[nesting] = TRUE;
955 indent += 2;
956 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100957 }
958 }
959 }
960
961 // Check for ":append", ":change", ":insert". Not for :def.
962 p = skip_range(p, FALSE, NULL);
963 if (!vim9_function
964 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
965 || (p[0] == 'c'
966 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
967 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
968 && (STRNCMP(&p[3], "nge", 3) != 0
969 || !ASCII_ISALPHA(p[6])))))))
970 || (p[0] == 'i'
971 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
972 && (!ASCII_ISALPHA(p[2])
973 || (p[2] == 's'
974 && (!ASCII_ISALPHA(p[3])
975 || p[3] == 'e'))))))))
976 skip_until = vim_strsave((char_u *)".");
977
978 // Check for ":python <<EOF", ":tcl <<EOF", etc.
979 arg = skipwhite(skiptowhite(p));
980 if (arg[0] == '<' && arg[1] =='<'
981 && ((p[0] == 'p' && p[1] == 'y'
982 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
983 || ((p[2] == '3' || p[2] == 'x')
984 && !ASCII_ISALPHA(p[3]))))
985 || (p[0] == 'p' && p[1] == 'e'
986 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
987 || (p[0] == 't' && p[1] == 'c'
988 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
989 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
990 && !ASCII_ISALPHA(p[3]))
991 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
992 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
993 || (p[0] == 'm' && p[1] == 'z'
994 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
995 ))
996 {
997 // ":python <<" continues until a dot, like ":append"
998 p = skipwhite(arg + 2);
999 if (STRNCMP(p, "trim", 4) == 0)
1000 {
1001 // Ignore leading white space.
1002 p = skipwhite(p + 4);
1003 heredoc_trimmed = vim_strnsave(theline,
1004 skipwhite(theline) - theline);
1005 }
1006 if (*p == NUL)
1007 skip_until = vim_strsave((char_u *)".");
1008 else
1009 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1010 getline_options = GETLINE_NONE;
1011 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001012 if (eap->cmdidx == CMD_def)
1013 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001014 }
1015
1016 // Check for ":cmd v =<< [trim] EOF"
1017 // and ":cmd [a, b] =<< [trim] EOF"
1018 // and "lines =<< [trim] EOF" for Vim9
1019 // Where "cmd" can be "let", "var", "final" or "const".
1020 arg = skipwhite(skiptowhite(p));
1021 if (*arg == '[')
1022 arg = vim_strchr(arg, ']');
1023 if (arg != NULL)
1024 {
1025 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1026 && arg[1] == '<' && arg[2] =='<');
1027
1028 if (!found)
1029 // skip over the argument after "cmd"
1030 arg = skipwhite(skiptowhite(arg));
1031 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1032 && (checkforcmd(&p, "let", 2)
1033 || checkforcmd(&p, "var", 3)
1034 || checkforcmd(&p, "final", 5)
1035 || checkforcmd(&p, "const", 5))))
1036 {
1037 p = skipwhite(arg + 3);
1038 if (STRNCMP(p, "trim", 4) == 0)
1039 {
1040 // Ignore leading white space.
1041 p = skipwhite(p + 4);
1042 heredoc_trimmed = vim_strnsave(theline,
1043 skipwhite(theline) - theline);
1044 }
1045 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1046 getline_options = GETLINE_NONE;
1047 is_heredoc = TRUE;
1048 }
1049 }
1050 }
1051
1052 // Add the line to the function.
1053 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1054 goto theend;
1055
Bram Moolenaar20677332021-06-06 17:02:53 +02001056 if (heredoc_concat_len > 0)
1057 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001058 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001059 // to be used for the instruction later.
1060 ga_concat(&heredoc_ga, theline);
1061 ga_concat(&heredoc_ga, (char_u *)"\n");
1062 p = vim_strsave((char_u *)"");
1063 }
1064 else
1065 {
1066 // Copy the line to newly allocated memory. get_one_sourceline()
1067 // allocates 250 bytes per line, this saves 80% on average. The
1068 // cost is an extra alloc/free.
1069 p = vim_strsave(theline);
1070 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001071 if (p == NULL)
1072 goto theend;
1073 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1074
1075 // Add NULL lines for continuation lines, so that the line count is
1076 // equal to the index in the growarray.
1077 while (sourcing_lnum_off-- > 0)
1078 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1079
1080 // Check for end of eap->arg.
1081 if (line_arg != NULL && *line_arg == NUL)
1082 line_arg = NULL;
1083 }
1084
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001085 // Return OK when no error was detected.
1086 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001087 ret = OK;
1088
1089theend:
1090 vim_free(skip_until);
1091 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001092 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001093 need_wait_return |= saved_wait_return;
1094 return ret;
1095}
1096
1097/*
1098 * Handle the body of a lambda. *arg points to the "{", process statements
1099 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001100 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001101 * When successful "rettv" is set to a funcref.
1102 */
1103 static int
1104lambda_function_body(
1105 char_u **arg,
1106 typval_T *rettv,
1107 evalarg_T *evalarg,
1108 garray_T *newargs,
1109 garray_T *argtypes,
1110 int varargs,
1111 garray_T *default_args,
1112 char_u *ret_type)
1113{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001114 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001115 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001116 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001117 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001118 exarg_T eap;
1119 garray_T newlines;
1120 char_u *cmdline = NULL;
1121 int ret = FAIL;
1122 char_u *line_to_free = NULL;
1123 partial_T *pt;
1124 char_u *name;
1125 int lnum_save = -1;
1126 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1127
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001128 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1129 {
1130 semsg(_(e_trailing_arg), *arg + 1);
1131 return FAIL;
1132 }
1133
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001134 CLEAR_FIELD(eap);
1135 eap.cmdidx = CMD_block;
1136 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001137 eap.cmdlinep = &cmdline;
1138 eap.skip = !evaluate;
1139 if (evalarg->eval_cctx != NULL)
1140 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1141 else
1142 {
1143 eap.getline = evalarg->eval_getline;
1144 eap.cookie = evalarg->eval_cookie;
1145 }
1146
1147 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1148 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001149 {
Bram Moolenaar8c697e32021-12-28 20:18:50 +00001150 if (cmdline != line_to_free)
1151 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001152 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001153 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001154
1155 // When inside a lambda must add the function lines to evalarg.eval_ga.
1156 evalarg->eval_break_count += newlines.ga_len;
1157 if (gap->ga_itemsize > 0)
1158 {
1159 int idx;
1160 char_u *last;
1161 size_t plen;
1162 char_u *pnl;
1163
1164 for (idx = 0; idx < newlines.ga_len; ++idx)
1165 {
1166 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1167
Bram Moolenaarecb66452021-05-18 15:09:18 +02001168 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001169 goto erret;
1170
1171 // Going to concatenate the lines after parsing. For an empty or
1172 // comment line use an empty string.
1173 // Insert NL characters at the start of each line, the string will
1174 // be split again later in .get_lambda_tv().
1175 if (*p == NUL || vim9_comment_start(p))
1176 p = (char_u *)"";
1177 plen = STRLEN(p);
1178 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1179 if (pnl != NULL)
1180 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001181 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1182 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001183 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001184 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001185 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001186 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001187 // more is following after the "}", which was skipped
1188 last = cmdline;
1189 else
1190 // nothing is following the "}"
1191 last = (char_u *)"}";
1192 plen = STRLEN(last);
1193 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1194 if (pnl != NULL)
1195 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001196 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1197 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001198 }
1199
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001200 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001201 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001202 garray_T *tfgap = &evalarg->eval_tofree_ga;
1203
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001204 // Something comes after the "}".
1205 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001206
1207 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001208 if (ga_grow(tfgap, 1) == OK)
1209 {
1210 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1211 evalarg->eval_using_cmdline = TRUE;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001212 if (cmdline == line_to_free)
1213 line_to_free = NULL;
Bram Moolenaar844fb642021-10-23 13:32:30 +01001214 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001215 }
1216 else
1217 *arg = (char_u *)"";
1218
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001219 if (!evaluate)
1220 {
1221 ret = OK;
1222 goto erret;
1223 }
1224
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001225 name = get_lambda_name();
1226 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1227 if (ufunc == NULL)
1228 goto erret;
1229 set_ufunc_name(ufunc, name);
1230 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001231 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001232 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001233 ufunc->uf_refcount = 1;
1234 ufunc->uf_args = *newargs;
1235 newargs->ga_data = NULL;
1236 ufunc->uf_def_args = *default_args;
1237 default_args->ga_data = NULL;
1238 ufunc->uf_func_type = &t_func_any;
1239
1240 // error messages are for the first function line
1241 lnum_save = SOURCING_LNUM;
1242 SOURCING_LNUM = sourcing_lnum_top;
1243
1244 // parse argument types
1245 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1246 {
1247 SOURCING_LNUM = lnum_save;
1248 goto erret;
1249 }
1250
1251 // parse the return type, if any
1252 if (parse_return_type(ufunc, ret_type) == FAIL)
1253 goto erret;
1254
1255 pt = ALLOC_CLEAR_ONE(partial_T);
1256 if (pt == NULL)
1257 goto erret;
1258 pt->pt_func = ufunc;
1259 pt->pt_refcount = 1;
1260
1261 ufunc->uf_lines = newlines;
1262 newlines.ga_data = NULL;
1263 if (sandbox)
1264 ufunc->uf_flags |= FC_SANDBOX;
1265 if (!ASCII_ISUPPER(*ufunc->uf_name))
1266 ufunc->uf_flags |= FC_VIM9;
1267 ufunc->uf_script_ctx = current_sctx;
1268 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1269 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1270 set_function_type(ufunc);
1271
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001272 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 rettv->vval.v_partial = pt;
1275 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001276 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001277 ret = OK;
1278
1279erret:
1280 if (lnum_save >= 0)
1281 SOURCING_LNUM = lnum_save;
1282 vim_free(line_to_free);
1283 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001284 if (newargs != NULL)
1285 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001286 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001287 if (ufunc != NULL)
1288 {
1289 func_clear(ufunc, TRUE);
1290 func_free(ufunc, TRUE);
1291 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001292 return ret;
1293}
1294
1295/*
1296 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001297 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001298 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001299 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1300 */
1301 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001302get_lambda_tv(
1303 char_u **arg,
1304 typval_T *rettv,
1305 int types_optional,
1306 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001307{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001308 int evaluate = evalarg != NULL
1309 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001310 garray_T newargs;
1311 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001312 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001313 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001314 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001315 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001316 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001318 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001319 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001320 char_u *s;
1321 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001322 int *old_eval_lavars = eval_lavars_used;
1323 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001324 char_u *tofree1 = NULL;
1325 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001326 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001327 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001328 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001329
1330 if (equal_arrow && !in_vim9script())
1331 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332
1333 ga_init(&newargs);
1334 ga_init(&newlines);
1335
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001336 // First, check if this is really a lambda expression. "->" or "=>" must
1337 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001338 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001339 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001340 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001341 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001342 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001343 {
1344 if (types_optional)
1345 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001346 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001347 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001348
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001349 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001350 if (evaluate)
1351 pnewargs = &newargs;
1352 else
1353 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001354 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001355 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001356 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001357 &varargs, &default_args,
1358 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001359 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001360 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001361 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001362 {
1363 if (types_optional)
1364 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001365 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001366 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001367 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001368 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001370 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1371 if (ret_type != NULL)
1372 {
1373 ret_type = vim_strsave(ret_type);
1374 tofree2 = ret_type;
1375 }
1376
Bram Moolenaare38eab22019-12-05 21:50:01 +01001377 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001378 if (evaluate)
1379 eval_lavars_used = &eval_lavars;
1380
Bram Moolenaar65c44152020-12-24 15:14:01 +01001381 *arg = skipwhite_and_linebreak(*arg, evalarg);
1382
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001383 // Recognize "{" as the start of a function body.
1384 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001385 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001386 if (evalarg == NULL)
1387 // cannot happen?
1388 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001389 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1390 types_optional ? &argtypes : NULL, varargs,
1391 &default_args, ret_type) == FAIL)
1392 goto errret;
1393 goto theend;
1394 }
1395 if (default_args.ga_len > 0)
1396 {
1397 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001398 goto errret;
1399 }
1400
Bram Moolenaare38eab22019-12-05 21:50:01 +01001401 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001402 start = *arg;
1403 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404 if (ret == FAIL)
1405 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001406 if (evalarg != NULL)
1407 {
1408 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001409 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001410 evalarg->eval_tofree = NULL;
1411 }
1412
Bram Moolenaar65c44152020-12-24 15:14:01 +01001413 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001414 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001415 *arg = skipwhite_and_linebreak(*arg, evalarg);
1416 if (**arg != '}')
1417 {
1418 semsg(_("E451: Expected }: %s"), *arg);
1419 goto errret;
1420 }
1421 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001422 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001423
1424 if (evaluate)
1425 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001426 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001427 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001428 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001429 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001430 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001431
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001432 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433 if (fp == NULL)
1434 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001435 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001436 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001437 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001438 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001439
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1441 if (ga_grow(&newlines, 1) == FAIL)
1442 goto errret;
1443
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001444 // If there are line breaks, we need to split up the string.
1445 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001446 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001447 line_end = end;
1448
1449 // Add "return " before the expression (or the first line).
1450 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001451 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452 if (p == NULL)
1453 goto errret;
1454 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1455 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001456 vim_strncpy(p + 7, start, line_end - start);
1457
1458 if (line_end != end)
1459 {
1460 // Add more lines, split by line breaks. Thus is used when a
1461 // lambda with { cmds } is encountered.
1462 while (*line_end == '\n')
1463 {
1464 if (ga_grow(&newlines, 1) == FAIL)
1465 goto errret;
1466 start = line_end + 1;
1467 line_end = vim_strchr(start, '\n');
1468 if (line_end == NULL)
1469 line_end = end;
1470 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1471 vim_strnsave(start, line_end - start);
1472 }
1473 }
1474
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001475 if (strstr((char *)p + 7, "a:") == NULL)
1476 // No a: variables are used for sure.
1477 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478
1479 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001480 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001482 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001483 if (types_optional)
1484 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001485 if (parse_argument_types(fp, &argtypes,
1486 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001487 goto errret;
1488 if (ret_type != NULL)
1489 {
1490 fp->uf_ret_type = parse_type(&ret_type,
1491 &fp->uf_type_list, TRUE);
1492 if (fp->uf_ret_type == NULL)
1493 goto errret;
1494 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001495 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001496 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001497 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001498
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001500 if (current_funccal != NULL && eval_lavars)
1501 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001502 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001503 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001504 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506
1507#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508 if (prof_def_func())
1509 func_do_profile(fp);
1510#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001511 if (sandbox)
1512 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001513 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001514 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1515 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001516 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001518 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001519 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001521 function_using_block_scopes(fp, evalarg->eval_cstack);
1522
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001523 pt->pt_func = fp;
1524 pt->pt_refcount = 1;
1525 rettv->vval.v_partial = pt;
1526 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001527
1528 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001530
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001531theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001532 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001533 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001534 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001535 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001536 vim_free(tofree1);
1537 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001538 if (types_optional)
1539 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001540
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001541 return OK;
1542
1543errret:
1544 ga_clear_strings(&newargs);
1545 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001546 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001547 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001548 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001549 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001550 if (fp != NULL)
1551 vim_free(fp->uf_arg_types);
1552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001554 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001555 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001556 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001557 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001558 vim_free(tofree1);
1559 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001560 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 return FAIL;
1562}
1563
1564/*
1565 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1566 * name it contains, otherwise return "name".
1567 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1568 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001569 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1570 * type of the variable.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001571 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 */
1573 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001574deref_func_name(
1575 char_u *name,
1576 int *lenp,
1577 partial_T **partialp,
1578 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001579 int no_autoload,
1580 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001581{
1582 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001583 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001585 char_u *s = NULL;
1586 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001587 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588
1589 if (partialp != NULL)
1590 *partialp = NULL;
1591
1592 cc = name[*lenp];
1593 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001594
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001595 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001597 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001599 tv = &v->di_tv;
1600 }
1601 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1602 {
1603 imported_T *import;
1604 char_u *p = name;
1605 int len = *lenp;
1606
1607 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001609 p = name + 2;
1610 len -= 2;
1611 }
1612 import = find_imported(p, len, NULL);
1613
1614 // imported variable from another script
1615 if (import != NULL)
1616 {
1617 if (import->imp_funcname != NULL)
1618 {
1619 s = import->imp_funcname;
1620 *lenp = (int)STRLEN(s);
1621 return s;
1622 }
Bram Moolenaarf8a79fc2021-12-14 12:06:16 +00001623 if (import->imp_flags & IMP_FLAGS_STAR)
1624 {
1625 name[len] = NUL;
1626 semsg(_(e_cannot_use_str_itself_it_is_imported_with_star),
1627 name);
1628 name[len] = cc;
1629 *lenp = 0;
1630 return (char_u *)""; // just in case
1631 }
1632 else
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001633 {
1634 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1635 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1636 + import->imp_var_vals_idx;
1637 tv = sv->sv_tv;
1638 if (type != NULL)
1639 *type = sv->sv_type;
1640 did_type = TRUE;
1641 }
1642 }
1643 }
1644
1645 if (tv != NULL)
1646 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001647 if (found_var != NULL)
1648 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001649 if (tv->v_type == VAR_FUNC)
1650 {
1651 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001652 {
1653 *lenp = 0;
1654 return (char_u *)""; // just in case
1655 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001656 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001657 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001659
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001660 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001662 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001663
1664 if (pt == NULL)
1665 {
1666 *lenp = 0;
1667 return (char_u *)""; // just in case
1668 }
1669 if (partialp != NULL)
1670 *partialp = pt;
1671 s = partial_name(pt);
1672 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001673 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001674
1675 if (s != NULL)
1676 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001677 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001678 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001679 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001680
1681 if (sv != NULL)
1682 *type = sv->sv_type;
1683 }
1684 return s;
1685 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001686 }
1687
1688 return name;
1689}
1690
1691/*
1692 * Give an error message with a function name. Handle <SNR> things.
1693 * "ermsg" is to be passed without translation, use N_() instead of _().
1694 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001695 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696emsg_funcname(char *ermsg, char_u *name)
1697{
1698 char_u *p;
1699
1700 if (*name == K_SPECIAL)
1701 p = concat_str((char_u *)"<SNR>", name + 3);
1702 else
1703 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001704 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 if (p != name)
1706 vim_free(p);
1707}
1708
1709/*
1710 * Allocate a variable for the result of a function.
1711 * Return OK or FAIL.
1712 */
1713 int
1714get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001715 char_u *name, // name of the function
1716 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001718 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001719 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001720 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721{
1722 char_u *argp;
1723 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001724 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1725 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001726 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001727
1728 /*
1729 * Get the arguments.
1730 */
1731 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001732 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1733 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001735 // skip the '(' or ',' and possibly line breaks
1736 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1737
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738 if (*argp == ')' || *argp == ',' || *argp == NUL)
1739 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001740 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 {
1742 ret = FAIL;
1743 break;
1744 }
1745 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001746 // The comma should come right after the argument, but this wasn't
1747 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001748 if (vim9script)
1749 {
1750 if (*argp != ',' && *skipwhite(argp) == ',')
1751 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001752 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001753 ret = FAIL;
1754 break;
1755 }
1756 }
1757 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001758 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 if (*argp != ',')
1760 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001761 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1762 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001763 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001764 ret = FAIL;
1765 break;
1766 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001768 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 if (*argp == ')')
1770 ++argp;
1771 else
1772 ret = FAIL;
1773
1774 if (ret == OK)
1775 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001776 int i = 0;
1777 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778
1779 if (get_vim_var_nr(VV_TESTING))
1780 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001781 // Prepare for calling test_garbagecollect_now(), need to know
1782 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783 if (funcargs.ga_itemsize == 0)
1784 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1785 for (i = 0; i < argcount; ++i)
1786 if (ga_grow(&funcargs, 1) == OK)
1787 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1788 &argvars[i];
1789 }
1790
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001791 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001792 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001793 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001794 // An error in a builtin function does not return FAIL, but we do
1795 // want to abort further processing if an error was given.
1796 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001797 clear_tv(rettv);
1798 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799
1800 funcargs.ga_len -= i;
1801 }
1802 else if (!aborting())
1803 {
1804 if (argcount == MAX_FUNC_ARGS)
1805 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1806 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001807 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 }
1809
1810 while (--argcount >= 0)
1811 clear_tv(&argvars[argcount]);
1812
Bram Moolenaar8294d492020-08-10 22:40:56 +02001813 if (in_vim9script())
1814 *arg = argp;
1815 else
1816 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001817 return ret;
1818}
1819
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820/*
1821 * Return TRUE if "p" starts with "<SID>" or "s:".
1822 * Only works if eval_fname_script() returned non-zero for "p"!
1823 */
1824 static int
1825eval_fname_sid(char_u *p)
1826{
1827 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1828}
1829
1830/*
1831 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1832 * Change <SNR>123_name() to K_SNR 123_name().
1833 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1834 * (slow).
1835 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001836 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1838{
1839 int llen;
1840 char_u *fname;
1841 int i;
1842
1843 llen = eval_fname_script(name);
1844 if (llen > 0)
1845 {
1846 fname_buf[0] = K_SPECIAL;
1847 fname_buf[1] = KS_EXTRA;
1848 fname_buf[2] = (int)KE_SNR;
1849 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001850 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001852 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001853 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 else
1855 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001856 sprintf((char *)fname_buf + 3, "%ld_",
1857 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 i = (int)STRLEN(fname_buf);
1859 }
1860 }
1861 if (i + STRLEN(name + llen) < FLEN_FIXED)
1862 {
1863 STRCPY(fname_buf + i, name + llen);
1864 fname = fname_buf;
1865 }
1866 else
1867 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001868 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001869 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001870 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001871 else
1872 {
1873 *tofree = fname;
1874 mch_memmove(fname, fname_buf, (size_t)i);
1875 STRCPY(fname + i, name + llen);
1876 }
1877 }
1878 }
1879 else
1880 fname = name;
1881 return fname;
1882}
1883
1884/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001885 * Find a function "name" in script "sid".
1886 */
1887 static ufunc_T *
1888find_func_with_sid(char_u *name, int sid)
1889{
1890 hashitem_T *hi;
1891 char_u buffer[200];
1892
1893 buffer[0] = K_SPECIAL;
1894 buffer[1] = KS_EXTRA;
1895 buffer[2] = (int)KE_SNR;
1896 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1897 (long)sid, name);
1898 hi = hash_find(&func_hashtab, buffer);
1899 if (!HASHITEM_EMPTY(hi))
1900 return HI2UF(hi);
1901
1902 return NULL;
1903}
1904
1905/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001907 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001908 * Return NULL for unknown function.
1909 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001910 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001911find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001912{
1913 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001914 ufunc_T *func;
1915 imported_T *imported;
1916
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001917 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001918 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001919 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001920 long sid = 0;
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001921 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1922 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001923
Bram Moolenaar95006e32020-08-29 17:47:08 +02001924 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001925 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001926 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001927 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1928 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001929 if (func != NULL)
1930 return func;
1931 }
1932
Bram Moolenaarefa94442020-08-08 22:16:00 +02001933 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001934 && name[1] == KS_EXTRA
1935 && name[2] == KE_SNR)
1936 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001937 // Caller changes s: to <SNR>99_name.
1938
1939 after_script = name + 3;
1940 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001941 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001942 ++after_script;
1943 else
1944 after_script = NULL;
1945 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001946 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001947 {
1948 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001949 if (after_script != NULL && sid != current_sctx.sc_sid)
1950 imported = find_imported_in_script(after_script, 0, sid);
1951 else
1952 imported = find_imported(after_script == NULL
1953 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001954 if (imported != NULL && imported->imp_funcname != NULL)
1955 {
1956 hi = hash_find(&func_hashtab, imported->imp_funcname);
1957 if (!HASHITEM_EMPTY(hi))
1958 return HI2UF(hi);
1959 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 }
1961 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001962
Bram Moolenaara26b9702020-04-18 19:53:28 +02001963 hi = hash_find(&func_hashtab,
1964 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965 if (!HASHITEM_EMPTY(hi))
1966 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001967
1968 return NULL;
1969}
1970
1971/*
1972 * Find a function by name, return pointer to it in ufuncs.
1973 * "cctx" is passed in a :def function to find imported functions.
1974 * Return NULL for unknown or dead function.
1975 */
1976 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001977find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001978{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001979 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001980
1981 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1982 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001983 return NULL;
1984}
1985
1986/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001987 * Return TRUE if "ufunc" is a global function.
1988 */
1989 int
1990func_is_global(ufunc_T *ufunc)
1991{
1992 return ufunc->uf_name[0] != K_SPECIAL;
1993}
1994
1995/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001996 * Copy the function name of "fp" to buffer "buf".
1997 * "buf" must be able to hold the function name plus three bytes.
1998 * Takes care of script-local function names.
1999 */
2000 static void
2001cat_func_name(char_u *buf, ufunc_T *fp)
2002{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002003 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002004 {
2005 STRCPY(buf, "<SNR>");
2006 STRCAT(buf, fp->uf_name + 3);
2007 }
2008 else
2009 STRCPY(buf, fp->uf_name);
2010}
2011
2012/*
2013 * Add a number variable "name" to dict "dp" with value "nr".
2014 */
2015 static void
2016add_nr_var(
2017 dict_T *dp,
2018 dictitem_T *v,
2019 char *name,
2020 varnumber_T nr)
2021{
2022 STRCPY(v->di_key, name);
2023 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2024 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2025 v->di_tv.v_type = VAR_NUMBER;
2026 v->di_tv.v_lock = VAR_FIXED;
2027 v->di_tv.vval.v_number = nr;
2028}
2029
2030/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002031 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002032 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002033 static void
2034free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002035{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002036 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002037
2038 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2039 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002040 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002041
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002042 // When garbage collecting a funccall_T may be freed before the
2043 // function that references it, clear its uf_scoped field.
2044 // The function may have been redefined and point to another
2045 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002046 if (fp != NULL && fp->uf_scoped == fc)
2047 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002048 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002049 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002050
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002051 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052 vim_free(fc);
2053}
2054
2055/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002056 * Free "fc" and what it contains.
2057 * Can be called only when "fc" is kept beyond the period of it called,
2058 * i.e. after cleanup_function_call(fc).
2059 */
2060 static void
2061free_funccal_contents(funccall_T *fc)
2062{
2063 listitem_T *li;
2064
2065 // Free all l: variables.
2066 vars_clear(&fc->l_vars.dv_hashtab);
2067
2068 // Free all a: variables.
2069 vars_clear(&fc->l_avars.dv_hashtab);
2070
2071 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002072 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002073 clear_tv(&li->li_tv);
2074
2075 free_funccal(fc);
2076}
2077
2078/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002079 * Handle the last part of returning from a function: free the local hashtable.
2080 * Unless it is still in use by a closure.
2081 */
2082 static void
2083cleanup_function_call(funccall_T *fc)
2084{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002085 int may_free_fc = fc->fc_refcount <= 0;
2086 int free_fc = TRUE;
2087
Bram Moolenaar6914c642017-04-01 21:21:30 +02002088 current_funccal = fc->caller;
2089
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002090 // Free all l: variables if not referred.
2091 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2092 vars_clear(&fc->l_vars.dv_hashtab);
2093 else
2094 free_fc = FALSE;
2095
2096 // If the a:000 list and the l: and a: dicts are not referenced and
2097 // there is no closure using it, we can free the funccall_T and what's
2098 // in it.
2099 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2100 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002101 else
2102 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002103 int todo;
2104 hashitem_T *hi;
2105 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002106
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002107 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002108
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002109 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002110 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2111 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2112 {
2113 if (!HASHITEM_EMPTY(hi))
2114 {
2115 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002116 di = HI2DI(hi);
2117 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002118 }
2119 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002120 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002121
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002122 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2123 fc->l_varlist.lv_first = NULL;
2124 else
2125 {
2126 listitem_T *li;
2127
2128 free_fc = FALSE;
2129
2130 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002131 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002132 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002134
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002135 if (free_fc)
2136 free_funccal(fc);
2137 else
2138 {
2139 static int made_copy = 0;
2140
2141 // "fc" is still in use. This can happen when returning "a:000",
2142 // assigning "l:" to a global variable or defining a closure.
2143 // Link "fc" in the list for garbage collection later.
2144 fc->caller = previous_funccal;
2145 previous_funccal = fc;
2146
2147 if (want_garbage_collect)
2148 // If garbage collector is ready, clear count.
2149 made_copy = 0;
2150 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002151 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002152 // We have made a lot of copies, worth 4 Mbyte. This can happen
2153 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002154 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002155 // too much memory.
2156 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002157 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002158 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002159 }
2160}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002161
2162/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002163 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2164 */
2165 static int
2166numbered_function(char_u *name)
2167{
2168 return isdigit(*name)
2169 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2170}
2171
2172/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002173 * There are two kinds of function names:
2174 * 1. ordinary names, function defined with :function or :def
2175 * 2. numbered functions and lambdas
2176 * For the first we only count the name stored in func_hashtab as a reference,
2177 * using function() does not count as a reference, because the function is
2178 * looked up by name.
2179 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002180 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002181func_name_refcount(char_u *name)
2182{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002183 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002184}
2185
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002186/*
2187 * Unreference "fc": decrement the reference count and free it when it
2188 * becomes zero. "fp" is detached from "fc".
2189 * When "force" is TRUE we are exiting.
2190 */
2191 static void
2192funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2193{
2194 funccall_T **pfc;
2195 int i;
2196
2197 if (fc == NULL)
2198 return;
2199
2200 if (--fc->fc_refcount <= 0 && (force || (
2201 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2202 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2203 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2204 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2205 {
2206 if (fc == *pfc)
2207 {
2208 *pfc = fc->caller;
2209 free_funccal_contents(fc);
2210 return;
2211 }
2212 }
2213 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2214 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2215 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2216}
2217
2218/*
2219 * Remove the function from the function hashtable. If the function was
2220 * deleted while it still has references this was already done.
2221 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2222 */
2223 static int
2224func_remove(ufunc_T *fp)
2225{
2226 hashitem_T *hi;
2227
2228 // Return if it was already virtually deleted.
2229 if (fp->uf_flags & FC_DEAD)
2230 return FALSE;
2231
2232 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2233 if (!HASHITEM_EMPTY(hi))
2234 {
2235 // When there is a def-function index do not actually remove the
2236 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002237 // Do remove it when it's a copy.
2238 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002239 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002240 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002241 return FALSE;
2242 }
2243 hash_remove(&func_hashtab, hi);
2244 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002245 return TRUE;
2246 }
2247 return FALSE;
2248}
2249
2250 static void
2251func_clear_items(ufunc_T *fp)
2252{
2253 ga_clear_strings(&(fp->uf_args));
2254 ga_clear_strings(&(fp->uf_def_args));
2255 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002256 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002257 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002258 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002259 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002260
2261 // Increment the refcount of this function to avoid it being freed
2262 // recursively when the partial is freed.
2263 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002264 partial_unref(fp->uf_partial);
2265 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002266 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002267
2268#ifdef FEAT_LUA
2269 if (fp->uf_cb_free != NULL)
2270 {
2271 fp->uf_cb_free(fp->uf_cb_state);
2272 fp->uf_cb_free = NULL;
2273 }
2274
2275 fp->uf_cb_state = NULL;
2276 fp->uf_cb = NULL;
2277#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002278#ifdef FEAT_PROFILE
2279 VIM_CLEAR(fp->uf_tml_count);
2280 VIM_CLEAR(fp->uf_tml_total);
2281 VIM_CLEAR(fp->uf_tml_self);
2282#endif
2283}
2284
2285/*
2286 * Free all things that a function contains. Does not free the function
2287 * itself, use func_free() for that.
2288 * When "force" is TRUE we are exiting.
2289 */
2290 static void
2291func_clear(ufunc_T *fp, int force)
2292{
2293 if (fp->uf_cleared)
2294 return;
2295 fp->uf_cleared = TRUE;
2296
2297 // clear this function
2298 func_clear_items(fp);
2299 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002300 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002301}
2302
2303/*
2304 * Free a function and remove it from the list of functions. Does not free
2305 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002306 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002307 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002308 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002309 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002310func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002311{
2312 // Only remove it when not done already, otherwise we would remove a newer
2313 // version of the function with the same name.
2314 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2315 func_remove(fp);
2316
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002317 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002318 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002319 if (fp->uf_dfunc_idx > 0)
2320 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002321 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002322 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002323 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002324 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002325 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002326}
2327
2328/*
2329 * Free all things that a function contains and free the function itself.
2330 * When "force" is TRUE we are exiting.
2331 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002332 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002333func_clear_free(ufunc_T *fp, int force)
2334{
2335 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002336 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2337 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002338 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002339 else
2340 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002341}
2342
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002343/*
2344 * Copy already defined function "lambda" to a new function with name "global".
2345 * This is for when a compiled function defines a global function.
2346 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002347 int
2348copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002349{
2350 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002351 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002352
2353 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002354 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002355 semsg(_(e_lambda_function_not_found_str), lambda);
2356 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002357 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002358
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002359 fp = find_func(global, TRUE, NULL);
2360 if (fp != NULL)
2361 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002362 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002363 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002364 return FAIL;
2365 }
2366
2367 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2368 if (fp == NULL)
2369 return FAIL;
2370
2371 fp->uf_varargs = ufunc->uf_varargs;
2372 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2373 fp->uf_def_status = ufunc->uf_def_status;
2374 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2375 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2376 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2377 == FAIL
2378 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2379 goto failed;
2380
2381 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2382 : vim_strsave(ufunc->uf_name_exp);
2383 if (ufunc->uf_arg_types != NULL)
2384 {
2385 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2386 if (fp->uf_arg_types == NULL)
2387 goto failed;
2388 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2389 sizeof(type_T *) * fp->uf_args.ga_len);
2390 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002391 if (ufunc->uf_va_name != NULL)
2392 {
2393 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2394 if (fp->uf_va_name == NULL)
2395 goto failed;
2396 }
2397 fp->uf_ret_type = ufunc->uf_ret_type;
2398
2399 fp->uf_refcount = 1;
2400 STRCPY(fp->uf_name, global);
2401 hash_add(&func_hashtab, UF2HIKEY(fp));
2402
2403 // the referenced dfunc_T is now used one more time
2404 link_def_function(fp);
2405
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002406 // Create a partial to store the context of the function where it was
2407 // instantiated. Only needs to be done once. Do this on the original
2408 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002409 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2410 {
2411 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2412
2413 if (pt == NULL)
2414 goto failed;
2415 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002416 {
2417 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002418 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002419 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002420 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002421 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002422 }
2423
2424 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002425
2426failed:
2427 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002428 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002429}
2430
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002431static int funcdepth = 0;
2432
2433/*
2434 * Increment the function call depth count.
2435 * Return FAIL when going over 'maxfuncdepth'.
2436 * Otherwise return OK, must call funcdepth_decrement() later!
2437 */
2438 int
2439funcdepth_increment(void)
2440{
2441 if (funcdepth >= p_mfd)
2442 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002443 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002444 return FAIL;
2445 }
2446 ++funcdepth;
2447 return OK;
2448}
2449
2450 void
2451funcdepth_decrement(void)
2452{
2453 --funcdepth;
2454}
2455
2456/*
2457 * Get the current function call depth.
2458 */
2459 int
2460funcdepth_get(void)
2461{
2462 return funcdepth;
2463}
2464
2465/*
2466 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002467 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002468 * times as funcdepth_increment().
2469 */
2470 void
2471funcdepth_restore(int depth)
2472{
2473 funcdepth = depth;
2474}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002475
2476/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477 * Call a user function.
2478 */
2479 static void
2480call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002481 ufunc_T *fp, // pointer to function
2482 int argcount, // nr of args
2483 typval_T *argvars, // arguments
2484 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002485 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002486 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002488 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002489 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 funccall_T *fc;
2491 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002492 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002494 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 int i;
2496 int ai;
2497 int islambda = FALSE;
2498 char_u numbuf[NUMBUFLEN];
2499 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002500 typval_T *tv_to_free[MAX_FUNC_ARGS];
2501 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002503 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002505 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506
Bram Moolenaarb2049902021-01-24 12:53:53 +01002507#ifdef FEAT_PROFILE
2508 CLEAR_FIELD(profile_info);
2509#endif
2510
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002511 // If depth of calling is getting too high, don't execute the function.
2512 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514 rettv->v_type = VAR_NUMBER;
2515 rettv->vval.v_number = -1;
2516 return;
2517 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518
Bram Moolenaare38eab22019-12-05 21:50:01 +01002519 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002521 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002522 if (fc == NULL)
2523 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 fc->caller = current_funccal;
2525 current_funccal = fc;
2526 fc->func = fp;
2527 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002529 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2531 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002532 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002533 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002534 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002536 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002537 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002538#ifdef FEAT_PROFILE
2539 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2540#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002541 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002542#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002543 if (do_profiling == PROF_YES)
2544 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002545#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002546 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002547 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002548#ifdef FEAT_PROFILE
2549 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002550 || (caller != NULL && caller->uf_profiling)))
2551 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002552#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002553 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002554 free_funccal(fc);
2555 return;
2556 }
2557
Bram Moolenaar38453522021-11-28 22:00:12 +00002558 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559
2560 /*
2561 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2562 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2563 * each argument variable and saves a lot of time.
2564 */
2565 /*
2566 * Init l: variables.
2567 */
2568 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2569 if (selfdict != NULL)
2570 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002571 // Set l:self to "selfdict". Use "name" to avoid a warning from
2572 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 v = &fc->fixvar[fixvar_idx++].var;
2574 name = v->di_key;
2575 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002576 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002577 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2578 v->di_tv.v_type = VAR_DICT;
2579 v->di_tv.v_lock = 0;
2580 v->di_tv.vval.v_dict = selfdict;
2581 ++selfdict->dv_refcount;
2582 }
2583
2584 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002585 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002586 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 * Set a:000 to a list with room for the "..." arguments.
2588 */
2589 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002590 if ((fp->uf_flags & FC_NOARGS) == 0)
2591 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002592 (varnumber_T)(argcount >= fp->uf_args.ga_len
2593 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002594 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002595 if ((fp->uf_flags & FC_NOARGS) == 0)
2596 {
2597 // Use "name" to avoid a warning from some compiler that checks the
2598 // destination size.
2599 v = &fc->fixvar[fixvar_idx++].var;
2600 name = v->di_key;
2601 STRCPY(name, "000");
2602 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2603 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2604 v->di_tv.v_type = VAR_LIST;
2605 v->di_tv.v_lock = VAR_FIXED;
2606 v->di_tv.vval.v_list = &fc->l_varlist;
2607 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002608 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002609 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2610 fc->l_varlist.lv_lock = VAR_FIXED;
2611
2612 /*
2613 * Set a:firstline to "firstline" and a:lastline to "lastline".
2614 * Set a:name to named arguments.
2615 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002616 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002617 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002618 if ((fp->uf_flags & FC_NOARGS) == 0)
2619 {
2620 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002621 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002622 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002623 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002624 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002625 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 {
2627 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002628 typval_T def_rettv;
2629 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630
2631 ai = i - fp->uf_args.ga_len;
2632 if (ai < 0)
2633 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002634 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635 name = FUNCARG(fp, i);
2636 if (islambda)
2637 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002638
2639 // evaluate named argument default expression
2640 isdefault = ai + fp->uf_def_args.ga_len >= 0
2641 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2642 && argvars[i].vval.v_number == VVAL_NONE));
2643 if (isdefault)
2644 {
2645 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002646
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002647 def_rettv.v_type = VAR_NUMBER;
2648 def_rettv.vval.v_number = -1;
2649
2650 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2651 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002652 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002653 {
2654 default_arg_err = 1;
2655 break;
2656 }
2657 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658 }
2659 else
2660 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002661 if ((fp->uf_flags & FC_NOARGS) != 0)
2662 // Bail out if no a: arguments used (in lambda).
2663 break;
2664
Bram Moolenaare38eab22019-12-05 21:50:01 +01002665 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 sprintf((char *)numbuf, "%d", ai + 1);
2667 name = numbuf;
2668 }
2669 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2670 {
2671 v = &fc->fixvar[fixvar_idx++].var;
2672 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002673 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 }
2675 else
2676 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002677 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678 if (v == NULL)
2679 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002680 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002683 // Note: the values are copied directly to avoid alloc/free.
2684 // "argvars" must have VAR_FIXED for v_lock.
2685 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 v->di_tv.v_lock = VAR_FIXED;
2687
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002688 if (isdefault)
2689 // Need to free this later, no matter where it's stored.
2690 tv_to_free[tv_to_free_len++] = &v->di_tv;
2691
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692 if (addlocal)
2693 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002694 // Named arguments should be accessed without the "a:" prefix in
2695 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002696 copy_tv(&v->di_tv, &v->di_tv);
2697 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002699 else
2700 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701
2702 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2703 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002704 listitem_T *li = &fc->l_listitems[ai];
2705
2706 li->li_tv = argvars[i];
2707 li->li_tv.v_lock = VAR_FIXED;
2708 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 }
2710 }
2711
Bram Moolenaare38eab22019-12-05 21:50:01 +01002712 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002713 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002714
2715 if (fp->uf_flags & FC_SANDBOX)
2716 {
2717 using_sandbox = TRUE;
2718 ++sandbox;
2719 }
2720
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002721 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002722 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002723 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002725 ++no_wait_return;
2726 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002728 smsg(_("calling %s"), SOURCING_NAME);
2729 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002731 char_u buf[MSG_BUF_LEN];
2732 char_u numbuf2[NUMBUFLEN];
2733 char_u *tofree;
2734 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002735
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002736 msg_puts("(");
2737 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002738 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002739 if (i > 0)
2740 msg_puts(", ");
2741 if (argvars[i].v_type == VAR_NUMBER)
2742 msg_outnum((long)argvars[i].vval.v_number);
2743 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002745 // Do not want errors such as E724 here.
2746 ++emsg_off;
2747 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2748 --emsg_off;
2749 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002751 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002752 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002753 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2754 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002756 msg_puts((char *)s);
2757 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 }
2759 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002761 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002763 msg_puts("\n"); // don't overwrite this either
2764
2765 verbose_leave_scroll();
2766 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 }
2768#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002769 if (do_profiling == PROF_YES)
2770 profile_may_start_func(&profile_info, fp,
2771 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772#endif
2773
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002774 save_current_sctx = current_sctx;
2775 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 save_did_emsg = did_emsg;
2777 did_emsg = FALSE;
2778
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002779 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2780 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002781 else if (islambda)
2782 {
2783 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2784
2785 // A Lambda always has the command "return {expr}". It is much faster
2786 // to evaluate {expr} directly.
2787 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002788 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002789 --ex_nesting_level;
2790 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002791 else
2792 // call do_cmdline() to execute the lines
2793 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2795
2796 --RedrawingDisabled;
2797
Bram Moolenaare38eab22019-12-05 21:50:01 +01002798 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2800 {
2801 clear_tv(rettv);
2802 rettv->v_type = VAR_NUMBER;
2803 rettv->vval.v_number = -1;
2804 }
2805
2806#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002807 if (do_profiling == PROF_YES)
2808 {
2809 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2810
2811 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2812 profile_may_end_func(&profile_info, fp, caller);
2813 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814#endif
2815
Bram Moolenaare38eab22019-12-05 21:50:01 +01002816 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 if (p_verbose >= 12)
2818 {
2819 ++no_wait_return;
2820 verbose_enter_scroll();
2821
2822 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002823 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002825 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 (long)fc->rettv->vval.v_number);
2827 else
2828 {
2829 char_u buf[MSG_BUF_LEN];
2830 char_u numbuf2[NUMBUFLEN];
2831 char_u *tofree;
2832 char_u *s;
2833
Bram Moolenaare38eab22019-12-05 21:50:01 +01002834 // The value may be very long. Skip the middle part, so that we
2835 // have some idea how it starts and ends. smsg() would always
2836 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 ++emsg_off;
2838 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2839 --emsg_off;
2840 if (s != NULL)
2841 {
2842 if (vim_strsize(s) > MSG_BUF_CLEN)
2843 {
2844 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2845 s = buf;
2846 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002847 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 vim_free(tofree);
2849 }
2850 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002851 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852
2853 verbose_leave_scroll();
2854 --no_wait_return;
2855 }
2856
Bram Moolenaare31ee862020-01-07 20:59:34 +01002857 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002858 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002859 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860#ifdef FEAT_PROFILE
2861 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002862 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002863#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002864 if (using_sandbox)
2865 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002867 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 {
2869 ++no_wait_return;
2870 verbose_enter_scroll();
2871
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002872 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002873 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874
2875 verbose_leave_scroll();
2876 --no_wait_return;
2877 }
2878
2879 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002880 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002881 for (i = 0; i < tv_to_free_len; ++i)
2882 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002883 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884}
2885
2886/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002887 * Check the argument count for user function "fp".
2888 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2889 */
2890 int
2891check_user_func_argcount(ufunc_T *fp, int argcount)
2892{
2893 int regular_args = fp->uf_args.ga_len;
2894
2895 if (argcount < regular_args - fp->uf_def_args.ga_len)
2896 return FCERR_TOOFEW;
2897 else if (!has_varargs(fp) && argcount > regular_args)
2898 return FCERR_TOOMANY;
2899 return FCERR_UNKNOWN;
2900}
2901
2902/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002903 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002904 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 int
2906call_user_func_check(
2907 ufunc_T *fp,
2908 int argcount,
2909 typval_T *argvars,
2910 typval_T *rettv,
2911 funcexe_T *funcexe,
2912 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002913{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002914 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002915
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002916 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2917 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002918 error = check_user_func_argcount(fp, argcount);
2919 if (error != FCERR_UNKNOWN)
2920 return error;
2921 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002922 error = FCERR_DICT;
2923 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002924 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002925 int did_save_redo = FALSE;
2926 save_redo_T save_redo;
2927
2928 /*
2929 * Call the user function.
2930 * Save and restore search patterns, script variables and
2931 * redo buffer.
2932 */
2933 save_search_patterns();
2934 if (!ins_compl_active())
2935 {
2936 saveRedobuff(&save_redo);
2937 did_save_redo = TRUE;
2938 }
2939 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002940 call_user_func(fp, argcount, argvars, rettv, funcexe,
2941 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002942 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2943 // Function was unreferenced while being used, free it now.
2944 func_clear_free(fp, FALSE);
2945 if (did_save_redo)
2946 restoreRedobuff(&save_redo);
2947 restore_search_patterns();
2948 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002949 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002950 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002951}
2952
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002953static funccal_entry_T *funccal_stack = NULL;
2954
2955/*
2956 * Save the current function call pointer, and set it to NULL.
2957 * Used when executing autocommands and for ":source".
2958 */
2959 void
2960save_funccal(funccal_entry_T *entry)
2961{
2962 entry->top_funccal = current_funccal;
2963 entry->next = funccal_stack;
2964 funccal_stack = entry;
2965 current_funccal = NULL;
2966}
2967
2968 void
2969restore_funccal(void)
2970{
2971 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002972 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002973 else
2974 {
2975 current_funccal = funccal_stack->top_funccal;
2976 funccal_stack = funccal_stack->next;
2977 }
2978}
2979
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002980 funccall_T *
2981get_current_funccal(void)
2982{
2983 return current_funccal;
2984}
2985
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002986/*
2987 * Mark all functions of script "sid" as deleted.
2988 */
2989 void
2990delete_script_functions(int sid)
2991{
2992 hashitem_T *hi;
2993 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002994 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002995 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002996 size_t len;
2997
2998 buf[0] = K_SPECIAL;
2999 buf[1] = KS_EXTRA;
3000 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003001 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003002 len = STRLEN(buf);
3003
Bram Moolenaarce658352020-07-31 23:47:12 +02003004 while (todo > 0)
3005 {
3006 todo = func_hashtab.ht_used;
3007 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3008 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003009 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003010 fp = HI2UF(hi);
3011 if (STRNCMP(fp->uf_name, buf, len) == 0)
3012 {
3013 int changed = func_hashtab.ht_changed;
3014
3015 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003016
3017 if (fp->uf_calls > 0)
3018 {
3019 // Function is executing, don't free it but do remove
3020 // it from the hashtable.
3021 if (func_remove(fp))
3022 fp->uf_refcount--;
3023 }
3024 else
3025 {
3026 func_clear(fp, TRUE);
3027 // When clearing a function another function can be
3028 // cleared as a side effect. When that happens start
3029 // over.
3030 if (changed != func_hashtab.ht_changed)
3031 break;
3032 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003033 }
3034 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003035 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003036 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003037}
3038
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039#if defined(EXITFREE) || defined(PROTO)
3040 void
3041free_all_functions(void)
3042{
3043 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003044 ufunc_T *fp;
3045 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003046 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003047 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048
Bram Moolenaare38eab22019-12-05 21:50:01 +01003049 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003050 while (current_funccal != NULL)
3051 {
3052 clear_tv(current_funccal->rettv);
3053 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003054 if (current_funccal == NULL && funccal_stack != NULL)
3055 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003056 }
3057
Bram Moolenaare38eab22019-12-05 21:50:01 +01003058 // First clear what the functions contain. Since this may lower the
3059 // reference count of a function, it may also free a function and change
3060 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003061 while (todo > 0)
3062 {
3063 todo = func_hashtab.ht_used;
3064 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3065 if (!HASHITEM_EMPTY(hi))
3066 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003067 // clear the def function index now
3068 fp = HI2UF(hi);
3069 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003070 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071
Bram Moolenaare38eab22019-12-05 21:50:01 +01003072 // Only free functions that are not refcounted, those are
3073 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003074 if (func_name_refcount(fp->uf_name))
3075 ++skipped;
3076 else
3077 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003078 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003079 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003080 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003081 {
3082 skipped = 0;
3083 break;
3084 }
3085 }
3086 --todo;
3087 }
3088 }
3089
Bram Moolenaare38eab22019-12-05 21:50:01 +01003090 // Now actually free the functions. Need to start all over every time,
3091 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003092 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003093 while (func_hashtab.ht_used > skipped)
3094 {
3095 todo = func_hashtab.ht_used;
3096 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097 if (!HASHITEM_EMPTY(hi))
3098 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003099 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003100 // Only free functions that are not refcounted, those are
3101 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003102 fp = HI2UF(hi);
3103 if (func_name_refcount(fp->uf_name))
3104 ++skipped;
3105 else
3106 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003107 if (func_free(fp, FALSE) == OK)
3108 {
3109 skipped = 0;
3110 break;
3111 }
3112 // did not actually free it
3113 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003114 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003116 }
3117 if (skipped == 0)
3118 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003119
3120 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121}
3122#endif
3123
3124/*
3125 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003126 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 * "len" is the length of "name", or -1 for NUL terminated.
3128 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003129 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130builtin_function(char_u *name, int len)
3131{
3132 char_u *p;
3133
Bram Moolenaara26b9702020-04-18 19:53:28 +02003134 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135 return FALSE;
3136 p = vim_strchr(name, AUTOLOAD_CHAR);
3137 return p == NULL || (len > 0 && p > name + len);
3138}
3139
3140 int
3141func_call(
3142 char_u *name,
3143 typval_T *args,
3144 partial_T *partial,
3145 dict_T *selfdict,
3146 typval_T *rettv)
3147{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003148 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003149 listitem_T *item;
3150 typval_T argv[MAX_FUNC_ARGS + 1];
3151 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 int r = 0;
3153
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003154 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003155 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003156 {
3157 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3158 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003159 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 break;
3161 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003162 // Make a copy of each argument. This is needed to be able to set
3163 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 copy_tv(&item->li_tv, &argv[argc++]);
3165 }
3166
3167 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003168 {
3169 funcexe_T funcexe;
3170
Bram Moolenaara80faa82020-04-12 19:37:17 +02003171 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003172 funcexe.fe_firstline = curwin->w_cursor.lnum;
3173 funcexe.fe_lastline = curwin->w_cursor.lnum;
3174 funcexe.fe_evaluate = TRUE;
3175 funcexe.fe_partial = partial;
3176 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003177 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3178 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179
Bram Moolenaare38eab22019-12-05 21:50:01 +01003180 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003181 while (argc > 0)
3182 clear_tv(&argv[--argc]);
3183
3184 return r;
3185}
3186
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003187static int callback_depth = 0;
3188
3189 int
3190get_callback_depth(void)
3191{
3192 return callback_depth;
3193}
3194
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003196 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003197 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003198 */
3199 int
3200call_callback(
3201 callback_T *callback,
3202 int len, // length of "name" or -1 to use strlen()
3203 typval_T *rettv, // return value goes here
3204 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003205 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003206 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003207{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003208 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003209 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003210
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003211 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3212 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003213 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003214 funcexe.fe_evaluate = TRUE;
3215 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003216 ++callback_depth;
3217 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3218 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003219
3220 // When a :def function was called that uses :try an error would be turned
3221 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003222 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003223 {
3224 need_rethrow = FALSE;
3225 handle_did_throw();
3226 }
3227
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003228 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003229}
3230
3231/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003232 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003233 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003234 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3235 */
3236 varnumber_T
3237call_callback_retnr(
3238 callback_T *callback,
3239 int argcount, // number of "argvars"
3240 typval_T *argvars) // vars for arguments, must have "argcount"
3241 // PLUS ONE elements!
3242{
3243 typval_T rettv;
3244 varnumber_T retval;
3245
3246 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003247 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003248
3249 retval = tv_get_number_chk(&rettv, NULL);
3250 clear_tv(&rettv);
3251 return retval;
3252}
3253
3254/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 * Give an error message for the result of a function.
3256 * Nothing if "error" is FCERR_NONE.
3257 */
3258 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003259user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003260{
3261 switch (error)
3262 {
3263 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003264 if (funcexe->fe_found_var)
3265 semsg(_(e_not_callable_type_str), name);
3266 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003267 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 break;
3269 case FCERR_NOTMETHOD:
3270 emsg_funcname(
3271 N_("E276: Cannot use function as a method: %s"), name);
3272 break;
3273 case FCERR_DELETED:
Bram Moolenaarc553a212021-12-26 20:20:34 +00003274 emsg_funcname(e_func_deleted, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003275 break;
3276 case FCERR_TOOMANY:
Bram Moolenaare1242042021-12-16 20:56:57 +00003277 emsg_funcname((char *)e_too_many_arguments_for_function_str,
3278 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 break;
3280 case FCERR_TOOFEW:
Bram Moolenaare1242042021-12-16 20:56:57 +00003281 emsg_funcname((char *)e_not_enough_arguments_for_function_str,
3282 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003283 break;
3284 case FCERR_SCRIPT:
3285 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003286 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287 break;
3288 case FCERR_DICT:
3289 emsg_funcname(
3290 N_("E725: Calling dict function without Dictionary: %s"),
3291 name);
3292 break;
3293 }
3294}
3295
3296/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003298 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 * Return FAIL when the function can't be called, OK otherwise.
3300 * Also returns OK when an error was encountered while executing the function.
3301 */
3302 int
3303call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003304 char_u *funcname, // name of the function
3305 int len, // length of "name" or -1 to use strlen()
3306 typval_T *rettv, // return value goes here
3307 int argcount_in, // number of "argvars"
3308 typval_T *argvars_in, // vars for arguments, must have "argcount"
3309 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003310 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311{
3312 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003313 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003315 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 char_u fname_buf[FLEN_FIXED + 1];
3317 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003318 char_u *fname = NULL;
3319 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 int argcount = argcount_in;
3321 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003322 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003323 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003324 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003326 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003327 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003328 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003329 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003331 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3332 // even when call_func() returns FAIL.
3333 rettv->v_type = VAR_UNKNOWN;
3334
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003335 if (partial != NULL)
3336 fp = partial->pt_func;
3337 if (fp == NULL)
3338 {
3339 // Make a copy of the name, if it comes from a funcref variable it
3340 // could be changed or deleted in the called function.
3341 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3342 if (name == NULL)
3343 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003345 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003348 if (funcexe->fe_doesrange != NULL)
3349 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350
3351 if (partial != NULL)
3352 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 // When the function has a partial with a dict and there is a dict
3354 // argument, use the dict argument. That is backwards compatible.
3355 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003356 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003358 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 {
3360 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003361 {
3362 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3363 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003364 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003365 goto theend;
3366 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003368 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 for (i = 0; i < argcount_in; ++i)
3370 argv[i + argv_clear] = argvars_in[i];
3371 argvars = argv;
3372 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003373
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003374 if (funcexe->fe_check_type != NULL
3375 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003376 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003377 // Now funcexe->fe_check_type is missing the added arguments,
3378 // make a copy of the type with the correction.
3379 check_type = *funcexe->fe_check_type;
3380 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003381 check_type.tt_args = check_type_args;
3382 CLEAR_FIELD(check_type_args);
3383 for (i = 0; i < check_type.tt_argcount; ++i)
3384 check_type_args[i + partial->pt_argc] =
3385 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003386 check_type.tt_argcount += partial->pt_argc;
3387 check_type.tt_min_argcount += partial->pt_argc;
3388 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 }
3390 }
3391
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003392 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3393 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003394 {
3395 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003396 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003397 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003398 error = FCERR_OTHER;
3399 }
3400
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003401 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402 {
3403 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003404 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405
Bram Moolenaar333894b2020-08-01 18:53:07 +02003406 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003407 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003408 {
3409 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003411 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412
Bram Moolenaare38eab22019-12-05 21:50:01 +01003413 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003415 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003417 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 {
3419 /*
3420 * User defined function.
3421 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003422 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003423 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424
Bram Moolenaare38eab22019-12-05 21:50:01 +01003425 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 if (fp == NULL
3427 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003428 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 && !aborting())
3430 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003431 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003432 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003434 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3436 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003437 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003438 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003440 if (fp == NULL)
3441 {
3442 char_u *p = untrans_function_name(rfname);
3443
3444 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003445 // Don't do this if the name starts with "s:".
3446 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003447 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003448 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003450 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003451 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003452#ifdef FEAT_LUA
3453 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3454 {
3455 cfunc_T cb = fp->uf_cb;
3456
3457 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3458 }
3459#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003460 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003462 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003463 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003464 argcount = funcexe->fe_argv_func(argcount, argvars,
3465 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003466
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003467 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003468 {
3469 // Method call: base->Method()
3470 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003471 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003472 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003473 argvars = argv;
3474 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003475 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003476
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003477 error = call_user_func_check(fp, argcount, argvars, rettv,
3478 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 }
3480 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003481 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003482 {
3483 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003484 * expr->method(): Find the method name in the table, call its
3485 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003486 */
3487 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003488 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003489 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 else
3491 {
3492 /*
3493 * Find the function name in the table, call its implementation.
3494 */
3495 error = call_internal_func(fname, argcount, argvars, rettv);
3496 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003497
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 /*
3499 * The function call (or "FuncUndefined" autocommand sequence) might
3500 * have been aborted by an error, an interrupt, or an explicitly thrown
3501 * exception that has not been caught so far. This situation can be
3502 * tested for by calling aborting(). For an error in an internal
3503 * function or for the "E132" error in call_user_func(), however, the
3504 * throw point at which the "force_abort" flag (temporarily reset by
3505 * emsg()) is normally updated has not been reached yet. We need to
3506 * update that flag first to make aborting() reliable.
3507 */
3508 update_force_abort();
3509 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003510 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 ret = OK;
3512
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003513theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 /*
3515 * Report an error unless the argument evaluation or function call has been
3516 * cancelled due to an aborting error, an interrupt, or an exception.
3517 */
3518 if (!aborting())
3519 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003520 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003521 }
3522
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003523 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003524 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003525 clear_tv(&argv[--argv_clear + argv_base]);
3526
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003527 vim_free(tofree);
3528 vim_free(name);
3529
3530 return ret;
3531}
3532
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003533 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003534printable_func_name(ufunc_T *fp)
3535{
3536 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3537}
3538
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003540 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 */
3542 static void
3543list_func_head(ufunc_T *fp, int indent)
3544{
3545 int j;
3546
3547 msg_start();
3548 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003549 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003550 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003551 msg_puts("def ");
3552 else
3553 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003554 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 msg_putchar('(');
3556 for (j = 0; j < fp->uf_args.ga_len; ++j)
3557 {
3558 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003559 msg_puts(", ");
3560 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003561 if (fp->uf_arg_types != NULL)
3562 {
3563 char *tofree;
3564
3565 msg_puts(": ");
3566 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3567 vim_free(tofree);
3568 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003569 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3570 {
3571 msg_puts(" = ");
3572 msg_puts(((char **)(fp->uf_def_args.ga_data))
3573 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 }
3576 if (fp->uf_varargs)
3577 {
3578 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003579 msg_puts(", ");
3580 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003582 if (fp->uf_va_name != NULL)
3583 {
3584 if (j)
3585 msg_puts(", ");
3586 msg_puts("...");
3587 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003588 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003589 {
3590 char *tofree;
3591
3592 msg_puts(": ");
3593 msg_puts(type_name(fp->uf_va_type, &tofree));
3594 vim_free(tofree);
3595 }
3596 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003598
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003599 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003600 {
3601 if (fp->uf_ret_type != &t_void)
3602 {
3603 char *tofree;
3604
3605 msg_puts(": ");
3606 msg_puts(type_name(fp->uf_ret_type, &tofree));
3607 vim_free(tofree);
3608 }
3609 }
3610 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003611 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003613 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003615 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003616 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003617 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 msg_clr_eos();
3619 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003620 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621}
3622
3623/*
3624 * Get a function name, translating "<SID>" and "<SNR>".
3625 * Also handles a Funcref in a List or Dictionary.
3626 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003627 * Set "*is_global" to TRUE when the function must be global, unless
3628 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 * flags:
3630 * TFN_INT: internal function name OK
3631 * TFN_QUIET: be quiet
3632 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003633 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 * Advances "pp" to just after the function name (if no error).
3635 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003636 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003637trans_function_name(
3638 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003639 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003640 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003642 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003643 partial_T **partial, // return: partial of a FuncRef
3644 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645{
3646 char_u *name = NULL;
3647 char_u *start;
3648 char_u *end;
3649 int lead;
3650 char_u sid_buf[20];
3651 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003652 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003654 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655
3656 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003657 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658 start = *pp;
3659
Bram Moolenaare38eab22019-12-05 21:50:01 +01003660 // Check for hard coded <SNR>: already translated function ID (from a user
3661 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3663 && (*pp)[2] == (int)KE_SNR)
3664 {
3665 *pp += 3;
3666 len = get_id_len(pp) + 3;
3667 return vim_strnsave(start, len);
3668 }
3669
Bram Moolenaare38eab22019-12-05 21:50:01 +01003670 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3671 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 lead = eval_fname_script(start);
3673 if (lead > 2)
3674 start += lead;
3675
Bram Moolenaare38eab22019-12-05 21:50:01 +01003676 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003677 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 lead > 2 ? 0 : FNE_CHECK_START);
3679 if (end == start)
3680 {
3681 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003682 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 goto theend;
3684 }
3685 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3686 {
3687 /*
3688 * Report an invalid expression in braces, unless the expression
3689 * evaluation has been cancelled due to an aborting error, an
3690 * interrupt, or an exception.
3691 */
3692 if (!aborting())
3693 {
3694 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003695 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 }
3697 else
3698 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3699 goto theend;
3700 }
3701
3702 if (lv.ll_tv != NULL)
3703 {
3704 if (fdp != NULL)
3705 {
3706 fdp->fd_dict = lv.ll_dict;
3707 fdp->fd_newkey = lv.ll_newkey;
3708 lv.ll_newkey = NULL;
3709 fdp->fd_di = lv.ll_di;
3710 }
3711 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3712 {
3713 name = vim_strsave(lv.ll_tv->vval.v_string);
3714 *pp = end;
3715 }
3716 else if (lv.ll_tv->v_type == VAR_PARTIAL
3717 && lv.ll_tv->vval.v_partial != NULL)
3718 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003719 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720 *pp = end;
3721 if (partial != NULL)
3722 *partial = lv.ll_tv->vval.v_partial;
3723 }
3724 else
3725 {
3726 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3727 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003728 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 else
3730 *pp = end;
3731 name = NULL;
3732 }
3733 goto theend;
3734 }
3735
3736 if (lv.ll_name == NULL)
3737 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003738 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 *pp = end;
3740 goto theend;
3741 }
3742
Bram Moolenaare38eab22019-12-05 21:50:01 +01003743 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 if (lv.ll_exp_name != NULL)
3745 {
3746 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003747 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003748 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749 if (name == lv.ll_exp_name)
3750 name = NULL;
3751 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003752 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 {
3754 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003755 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003756 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 if (name == *pp)
3758 name = NULL;
3759 }
3760 if (name != NULL)
3761 {
3762 name = vim_strsave(name);
3763 *pp = end;
3764 if (STRNCMP(name, "<SNR>", 5) == 0)
3765 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003766 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 name[0] = K_SPECIAL;
3768 name[1] = KS_EXTRA;
3769 name[2] = (int)KE_SNR;
3770 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3771 }
3772 goto theend;
3773 }
3774
3775 if (lv.ll_exp_name != NULL)
3776 {
3777 len = (int)STRLEN(lv.ll_exp_name);
3778 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3779 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3780 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003781 // When there was "s:" already or the name expanded to get a
3782 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 lv.ll_name += 2;
3784 len -= 2;
3785 lead = 2;
3786 }
3787 }
3788 else
3789 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003790 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003792 {
3793 if (is_global != NULL && lv.ll_name[0] == 'g')
3794 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003796 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 len = (int)(end - lv.ll_name);
3798 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003799 if (len <= 0)
3800 {
3801 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003802 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003803 goto theend;
3804 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003806 // In Vim9 script a user function is script-local by default, unless it
3807 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003808 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003809 if (vim9script)
3810 {
3811 char_u *p;
3812
3813 // SomeScript#func() is a global function.
3814 for (p = start; *p != NUL && *p != '('; ++p)
3815 if (*p == AUTOLOAD_CHAR)
3816 vim9script = FALSE;
3817 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003818
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 /*
3820 * Copy the function name to allocated memory.
3821 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3822 * Accept <SNR>123_name() outside a script.
3823 */
3824 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003825 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003826 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003828 if (!vim9script)
3829 lead = 3;
3830 if (vim9script || (lv.ll_exp_name != NULL
3831 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 || eval_fname_sid(*pp))
3833 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003835 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003837 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 goto theend;
3839 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003840 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 if (vim9script)
3842 extra = 3 + (int)STRLEN(sid_buf);
3843 else
3844 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845 }
3846 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003847 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3848 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003850 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003851 goto theend;
3852 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003853 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 {
3855 char_u *cp = vim_strchr(lv.ll_name, ':');
3856
3857 if (cp != NULL && cp < end)
3858 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003859 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003860 goto theend;
3861 }
3862 }
3863
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003864 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865 if (name != NULL)
3866 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003867 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 {
3869 name[0] = K_SPECIAL;
3870 name[1] = KS_EXTRA;
3871 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003872 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 STRCPY(name + 3, sid_buf);
3874 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003875 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3876 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 }
3878 *pp = end;
3879
3880theend:
3881 clear_lval(&lv);
3882 return name;
3883}
3884
3885/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003886 * Assuming "name" is the result of trans_function_name() and it was prefixed
3887 * to use the script-local name, return the unmodified name (points into
3888 * "name"). Otherwise return NULL.
3889 * This can be used to first search for a script-local function and fall back
3890 * to the global function if not found.
3891 */
3892 char_u *
3893untrans_function_name(char_u *name)
3894{
3895 char_u *p;
3896
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003897 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003898 {
3899 p = vim_strchr(name, '_');
3900 if (p != NULL)
3901 return p + 1;
3902 }
3903 return NULL;
3904}
3905
3906/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003907 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3908 * current script ID and returns the expanded function name. The caller should
3909 * free the returned name. If not called from a script context or the function
3910 * name doesn't start with these prefixes, then returns NULL.
3911 * This doesn't check whether the script-local function exists or not.
3912 */
3913 char_u *
3914get_scriptlocal_funcname(char_u *funcname)
3915{
3916 char sid_buf[25];
3917 int off;
3918 char_u *newname;
3919
3920 if (funcname == NULL)
3921 return NULL;
3922
3923 if (STRNCMP(funcname, "s:", 2) != 0
3924 && STRNCMP(funcname, "<SID>", 5) != 0)
3925 // The function name is not a script-local function name
3926 return NULL;
3927
3928 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3929 {
3930 emsg(_(e_using_sid_not_in_script_context));
3931 return NULL;
3932 }
3933 // Expand s: prefix into <SNR>nr_<name>
3934 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3935 (long)current_sctx.sc_sid);
3936 off = *funcname == 's' ? 2 : 5;
3937 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3938 if (newname == NULL)
3939 return NULL;
3940 STRCPY(newname, sid_buf);
3941 STRCAT(newname, funcname + off);
3942
3943 return newname;
3944}
3945
3946/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003947 * Call trans_function_name(), except that a lambda is returned as-is.
3948 * Returns the name in allocated memory.
3949 */
3950 char_u *
3951save_function_name(
3952 char_u **name,
3953 int *is_global,
3954 int skip,
3955 int flags,
3956 funcdict_T *fudi)
3957{
3958 char_u *p = *name;
3959 char_u *saved;
3960
3961 if (STRNCMP(p, "<lambda>", 8) == 0)
3962 {
3963 p += 8;
3964 (void)getdigits(&p);
3965 saved = vim_strnsave(*name, p - *name);
3966 if (fudi != NULL)
3967 CLEAR_POINTER(fudi);
3968 }
3969 else
3970 saved = trans_function_name(&p, is_global, skip,
3971 flags, fudi, NULL, NULL);
3972 *name = p;
3973 return saved;
3974}
3975
3976/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003977 * List functions. When "regmatch" is NULL all of then.
3978 * Otherwise functions matching "regmatch".
3979 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003980 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003981list_functions(regmatch_T *regmatch)
3982{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003983 int changed = func_hashtab.ht_changed;
3984 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003985 hashitem_T *hi;
3986
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003987 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003988 {
3989 if (!HASHITEM_EMPTY(hi))
3990 {
3991 ufunc_T *fp = HI2UF(hi);
3992
3993 --todo;
3994 if ((fp->uf_flags & FC_DEAD) == 0
3995 && (regmatch == NULL
3996 ? !message_filtered(fp->uf_name)
3997 && !func_name_refcount(fp->uf_name)
3998 : !isdigit(*fp->uf_name)
3999 && vim_regexec(regmatch, fp->uf_name, 0)))
4000 {
4001 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004002 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004003 {
4004 emsg(_("E454: function list was modified"));
4005 return;
4006 }
4007 }
4008 }
4009 }
4010}
4011
4012/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004013 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004014 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4015 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004016 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004018 ufunc_T *
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004019define_function(exarg_T *eap, char_u *name_arg, char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 int j;
4022 int c;
4023 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004024 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004025 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 char_u *p;
4027 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004028 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 char_u *line_arg = NULL;
4030 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004031 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004032 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 garray_T newlines;
4034 int varargs = FALSE;
4035 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004036 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004037 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004038 int fp_allocated = FALSE;
4039 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004040 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 dictitem_T *v;
4042 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004043 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004046 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004047 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004048 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049
4050 /*
4051 * ":function" without argument: list functions.
4052 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004053 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 {
4055 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004056 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004057 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004058 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 }
4060
4061 /*
4062 * ":function /pat": list functions matching pattern.
4063 */
4064 if (*eap->arg == '/')
4065 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004066 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 if (!eap->skip)
4068 {
4069 regmatch_T regmatch;
4070
4071 c = *p;
4072 *p = NUL;
4073 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4074 *p = c;
4075 if (regmatch.regprog != NULL)
4076 {
4077 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004078 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 vim_regfree(regmatch.regprog);
4080 }
4081 }
4082 if (*p == '/')
4083 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004084 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004085 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 }
4087
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004088 ga_init(&newargs);
4089 ga_init(&argtypes);
4090 ga_init(&default_args);
4091
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 /*
4093 * Get the function name. There are these situations:
4094 * func normal function name
4095 * "name" == func, "fudi.fd_dict" == NULL
4096 * dict.func new dictionary entry
4097 * "name" == NULL, "fudi.fd_dict" set,
4098 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4099 * dict.func existing dict entry with a Funcref
4100 * "name" == func, "fudi.fd_dict" set,
4101 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4102 * dict.func existing dict entry that's not a Funcref
4103 * "name" == NULL, "fudi.fd_dict" set,
4104 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4105 * s:func script-local function name
4106 * g:func global function name, same as "func"
4107 */
4108 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004109 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004111 // nested function, argument is (args).
4112 paren = TRUE;
4113 CLEAR_FIELD(fudi);
4114 }
4115 else
4116 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004117 name = save_function_name(&p, &is_global, eap->skip,
4118 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004119 paren = (vim_strchr(p, '(') != NULL);
4120 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004122 /*
4123 * Return on an invalid expression in braces, unless the expression
4124 * evaluation has been cancelled due to an aborting error, an
4125 * interrupt, or an exception.
4126 */
4127 if (!aborting())
4128 {
4129 if (!eap->skip && fudi.fd_newkey != NULL)
4130 semsg(_(e_dictkey), fudi.fd_newkey);
4131 vim_free(fudi.fd_newkey);
4132 return NULL;
4133 }
4134 else
4135 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004137 }
4138
Bram Moolenaare38eab22019-12-05 21:50:01 +01004139 // An error in a function call during evaluation of an expression in magic
4140 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 saved_did_emsg = did_emsg;
4142 did_emsg = FALSE;
4143
4144 /*
4145 * ":function func" with only function name: list function.
4146 */
4147 if (!paren)
4148 {
4149 if (!ends_excmd(*skipwhite(p)))
4150 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004151 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 goto ret_free;
4153 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004154 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004155 if (eap->nextcmd != NULL)
4156 *p = NUL;
4157 if (!eap->skip && !got_int)
4158 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004159 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004160 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4161 {
4162 char_u *up = untrans_function_name(name);
4163
4164 // With Vim9 script the name was made script-local, if not
4165 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004166 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004167 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004168 }
4169
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 if (fp != NULL)
4171 {
4172 list_func_head(fp, TRUE);
4173 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4174 {
4175 if (FUNCLINE(fp, j) == NULL)
4176 continue;
4177 msg_putchar('\n');
4178 msg_outnum((long)(j + 1));
4179 if (j < 9)
4180 msg_putchar(' ');
4181 if (j < 99)
4182 msg_putchar(' ');
4183 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004184 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 ui_breakcheck();
4186 }
4187 if (!got_int)
4188 {
4189 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004190 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004191 msg_puts(" enddef");
4192 else
4193 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 }
4195 }
4196 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004197 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004198 }
4199 goto ret_free;
4200 }
4201
4202 /*
4203 * ":function name(arg1, arg2)" Define function.
4204 */
4205 p = skipwhite(p);
4206 if (*p != '(')
4207 {
4208 if (!eap->skip)
4209 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004210 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 goto ret_free;
4212 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004213 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 if (vim_strchr(p, '(') != NULL)
4215 p = vim_strchr(p, '(');
4216 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004218 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4219 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004220 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004221 goto ret_free;
4222 }
4223
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004224 // In Vim9 script only global functions can be redefined.
4225 if (vim9script && eap->forceit && !is_global)
4226 {
4227 emsg(_(e_nobang));
4228 goto ret_free;
4229 }
4230
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004231 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232
Bram Moolenaar04b12692020-05-04 23:24:44 +02004233 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004235 // Check the name of the function. Unless it's a dictionary function
4236 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 if (name != NULL)
4238 arg = name;
4239 else
4240 arg = fudi.fd_newkey;
4241 if (arg != NULL && (fudi.fd_di == NULL
4242 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4243 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4244 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004245 char_u *name_base = arg;
4246 int i;
4247
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004249 {
4250 name_base = vim_strchr(arg, '_');
4251 if (name_base == NULL)
4252 name_base = arg + 3;
4253 else
4254 ++name_base;
4255 }
4256 for (i = 0; name_base[i] != NUL && (i == 0
4257 ? eval_isnamec1(name_base[i])
4258 : eval_isnamec(name_base[i])); ++i)
4259 ;
4260 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004262
4263 // In Vim9 script a function cannot have the same name as a
4264 // variable.
4265 if (vim9script && *arg == K_SPECIAL
Mike Williams1821d142021-12-15 16:38:33 +00004266 && eval_variable(name_base, (int)STRLEN(name_base), NULL, NULL,
Bram Moolenaar052ff292021-12-11 13:54:46 +00004267 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4268 + EVAL_VAR_NO_FUNC) == OK)
4269 {
4270 semsg(_(e_redefining_script_item_str), name_base);
4271 goto ret_free;
4272 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004274 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004276 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004277 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004278 goto ret_free;
4279 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 }
4281
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004282 // This may get more lines and make the pointers into the first line
4283 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004284 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004285 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004286 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004287 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004288 eap, line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004290 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004292 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004294 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004295 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004297 if (*p != ':')
4298 {
4299 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4300 p = skipwhite(p);
4301 }
4302 else if (!IS_WHITE_OR_NUL(p[1]))
4303 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004304 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004305 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004306 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004307 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004308 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004309 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004310 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004311 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004312 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004313 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004314 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004315 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004316 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004318 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004320 else
4321 // find extra arguments "range", "dict", "abort" and "closure"
4322 for (;;)
4323 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004324 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004325 p = skipwhite(p);
4326 if (STRNCMP(p, "range", 5) == 0)
4327 {
4328 flags |= FC_RANGE;
4329 p += 5;
4330 }
4331 else if (STRNCMP(p, "dict", 4) == 0)
4332 {
4333 flags |= FC_DICT;
4334 p += 4;
4335 }
4336 else if (STRNCMP(p, "abort", 5) == 0)
4337 {
4338 flags |= FC_ABORT;
4339 p += 5;
4340 }
4341 else if (STRNCMP(p, "closure", 7) == 0)
4342 {
4343 flags |= FC_CLOSURE;
4344 p += 7;
4345 if (current_funccal == NULL)
4346 {
4347 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4348 name == NULL ? (char_u *)"" : name);
4349 goto erret;
4350 }
4351 }
4352 else
4353 break;
4354 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355
Bram Moolenaare38eab22019-12-05 21:50:01 +01004356 // When there is a line break use what follows for the function body.
4357 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 if (*p == '\n')
4359 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004360 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004361 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4362 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004363 && !(VIM_ISWHITE(*whitep) && *p == '#'
4364 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004365 && !eap->skip
4366 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004367 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368
4369 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004370 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4371 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372 */
4373 if (KeyTyped)
4374 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004375 // Check if the function already exists, don't let the user type the
4376 // whole function before telling him it doesn't work! For a script we
4377 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378 if (!eap->skip && !eap->forceit)
4379 {
4380 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004381 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004382 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004383 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 }
4385
4386 if (!eap->skip && did_emsg)
4387 goto erret;
4388
Bram Moolenaare38eab22019-12-05 21:50:01 +01004389 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 cmdline_row = msg_row;
4391 }
4392
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004393 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004394 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004395
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004396 // Do not define the function when getting the body fails and when
4397 // skipping.
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004398 if (get_function_body(eap, &newlines, line_arg, line_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004399 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 goto erret;
4401
4402 /*
4403 * If there are no errors, add the function
4404 */
4405 if (fudi.fd_dict == NULL)
4406 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004407 hashtab_T *ht;
4408
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004409 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4411 {
4412 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4413 name);
4414 goto erret;
4415 }
4416
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004417 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004418 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004420 char_u *uname = untrans_function_name(name);
4421
4422 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4423 }
4424
4425 if (fp != NULL || import != NULL)
4426 {
4427 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004428
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004429 // Function can be replaced with "function!" and when sourcing the
4430 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004431 // A name that is used by an import can not be overruled.
4432 if (import != NULL
4433 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004434 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004435 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004437 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004438 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004439 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004440 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004441 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 goto erret;
4443 }
4444 if (fp->uf_calls > 0)
4445 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004446 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004447 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448 goto erret;
4449 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004450 if (fp->uf_refcount > 1)
4451 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004452 // This function is referenced somewhere, don't redefine it but
4453 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004454 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004455 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004456 fp = NULL;
4457 overwrite = TRUE;
4458 }
4459 else
4460 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004461 char_u *exp_name = fp->uf_name_exp;
4462
4463 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004464 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004465 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004466 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004467 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004468 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004469#ifdef FEAT_PROFILE
4470 fp->uf_profiling = FALSE;
4471 fp->uf_prof_initialized = FALSE;
4472#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004473 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004474 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004475 }
4476 }
4477 else
4478 {
4479 char numbuf[20];
4480
4481 fp = NULL;
4482 if (fudi.fd_newkey == NULL && !eap->forceit)
4483 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004484 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 goto erret;
4486 }
4487 if (fudi.fd_di == NULL)
4488 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004489 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004490 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 goto erret;
4492 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004493 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004494 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 goto erret;
4496
Bram Moolenaare38eab22019-12-05 21:50:01 +01004497 // Give the function a sequential number. Can only be used with a
4498 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 vim_free(name);
4500 sprintf(numbuf, "%d", ++func_nr);
4501 name = vim_strsave((char_u *)numbuf);
4502 if (name == NULL)
4503 goto erret;
4504 }
4505
4506 if (fp == NULL)
4507 {
4508 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4509 {
4510 int slen, plen;
4511 char_u *scriptname;
4512
Bram Moolenaare38eab22019-12-05 21:50:01 +01004513 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004515 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 {
4517 scriptname = autoload_name(name);
4518 if (scriptname != NULL)
4519 {
4520 p = vim_strchr(scriptname, '/');
4521 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004522 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004524 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 j = OK;
4526 vim_free(scriptname);
4527 }
4528 }
4529 if (j == FAIL)
4530 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004531 linenr_T save_lnum = SOURCING_LNUM;
4532
4533 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004534 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004535 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 goto erret;
4537 }
4538 }
4539
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004540 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 if (fp == NULL)
4542 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004543 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004544
4545 if (fudi.fd_dict != NULL)
4546 {
4547 if (fudi.fd_di == NULL)
4548 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004549 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4551 if (fudi.fd_di == NULL)
4552 {
4553 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004554 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 goto erret;
4556 }
4557 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4558 {
4559 vim_free(fudi.fd_di);
4560 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004561 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 goto erret;
4563 }
4564 }
4565 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004566 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 clear_tv(&fudi.fd_di->di_tv);
4568 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570
Bram Moolenaare38eab22019-12-05 21:50:01 +01004571 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 flags |= FC_DICT;
4573 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574 }
4575 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004576 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004577 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004578 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004579
4580 if (eap->cmdidx == CMD_def)
4581 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004582 int lnum_save = SOURCING_LNUM;
4583 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004584
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004585 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004586
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004587 // error messages are for the first function line
4588 SOURCING_LNUM = sourcing_lnum_top;
4589
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004590 // The function may use script variables from the context.
4591 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004592
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004593 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004594 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004595 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004596 free_fp = fp_allocated;
4597 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004598 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004599 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004600
4601 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004602 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004603 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004604 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004605 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004606 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004607 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004608 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004609 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004610 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004611 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004612
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004613 if (fp_allocated)
4614 {
4615 // insert the new function in the function list
4616 set_ufunc_name(fp, name);
4617 if (overwrite)
4618 {
4619 hi = hash_find(&func_hashtab, name);
4620 hi->hi_key = UF2HIKEY(fp);
4621 }
4622 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4623 {
4624 free_fp = TRUE;
4625 goto erret;
4626 }
4627 fp->uf_refcount = 1;
4628 }
4629
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004631 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004632 if ((flags & FC_CLOSURE) != 0)
4633 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004634 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004635 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004636 }
4637 else
4638 fp->uf_scoped = NULL;
4639
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004640#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004641 if (prof_def_func())
4642 func_do_profile(fp);
4643#endif
4644 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004645 if (sandbox)
4646 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004647 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004648 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649 fp->uf_flags = flags;
4650 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004651 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004652 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004653 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004654 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004655 if (is_export)
4656 {
4657 fp->uf_flags |= FC_EXPORT;
4658 // let ex_export() know the export worked.
4659 is_export = FALSE;
4660 }
4661
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004662 if (eap->cmdidx == CMD_def)
4663 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004664 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4665 // :func does not use Vim9 script syntax, even in a Vim9 script file
4666 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004667
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 goto ret_free;
4669
4670erret:
4671 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004672 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004673 if (fp != NULL)
4674 {
4675 ga_init(&fp->uf_args);
4676 ga_init(&fp->uf_def_args);
4677 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004678errret_2:
4679 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004680 if (fp != NULL)
4681 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004682 if (free_fp)
4683 {
4684 vim_free(fp);
4685 fp = NULL;
4686 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004688 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004690 if (name != name_arg)
4691 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004692 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004694
4695 return fp;
4696}
4697
4698/*
4699 * ":function"
4700 */
4701 void
4702ex_function(exarg_T *eap)
4703{
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004704 char_u *line_to_free = NULL;
4705
4706 (void)define_function(eap, NULL, &line_to_free);
4707 vim_free(line_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004708}
4709
4710/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004711 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004712 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004713 */
4714 void
4715ex_defcompile(exarg_T *eap UNUSED)
4716{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004717 long todo = (long)func_hashtab.ht_used;
4718 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004719 hashitem_T *hi;
4720 ufunc_T *ufunc;
4721
4722 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4723 {
4724 if (!HASHITEM_EMPTY(hi))
4725 {
4726 --todo;
4727 ufunc = HI2UF(hi);
4728 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004729 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4730 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004731 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004732 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004733
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004734 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004735 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004736 // a function has been added or removed, need to start over
4737 todo = (long)func_hashtab.ht_used;
4738 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004739 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004740 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004741 }
4742 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004743 }
4744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745}
4746
4747/*
4748 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4749 * Return 2 if "p" starts with "s:".
4750 * Return 0 otherwise.
4751 */
4752 int
4753eval_fname_script(char_u *p)
4754{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004755 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4756 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4758 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4759 return 5;
4760 if (p[0] == 's' && p[1] == ':')
4761 return 2;
4762 return 0;
4763}
4764
4765 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004766translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767{
4768 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004769 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004770 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004771}
4772
4773/*
4774 * Return TRUE when "ufunc" has old-style "..." varargs
4775 * or named varargs "...name: type".
4776 */
4777 int
4778has_varargs(ufunc_T *ufunc)
4779{
4780 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781}
4782
4783/*
4784 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004785 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 */
4787 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004788function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789{
4790 char_u *nm = name;
4791 char_u *p;
4792 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004793 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004794 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004796 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4797 if (no_deref)
4798 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004799 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 nm = skipwhite(nm);
4801
Bram Moolenaare38eab22019-12-05 21:50:01 +01004802 // Only accept "funcname", "funcname ", "funcname (..." and
4803 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004805 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 vim_free(p);
4807 return n;
4808}
4809
Bram Moolenaar113e1072019-01-20 15:30:40 +01004810#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 char_u *
4812get_expanded_name(char_u *name, int check)
4813{
4814 char_u *nm = name;
4815 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004816 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004818 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004819 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004821 if (p != NULL && *nm == NUL
4822 && (!check || translated_function_exists(p, is_global)))
4823 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824
4825 vim_free(p);
4826 return NULL;
4827}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004828#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004830/*
4831 * Function given to ExpandGeneric() to obtain the list of user defined
4832 * function names.
4833 */
4834 char_u *
4835get_user_func_name(expand_T *xp, int idx)
4836{
4837 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004838 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004839 static hashitem_T *hi;
4840 ufunc_T *fp;
4841
4842 if (idx == 0)
4843 {
4844 done = 0;
4845 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004846 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004848 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 {
4850 if (done++ > 0)
4851 ++hi;
4852 while (HASHITEM_EMPTY(hi))
4853 ++hi;
4854 fp = HI2UF(hi);
4855
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004856 // don't show dead, dict and lambda functions
4857 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004858 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004859 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860
4861 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004862 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863
4864 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004865 if (xp->xp_context != EXPAND_USER_FUNC
4866 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004867 {
4868 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004869 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 STRCAT(IObuff, ")");
4871 }
4872 return IObuff;
4873 }
4874 return NULL;
4875}
4876
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004877/*
4878 * ":delfunction {name}"
4879 */
4880 void
4881ex_delfunction(exarg_T *eap)
4882{
4883 ufunc_T *fp = NULL;
4884 char_u *p;
4885 char_u *name;
4886 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004887 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888
4889 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004890 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4891 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 vim_free(fudi.fd_newkey);
4893 if (name == NULL)
4894 {
4895 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004896 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004897 return;
4898 }
4899 if (!ends_excmd(*skipwhite(p)))
4900 {
4901 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004902 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903 return;
4904 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004905 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906 if (eap->nextcmd != NULL)
4907 *p = NUL;
4908
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004909 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004910 {
4911 if (!eap->skip)
4912 semsg(_(e_invarg2), eap->arg);
4913 vim_free(name);
4914 return;
4915 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004917 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918 vim_free(name);
4919
4920 if (!eap->skip)
4921 {
4922 if (fp == NULL)
4923 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004924 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004925 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004926 return;
4927 }
4928 if (fp->uf_calls > 0)
4929 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004930 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 return;
4932 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004933 if (fp->uf_flags & FC_VIM9)
4934 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004935 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004936 return;
4937 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938
4939 if (fudi.fd_dict != NULL)
4940 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004941 // Delete the dict item that refers to the function, it will
4942 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4944 }
4945 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004946 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004947 // A normal function (not a numbered function or lambda) has a
4948 // refcount of 1 for the entry in the hashtable. When deleting
4949 // it and the refcount is more than one, it should be kept.
4950 // A numbered function and lambda should be kept if the refcount is
4951 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004952 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004953 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004954 // Function is still referenced somewhere. Don't free it but
4955 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004956 if (func_remove(fp))
4957 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004958 }
4959 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004960 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004961 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962 }
4963}
4964
4965/*
4966 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004967 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968 */
4969 void
4970func_unref(char_u *name)
4971{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004972 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004974 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004976 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004977 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004980 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004981#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004982 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004983 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004984 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004985}
4986
4987/*
4988 * Unreference a Function: decrement the reference count and free it when it
4989 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004990 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004991 */
4992 void
4993func_ptr_unref(ufunc_T *fp)
4994{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004995 if (fp != NULL && (--fp->uf_refcount <= 0
4996 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4997 && fp->uf_partial->pt_refcount <= 1
4998 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004999 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005000 // Only delete it when it's not being used. Otherwise it's done
5001 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005002 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005003 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004 }
5005}
5006
5007/*
5008 * Count a reference to a Function.
5009 */
5010 void
5011func_ref(char_u *name)
5012{
5013 ufunc_T *fp;
5014
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005015 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005017 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005018 if (fp != NULL)
5019 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005020 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005021 // Only give an error for a numbered function.
5022 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005023 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005024}
5025
5026/*
5027 * Count a reference to a Function.
5028 */
5029 void
5030func_ptr_ref(ufunc_T *fp)
5031{
5032 if (fp != NULL)
5033 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005034}
5035
5036/*
5037 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5038 * referenced from anywhere that is in use.
5039 */
5040 static int
5041can_free_funccal(funccall_T *fc, int copyID)
5042{
5043 return (fc->l_varlist.lv_copyID != copyID
5044 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005045 && fc->l_avars.dv_copyID != copyID
5046 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047}
5048
5049/*
5050 * ":return [expr]"
5051 */
5052 void
5053ex_return(exarg_T *eap)
5054{
5055 char_u *arg = eap->arg;
5056 typval_T rettv;
5057 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005058 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059
5060 if (current_funccal == NULL)
5061 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005062 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063 return;
5064 }
5065
Bram Moolenaar844fb642021-10-23 13:32:30 +01005066 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005067 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5068
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005069 if (eap->skip)
5070 ++emsg_skip;
5071
5072 eap->nextcmd = NULL;
5073 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005074 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005075 {
5076 if (!eap->skip)
5077 returning = do_return(eap, FALSE, TRUE, &rettv);
5078 else
5079 clear_tv(&rettv);
5080 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005081 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005082 else if (!eap->skip)
5083 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005084 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005085 update_force_abort();
5086
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005087 /*
5088 * Return unless the expression evaluation has been cancelled due to an
5089 * aborting error, an interrupt, or an exception.
5090 */
5091 if (!aborting())
5092 returning = do_return(eap, FALSE, TRUE, NULL);
5093 }
5094
Bram Moolenaare38eab22019-12-05 21:50:01 +01005095 // When skipping or the return gets pending, advance to the next command
5096 // in this line (!returning). Otherwise, ignore the rest of the line.
5097 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005098 if (returning)
5099 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005100 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005101 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102
5103 if (eap->skip)
5104 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005105 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106}
5107
5108/*
5109 * ":1,25call func(arg1, arg2)" function call.
5110 */
5111 void
5112ex_call(exarg_T *eap)
5113{
5114 char_u *arg = eap->arg;
5115 char_u *startarg;
5116 char_u *name;
5117 char_u *tofree;
5118 int len;
5119 typval_T rettv;
5120 linenr_T lnum;
5121 int doesrange;
5122 int failed = FALSE;
5123 funcdict_T fudi;
5124 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005125 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005126 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005127 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128
Bram Moolenaare6b53242020-07-01 17:28:33 +02005129 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 if (eap->skip)
5131 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005132 // trans_function_name() doesn't work well when skipping, use eval0()
5133 // instead to skip to any following command, e.g. for:
5134 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005135 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005136 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137 clear_tv(&rettv);
5138 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005139 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140 return;
5141 }
5142
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005143 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5144 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145 if (fudi.fd_newkey != NULL)
5146 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005147 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005148 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005149 vim_free(fudi.fd_newkey);
5150 }
5151 if (tofree == NULL)
5152 return;
5153
Bram Moolenaare38eab22019-12-05 21:50:01 +01005154 // Increase refcount on dictionary, it could get deleted when evaluating
5155 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 if (fudi.fd_dict != NULL)
5157 ++fudi.fd_dict->dv_refcount;
5158
Bram Moolenaare38eab22019-12-05 21:50:01 +01005159 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5160 // contents. For VAR_PARTIAL get its partial, unless we already have one
5161 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005163 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005164 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165
Bram Moolenaare38eab22019-12-05 21:50:01 +01005166 // Skip white space to allow ":call func ()". Not good, but required for
5167 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169 if (*startarg != '(')
5170 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005171 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172 goto end;
5173 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005174 if (in_vim9script() && startarg > arg)
5175 {
5176 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5177 goto end;
5178 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005179
5180 /*
5181 * When skipping, evaluate the function once, to find the end of the
5182 * arguments.
5183 * When the function takes a range, this is discovered after the first
5184 * call, and the loop is broken.
5185 */
5186 if (eap->skip)
5187 {
5188 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005189 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005190 }
5191 else
5192 lnum = eap->line1;
5193 for ( ; lnum <= eap->line2; ++lnum)
5194 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005195 funcexe_T funcexe;
5196
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005197 if (!eap->skip && eap->addr_count > 0)
5198 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005199 if (lnum > curbuf->b_ml.ml_line_count)
5200 {
5201 // If the function deleted lines or switched to another buffer
5202 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005203 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005204 break;
5205 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206 curwin->w_cursor.lnum = lnum;
5207 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209 }
5210 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005211
Bram Moolenaara80faa82020-04-12 19:37:17 +02005212 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005213 funcexe.fe_firstline = eap->line1;
5214 funcexe.fe_lastline = eap->line2;
5215 funcexe.fe_doesrange = &doesrange;
5216 funcexe.fe_evaluate = !eap->skip;
5217 funcexe.fe_partial = partial;
5218 funcexe.fe_selfdict = fudi.fd_dict;
5219 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005220 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005221 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005222 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223 {
5224 failed = TRUE;
5225 break;
5226 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005227 if (has_watchexpr())
5228 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005229
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005230 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005231 if (handle_subscript(&arg, &rettv,
5232 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 {
5234 failed = TRUE;
5235 break;
5236 }
5237
5238 clear_tv(&rettv);
5239 if (doesrange || eap->skip)
5240 break;
5241
Bram Moolenaare38eab22019-12-05 21:50:01 +01005242 // Stop when immediately aborting on error, or when an interrupt
5243 // occurred or an exception was thrown but not caught.
5244 // get_func_tv() returned OK, so that the check for trailing
5245 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005246 if (aborting())
5247 break;
5248 }
5249 if (eap->skip)
5250 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005251 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005252
Bram Moolenaar1d341892021-09-18 15:25:52 +02005253 // When inside :try we need to check for following "| catch" or "| endtry".
5254 // Not when there was an error, but do check if an exception was thrown.
5255 if ((!aborting() || did_throw)
5256 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005258 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005259 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005260 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005261 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005262 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005263 {
5264 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005265 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005266 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005267 }
5268 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005269 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005270 }
5271
5272end:
5273 dict_unref(fudi.fd_dict);
5274 vim_free(tofree);
5275}
5276
5277/*
5278 * Return from a function. Possibly makes the return pending. Also called
5279 * for a pending return at the ":endtry" or after returning from an extra
5280 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5281 * when called due to a ":return" command. "rettv" may point to a typval_T
5282 * with the return rettv. Returns TRUE when the return can be carried out,
5283 * FALSE when the return gets pending.
5284 */
5285 int
5286do_return(
5287 exarg_T *eap,
5288 int reanimate,
5289 int is_cmd,
5290 void *rettv)
5291{
5292 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005293 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294
5295 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005296 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 current_funccal->returned = FALSE;
5298
5299 /*
5300 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5301 * not in its finally clause (which then is to be executed next) is found.
5302 * In this case, make the ":return" pending for execution at the ":endtry".
5303 * Otherwise, return normally.
5304 */
5305 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5306 if (idx >= 0)
5307 {
5308 cstack->cs_pending[idx] = CSTP_RETURN;
5309
5310 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005311 // A pending return again gets pending. "rettv" points to an
5312 // allocated variable with the rettv of the original ":return"'s
5313 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 cstack->cs_rettv[idx] = rettv;
5315 else
5316 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005317 // When undoing a return in order to make it pending, get the stored
5318 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319 if (reanimate)
5320 rettv = current_funccal->rettv;
5321
5322 if (rettv != NULL)
5323 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005324 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005325 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5326 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5327 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005328 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 }
5330 else
5331 cstack->cs_rettv[idx] = NULL;
5332
5333 if (reanimate)
5334 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005335 // The pending return value could be overwritten by a ":return"
5336 // without argument in a finally clause; reset the default
5337 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338 current_funccal->rettv->v_type = VAR_NUMBER;
5339 current_funccal->rettv->vval.v_number = 0;
5340 }
5341 }
5342 report_make_pending(CSTP_RETURN, rettv);
5343 }
5344 else
5345 {
5346 current_funccal->returned = TRUE;
5347
Bram Moolenaare38eab22019-12-05 21:50:01 +01005348 // If the return is carried out now, store the return value. For
5349 // a return immediately after reanimation, the value is already
5350 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351 if (!reanimate && rettv != NULL)
5352 {
5353 clear_tv(current_funccal->rettv);
5354 *current_funccal->rettv = *(typval_T *)rettv;
5355 if (!is_cmd)
5356 vim_free(rettv);
5357 }
5358 }
5359
5360 return idx < 0;
5361}
5362
5363/*
5364 * Free the variable with a pending return value.
5365 */
5366 void
5367discard_pending_return(void *rettv)
5368{
5369 free_tv((typval_T *)rettv);
5370}
5371
5372/*
5373 * Generate a return command for producing the value of "rettv". The result
5374 * is an allocated string. Used by report_pending() for verbose messages.
5375 */
5376 char_u *
5377get_return_cmd(void *rettv)
5378{
5379 char_u *s = NULL;
5380 char_u *tofree = NULL;
5381 char_u numbuf[NUMBUFLEN];
5382
5383 if (rettv != NULL)
5384 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5385 if (s == NULL)
5386 s = (char_u *)"";
5387
5388 STRCPY(IObuff, ":return ");
5389 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5390 if (STRLEN(s) + 8 >= IOSIZE)
5391 STRCPY(IObuff + IOSIZE - 4, "...");
5392 vim_free(tofree);
5393 return vim_strsave(IObuff);
5394}
5395
5396/*
5397 * Get next function line.
5398 * Called by do_cmdline() to get the next line.
5399 * Returns allocated string, or NULL for end of function.
5400 */
5401 char_u *
5402get_func_line(
5403 int c UNUSED,
5404 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005405 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005406 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407{
5408 funccall_T *fcp = (funccall_T *)cookie;
5409 ufunc_T *fp = fcp->func;
5410 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005411 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005412
Bram Moolenaare38eab22019-12-05 21:50:01 +01005413 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005414 if (fcp->dbg_tick != debug_tick)
5415 {
5416 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005417 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005418 fcp->dbg_tick = debug_tick;
5419 }
5420#ifdef FEAT_PROFILE
5421 if (do_profiling == PROF_YES)
5422 func_line_end(cookie);
5423#endif
5424
5425 gap = &fp->uf_lines;
5426 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5427 || fcp->returned)
5428 retval = NULL;
5429 else
5430 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005431 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005432 while (fcp->linenr < gap->ga_len
5433 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5434 ++fcp->linenr;
5435 if (fcp->linenr >= gap->ga_len)
5436 retval = NULL;
5437 else
5438 {
5439 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005440 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005441#ifdef FEAT_PROFILE
5442 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005443 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444#endif
5445 }
5446 }
5447
Bram Moolenaare38eab22019-12-05 21:50:01 +01005448 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005449 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005450 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005451 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005452 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005454 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005455 fcp->dbg_tick = debug_tick;
5456 }
5457
5458 return retval;
5459}
5460
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461/*
5462 * Return TRUE if the currently active function should be ended, because a
5463 * return was encountered or an error occurred. Used inside a ":while".
5464 */
5465 int
5466func_has_ended(void *cookie)
5467{
5468 funccall_T *fcp = (funccall_T *)cookie;
5469
Bram Moolenaare38eab22019-12-05 21:50:01 +01005470 // Ignore the "abort" flag if the abortion behavior has been changed due to
5471 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005472 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5473 || fcp->returned);
5474}
5475
5476/*
5477 * return TRUE if cookie indicates a function which "abort"s on errors.
5478 */
5479 int
5480func_has_abort(
5481 void *cookie)
5482{
5483 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5484}
5485
5486
5487/*
5488 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5489 * Don't do this when "Func" is already a partial that was bound
5490 * explicitly (pt_auto is FALSE).
5491 * Changes "rettv" in-place.
5492 * Returns the updated "selfdict_in".
5493 */
5494 dict_T *
5495make_partial(dict_T *selfdict_in, typval_T *rettv)
5496{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005497 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005498 char_u *tofree = NULL;
5499 ufunc_T *fp;
5500 char_u fname_buf[FLEN_FIXED + 1];
5501 int error;
5502 dict_T *selfdict = selfdict_in;
5503
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005504 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5505 fp = rettv->vval.v_partial->pt_func;
5506 else
5507 {
5508 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5509 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005510 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005511 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005512 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005513 vim_free(tofree);
5514 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515
5516 if (fp != NULL && (fp->uf_flags & FC_DICT))
5517 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005518 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519
5520 if (pt != NULL)
5521 {
5522 pt->pt_refcount = 1;
5523 pt->pt_dict = selfdict;
5524 pt->pt_auto = TRUE;
5525 selfdict = NULL;
5526 if (rettv->v_type == VAR_FUNC)
5527 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005528 // Just a function: Take over the function name and use
5529 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005530 pt->pt_name = rettv->vval.v_string;
5531 }
5532 else
5533 {
5534 partial_T *ret_pt = rettv->vval.v_partial;
5535 int i;
5536
Bram Moolenaare38eab22019-12-05 21:50:01 +01005537 // Partial: copy the function name, use selfdict and copy
5538 // args. Can't take over name or args, the partial might
5539 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005540 if (ret_pt->pt_name != NULL)
5541 {
5542 pt->pt_name = vim_strsave(ret_pt->pt_name);
5543 func_ref(pt->pt_name);
5544 }
5545 else
5546 {
5547 pt->pt_func = ret_pt->pt_func;
5548 func_ptr_ref(pt->pt_func);
5549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005550 if (ret_pt->pt_argc > 0)
5551 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005552 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005553 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005554 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005555 pt->pt_argc = 0;
5556 else
5557 {
5558 pt->pt_argc = ret_pt->pt_argc;
5559 for (i = 0; i < pt->pt_argc; i++)
5560 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5561 }
5562 }
5563 partial_unref(ret_pt);
5564 }
5565 rettv->v_type = VAR_PARTIAL;
5566 rettv->vval.v_partial = pt;
5567 }
5568 }
5569 return selfdict;
5570}
5571
5572/*
5573 * Return the name of the executed function.
5574 */
5575 char_u *
5576func_name(void *cookie)
5577{
5578 return ((funccall_T *)cookie)->func->uf_name;
5579}
5580
5581/*
5582 * Return the address holding the next breakpoint line for a funccall cookie.
5583 */
5584 linenr_T *
5585func_breakpoint(void *cookie)
5586{
5587 return &((funccall_T *)cookie)->breakpoint;
5588}
5589
5590/*
5591 * Return the address holding the debug tick for a funccall cookie.
5592 */
5593 int *
5594func_dbg_tick(void *cookie)
5595{
5596 return &((funccall_T *)cookie)->dbg_tick;
5597}
5598
5599/*
5600 * Return the nesting level for a funccall cookie.
5601 */
5602 int
5603func_level(void *cookie)
5604{
5605 return ((funccall_T *)cookie)->level;
5606}
5607
5608/*
5609 * Return TRUE when a function was ended by a ":return" command.
5610 */
5611 int
5612current_func_returned(void)
5613{
5614 return current_funccal->returned;
5615}
5616
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005617 int
5618free_unref_funccal(int copyID, int testing)
5619{
5620 int did_free = FALSE;
5621 int did_free_funccal = FALSE;
5622 funccall_T *fc, **pfc;
5623
5624 for (pfc = &previous_funccal; *pfc != NULL; )
5625 {
5626 if (can_free_funccal(*pfc, copyID))
5627 {
5628 fc = *pfc;
5629 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005630 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005631 did_free = TRUE;
5632 did_free_funccal = TRUE;
5633 }
5634 else
5635 pfc = &(*pfc)->caller;
5636 }
5637 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005638 // When a funccal was freed some more items might be garbage
5639 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005640 (void)garbage_collect(testing);
5641
5642 return did_free;
5643}
5644
5645/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005646 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005647 */
5648 static funccall_T *
5649get_funccal(void)
5650{
5651 int i;
5652 funccall_T *funccal;
5653 funccall_T *temp_funccal;
5654
5655 funccal = current_funccal;
5656 if (debug_backtrace_level > 0)
5657 {
5658 for (i = 0; i < debug_backtrace_level; i++)
5659 {
5660 temp_funccal = funccal->caller;
5661 if (temp_funccal)
5662 funccal = temp_funccal;
5663 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005664 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005665 debug_backtrace_level = i;
5666 }
5667 }
5668 return funccal;
5669}
5670
5671/*
5672 * Return the hashtable used for local variables in the current funccal.
5673 * Return NULL if there is no current funccal.
5674 */
5675 hashtab_T *
5676get_funccal_local_ht()
5677{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005678 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005679 return NULL;
5680 return &get_funccal()->l_vars.dv_hashtab;
5681}
5682
5683/*
5684 * Return the l: scope variable.
5685 * Return NULL if there is no current funccal.
5686 */
5687 dictitem_T *
5688get_funccal_local_var()
5689{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005690 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005691 return NULL;
5692 return &get_funccal()->l_vars_var;
5693}
5694
5695/*
5696 * Return the hashtable used for argument in the current funccal.
5697 * Return NULL if there is no current funccal.
5698 */
5699 hashtab_T *
5700get_funccal_args_ht()
5701{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005702 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005703 return NULL;
5704 return &get_funccal()->l_avars.dv_hashtab;
5705}
5706
5707/*
5708 * Return the a: scope variable.
5709 * Return NULL if there is no current funccal.
5710 */
5711 dictitem_T *
5712get_funccal_args_var()
5713{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005714 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005715 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005716 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005717}
5718
5719/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005720 * List function variables, if there is a function.
5721 */
5722 void
5723list_func_vars(int *first)
5724{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005725 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005726 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005727 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005728}
5729
5730/*
5731 * If "ht" is the hashtable for local variables in the current funccal, return
5732 * the dict that contains it.
5733 * Otherwise return NULL.
5734 */
5735 dict_T *
5736get_current_funccal_dict(hashtab_T *ht)
5737{
5738 if (current_funccal != NULL
5739 && ht == &current_funccal->l_vars.dv_hashtab)
5740 return &current_funccal->l_vars;
5741 return NULL;
5742}
5743
5744/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005745 * Search hashitem in parent scope.
5746 */
5747 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005748find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005749{
5750 funccall_T *old_current_funccal = current_funccal;
5751 hashtab_T *ht;
5752 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005753 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005754
5755 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5756 return NULL;
5757
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005758 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005759 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005760 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005761 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005762 ht = find_var_ht(name, &varname);
5763 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005764 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005765 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005766 if (!HASHITEM_EMPTY(hi))
5767 {
5768 *pht = ht;
5769 break;
5770 }
5771 }
5772 if (current_funccal == current_funccal->func->uf_scoped)
5773 break;
5774 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005775 }
5776 current_funccal = old_current_funccal;
5777
5778 return hi;
5779}
5780
5781/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005782 * Search variable in parent scope.
5783 */
5784 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005785find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005786{
5787 dictitem_T *v = NULL;
5788 funccall_T *old_current_funccal = current_funccal;
5789 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005790 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005791
5792 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5793 return NULL;
5794
Bram Moolenaare38eab22019-12-05 21:50:01 +01005795 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005796 current_funccal = current_funccal->func->uf_scoped;
5797 while (current_funccal)
5798 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005799 ht = find_var_ht(name, &varname);
5800 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005801 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005802 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005803 if (v != NULL)
5804 break;
5805 }
5806 if (current_funccal == current_funccal->func->uf_scoped)
5807 break;
5808 current_funccal = current_funccal->func->uf_scoped;
5809 }
5810 current_funccal = old_current_funccal;
5811
5812 return v;
5813}
5814
5815/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005816 * Set "copyID + 1" in previous_funccal and callers.
5817 */
5818 int
5819set_ref_in_previous_funccal(int copyID)
5820{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005821 funccall_T *fc;
5822
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005823 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005824 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005825 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005826 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5827 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5828 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5829 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005830 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005831 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005832}
5833
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005834 static int
5835set_ref_in_funccal(funccall_T *fc, int copyID)
5836{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005837 if (fc->fc_copyID != copyID)
5838 {
5839 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005840 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5841 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5842 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5843 || set_ref_in_func(NULL, fc->func, copyID))
5844 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005845 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005846 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005847}
5848
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005849/*
5850 * Set "copyID" in all local vars and arguments in the call stack.
5851 */
5852 int
5853set_ref_in_call_stack(int copyID)
5854{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005855 funccall_T *fc;
5856 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005857
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005858 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5859 if (set_ref_in_funccal(fc, copyID))
5860 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005861
5862 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005863 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5864 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5865 if (set_ref_in_funccal(fc, copyID))
5866 return TRUE;
5867 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005868}
5869
5870/*
5871 * Set "copyID" in all functions available by name.
5872 */
5873 int
5874set_ref_in_functions(int copyID)
5875{
5876 int todo;
5877 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005878 ufunc_T *fp;
5879
5880 todo = (int)func_hashtab.ht_used;
5881 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005882 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005883 if (!HASHITEM_EMPTY(hi))
5884 {
5885 --todo;
5886 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005887 if (!func_name_refcount(fp->uf_name)
5888 && set_ref_in_func(NULL, fp, copyID))
5889 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005890 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005891 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005892 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005893}
5894
5895/*
5896 * Set "copyID" in all function arguments.
5897 */
5898 int
5899set_ref_in_func_args(int copyID)
5900{
5901 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005902
5903 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005904 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5905 copyID, NULL, NULL))
5906 return TRUE;
5907 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005908}
5909
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005910/*
5911 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005912 * Returns TRUE if setting references failed somehow.
5913 */
5914 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005915set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005916{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005917 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005918 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005919 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005920 char_u fname_buf[FLEN_FIXED + 1];
5921 char_u *tofree = NULL;
5922 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005923 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005924
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005925 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005926 return FALSE;
5927
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005928 if (fp_in == NULL)
5929 {
5930 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005931 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005932 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005933 if (fp != NULL)
5934 {
5935 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005936 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005937 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005938
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005939 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005940 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005941}
5942
Bram Moolenaare38eab22019-12-05 21:50:01 +01005943#endif // FEAT_EVAL