blob: 80c64d0deb9229de956e61ed43780a3d53c3e383 [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
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000526 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
622function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623{
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643}
644
645/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200647 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
652get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657{
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664#define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200666 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100675 char_u *heredoc_trimmed = NULL;
676
Bram Moolenaar20677332021-06-06 17:02:53 +0200677 ga_init2(&heredoc_ga, 1, 500);
678
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100723 if (eap->getline == NULL)
724 theline = getcmdline(':', 0L, indent, getline_options);
725 else
726 theline = eap->getline(':', eap->cookie, indent,
727 getline_options);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +0000728 if (*eap->cmdlinep == *line_to_free)
729 *eap->cmdlinep = theline;
730 vim_free(*line_to_free);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100731 *line_to_free = theline;
732 }
733 if (KeyTyped)
734 lines_left = Rows - 1;
735 if (theline == NULL)
736 {
737 // Use the start of the function for the line number.
738 SOURCING_LNUM = sourcing_lnum_top;
739 if (skip_until != NULL)
740 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200741 else if (nesting_inline[nesting])
742 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100743 else if (eap->cmdidx == CMD_def)
744 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100745 else
746 emsg(_("E126: Missing :endfunction"));
747 goto theend;
748 }
749
750 // Detect line continuation: SOURCING_LNUM increased more than one.
751 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
752 if (SOURCING_LNUM < sourcing_lnum_off)
753 sourcing_lnum_off -= SOURCING_LNUM;
754 else
755 sourcing_lnum_off = 0;
756
757 if (skip_until != NULL)
758 {
759 // Don't check for ":endfunc"/":enddef" between
760 // * ":append" and "."
761 // * ":python <<EOF" and "EOF"
762 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
763 if (heredoc_trimmed == NULL
764 || (is_heredoc && skipwhite(theline) == theline)
765 || STRNCMP(theline, heredoc_trimmed,
766 STRLEN(heredoc_trimmed)) == 0)
767 {
768 if (heredoc_trimmed == NULL)
769 p = theline;
770 else if (is_heredoc)
771 p = skipwhite(theline) == theline
772 ? theline : theline + STRLEN(heredoc_trimmed);
773 else
774 p = theline + STRLEN(heredoc_trimmed);
775 if (STRCMP(p, skip_until) == 0)
776 {
777 VIM_CLEAR(skip_until);
778 VIM_CLEAR(heredoc_trimmed);
779 getline_options = vim9_function
780 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
781 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200782
783 if (heredoc_concat_len > 0)
784 {
785 // Replace the starting line with all the concatenated
786 // lines.
787 ga_concat(&heredoc_ga, theline);
788 vim_free(((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1]);
790 ((char_u **)(newlines->ga_data))[
791 heredoc_concat_len - 1] = heredoc_ga.ga_data;
792 ga_init(&heredoc_ga);
793 heredoc_concat_len = 0;
794 theline += STRLEN(theline); // skip the "EOF"
795 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100796 }
797 }
798 }
799 else
800 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200801 int c;
802 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100803
804 // skip ':' and blanks
805 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
806 ;
807
808 // Check for "endfunction", "enddef" or "}".
809 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200810 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100811 ? *p == '}'
812 : (checkforcmd(&p, nesting_def[nesting]
813 ? "enddef" : "endfunction", 4)
814 && *p != ':'))
815 {
816 if (nesting-- == 0)
817 {
818 char_u *nextcmd = NULL;
819
820 if (*p == '|' || *p == '}')
821 nextcmd = p + 1;
822 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
823 nextcmd = line_arg;
824 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100825 && (vim9_function || p_verbose > 0))
826 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200827 SOURCING_LNUM = sourcing_lnum_top
828 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100829 if (eap->cmdidx == CMD_def)
830 semsg(_(e_text_found_after_enddef_str), p);
831 else
832 give_warning2((char_u *)
833 _("W22: Text found after :endfunction: %s"),
834 p, TRUE);
835 }
836 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100837 {
838 // Another command follows. If the line came from "eap"
839 // we can simply point into it, otherwise we need to
840 // change "eap->cmdlinep".
841 eap->nextcmd = nextcmd;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +0000842 if (*line_to_free != NULL
843 && *eap->cmdlinep != *line_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100844 {
845 vim_free(*eap->cmdlinep);
846 *eap->cmdlinep = *line_to_free;
847 *line_to_free = NULL;
848 }
849 }
850 break;
851 }
852 }
853
854 // Check for mismatched "endfunc" or "enddef".
855 // We don't check for "def" inside "func" thus we also can't check
856 // for "enddef".
857 // We continue to find the end of the function, although we might
858 // not find it.
859 else if (nesting_def[nesting])
860 {
861 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
862 emsg(_(e_mismatched_endfunction));
863 }
864 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
865 emsg(_(e_mismatched_enddef));
866
867 // Increase indent inside "if", "while", "for" and "try", decrease
868 // at "end".
869 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
870 indent -= 2;
871 else if (STRNCMP(p, "if", 2) == 0
872 || STRNCMP(p, "wh", 2) == 0
873 || STRNCMP(p, "for", 3) == 0
874 || STRNCMP(p, "try", 3) == 0)
875 indent += 2;
876
877 // Check for defining a function inside this function.
878 // Only recognize "def" inside "def", not inside "function",
879 // For backwards compatibility, see Test_function_python().
880 c = *p;
881 if (is_function_cmd(&p)
882 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
883 {
884 if (*p == '!')
885 p = skipwhite(p + 1);
886 p += eval_fname_script(p);
887 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
888 NULL, NULL));
889 if (*skipwhite(p) == '(')
890 {
891 if (nesting == MAX_FUNC_NESTING - 1)
892 emsg(_(e_function_nesting_too_deep));
893 else
894 {
895 ++nesting;
896 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200897 nesting_inline[nesting] = FALSE;
898 indent += 2;
899 }
900 }
901 }
902
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200903 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200904 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200905 // Not a comment line: check for nested inline function.
906 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200907 while (end > p && VIM_ISWHITE(*end))
908 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200909 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200910 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200911 int is_block;
912
913 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200914 --end;
915 while (end > p && VIM_ISWHITE(*end))
916 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200917 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
918 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200919 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200920 char_u *s = p;
921
922 // check for line starting with "au" for :autocmd or
923 // "com" for :command, these can use a {} block
924 is_block = checkforcmd_noparen(&s, "autocmd", 2)
925 || checkforcmd_noparen(&s, "command", 3);
926 }
927
928 if (is_block)
929 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200930 if (nesting == MAX_FUNC_NESTING - 1)
931 emsg(_(e_function_nesting_too_deep));
932 else
933 {
934 ++nesting;
935 nesting_def[nesting] = TRUE;
936 nesting_inline[nesting] = TRUE;
937 indent += 2;
938 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100939 }
940 }
941 }
942
943 // Check for ":append", ":change", ":insert". Not for :def.
944 p = skip_range(p, FALSE, NULL);
945 if (!vim9_function
946 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
947 || (p[0] == 'c'
948 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
949 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
950 && (STRNCMP(&p[3], "nge", 3) != 0
951 || !ASCII_ISALPHA(p[6])))))))
952 || (p[0] == 'i'
953 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
954 && (!ASCII_ISALPHA(p[2])
955 || (p[2] == 's'
956 && (!ASCII_ISALPHA(p[3])
957 || p[3] == 'e'))))))))
958 skip_until = vim_strsave((char_u *)".");
959
960 // Check for ":python <<EOF", ":tcl <<EOF", etc.
961 arg = skipwhite(skiptowhite(p));
962 if (arg[0] == '<' && arg[1] =='<'
963 && ((p[0] == 'p' && p[1] == 'y'
964 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
965 || ((p[2] == '3' || p[2] == 'x')
966 && !ASCII_ISALPHA(p[3]))))
967 || (p[0] == 'p' && p[1] == 'e'
968 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
969 || (p[0] == 't' && p[1] == 'c'
970 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
971 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
972 && !ASCII_ISALPHA(p[3]))
973 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
974 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
975 || (p[0] == 'm' && p[1] == 'z'
976 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
977 ))
978 {
979 // ":python <<" continues until a dot, like ":append"
980 p = skipwhite(arg + 2);
981 if (STRNCMP(p, "trim", 4) == 0)
982 {
983 // Ignore leading white space.
984 p = skipwhite(p + 4);
985 heredoc_trimmed = vim_strnsave(theline,
986 skipwhite(theline) - theline);
987 }
988 if (*p == NUL)
989 skip_until = vim_strsave((char_u *)".");
990 else
991 skip_until = vim_strnsave(p, skiptowhite(p) - p);
992 getline_options = GETLINE_NONE;
993 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200994 if (eap->cmdidx == CMD_def)
995 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100996 }
997
998 // Check for ":cmd v =<< [trim] EOF"
999 // and ":cmd [a, b] =<< [trim] EOF"
1000 // and "lines =<< [trim] EOF" for Vim9
1001 // Where "cmd" can be "let", "var", "final" or "const".
1002 arg = skipwhite(skiptowhite(p));
1003 if (*arg == '[')
1004 arg = vim_strchr(arg, ']');
1005 if (arg != NULL)
1006 {
1007 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1008 && arg[1] == '<' && arg[2] =='<');
1009
1010 if (!found)
1011 // skip over the argument after "cmd"
1012 arg = skipwhite(skiptowhite(arg));
1013 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1014 && (checkforcmd(&p, "let", 2)
1015 || checkforcmd(&p, "var", 3)
1016 || checkforcmd(&p, "final", 5)
1017 || checkforcmd(&p, "const", 5))))
1018 {
1019 p = skipwhite(arg + 3);
1020 if (STRNCMP(p, "trim", 4) == 0)
1021 {
1022 // Ignore leading white space.
1023 p = skipwhite(p + 4);
1024 heredoc_trimmed = vim_strnsave(theline,
1025 skipwhite(theline) - theline);
1026 }
1027 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1028 getline_options = GETLINE_NONE;
1029 is_heredoc = TRUE;
1030 }
1031 }
1032 }
1033
1034 // Add the line to the function.
1035 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1036 goto theend;
1037
Bram Moolenaar20677332021-06-06 17:02:53 +02001038 if (heredoc_concat_len > 0)
1039 {
1040 // For a :def function "python << EOF" concatenats all the lines,
1041 // to be used for the instruction later.
1042 ga_concat(&heredoc_ga, theline);
1043 ga_concat(&heredoc_ga, (char_u *)"\n");
1044 p = vim_strsave((char_u *)"");
1045 }
1046 else
1047 {
1048 // Copy the line to newly allocated memory. get_one_sourceline()
1049 // allocates 250 bytes per line, this saves 80% on average. The
1050 // cost is an extra alloc/free.
1051 p = vim_strsave(theline);
1052 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001053 if (p == NULL)
1054 goto theend;
1055 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1056
1057 // Add NULL lines for continuation lines, so that the line count is
1058 // equal to the index in the growarray.
1059 while (sourcing_lnum_off-- > 0)
1060 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1061
1062 // Check for end of eap->arg.
1063 if (line_arg != NULL && *line_arg == NUL)
1064 line_arg = NULL;
1065 }
1066
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001067 // Return OK when no error was detected.
1068 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001069 ret = OK;
1070
1071theend:
1072 vim_free(skip_until);
1073 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001074 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001075 need_wait_return |= saved_wait_return;
1076 return ret;
1077}
1078
1079/*
1080 * Handle the body of a lambda. *arg points to the "{", process statements
1081 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001082 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001083 * When successful "rettv" is set to a funcref.
1084 */
1085 static int
1086lambda_function_body(
1087 char_u **arg,
1088 typval_T *rettv,
1089 evalarg_T *evalarg,
1090 garray_T *newargs,
1091 garray_T *argtypes,
1092 int varargs,
1093 garray_T *default_args,
1094 char_u *ret_type)
1095{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001096 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001097 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001098 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001099 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001100 exarg_T eap;
1101 garray_T newlines;
1102 char_u *cmdline = NULL;
1103 int ret = FAIL;
1104 char_u *line_to_free = NULL;
1105 partial_T *pt;
1106 char_u *name;
1107 int lnum_save = -1;
1108 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1109
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001110 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1111 {
1112 semsg(_(e_trailing_arg), *arg + 1);
1113 return FAIL;
1114 }
1115
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001116 CLEAR_FIELD(eap);
1117 eap.cmdidx = CMD_block;
1118 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001119 eap.cmdlinep = &cmdline;
1120 eap.skip = !evaluate;
1121 if (evalarg->eval_cctx != NULL)
1122 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1123 else
1124 {
1125 eap.getline = evalarg->eval_getline;
1126 eap.cookie = evalarg->eval_cookie;
1127 }
1128
1129 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1130 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001131 {
1132 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001133 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001134 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001135
1136 // When inside a lambda must add the function lines to evalarg.eval_ga.
1137 evalarg->eval_break_count += newlines.ga_len;
1138 if (gap->ga_itemsize > 0)
1139 {
1140 int idx;
1141 char_u *last;
1142 size_t plen;
1143 char_u *pnl;
1144
1145 for (idx = 0; idx < newlines.ga_len; ++idx)
1146 {
1147 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1148
Bram Moolenaarecb66452021-05-18 15:09:18 +02001149 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001150 goto erret;
1151
1152 // Going to concatenate the lines after parsing. For an empty or
1153 // comment line use an empty string.
1154 // Insert NL characters at the start of each line, the string will
1155 // be split again later in .get_lambda_tv().
1156 if (*p == NUL || vim9_comment_start(p))
1157 p = (char_u *)"";
1158 plen = STRLEN(p);
1159 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1160 if (pnl != NULL)
1161 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001162 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1163 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001164 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001165 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001166 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001167 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001168 // more is following after the "}", which was skipped
1169 last = cmdline;
1170 else
1171 // nothing is following the "}"
1172 last = (char_u *)"}";
1173 plen = STRLEN(last);
1174 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1175 if (pnl != NULL)
1176 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001177 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1178 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001179 }
1180
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001181 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001182 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001183 garray_T *tfgap = &evalarg->eval_tofree_ga;
1184
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001185 // Something comes after the "}".
1186 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001187
1188 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001189 if (ga_grow(tfgap, 1) == OK)
1190 {
1191 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1192 evalarg->eval_using_cmdline = TRUE;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001193 if (cmdline == line_to_free)
1194 line_to_free = NULL;
Bram Moolenaar844fb642021-10-23 13:32:30 +01001195 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001196 }
1197 else
1198 *arg = (char_u *)"";
1199
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001200 if (!evaluate)
1201 {
1202 ret = OK;
1203 goto erret;
1204 }
1205
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 name = get_lambda_name();
1207 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1208 if (ufunc == NULL)
1209 goto erret;
1210 set_ufunc_name(ufunc, name);
1211 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001212 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001213 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001214 ufunc->uf_refcount = 1;
1215 ufunc->uf_args = *newargs;
1216 newargs->ga_data = NULL;
1217 ufunc->uf_def_args = *default_args;
1218 default_args->ga_data = NULL;
1219 ufunc->uf_func_type = &t_func_any;
1220
1221 // error messages are for the first function line
1222 lnum_save = SOURCING_LNUM;
1223 SOURCING_LNUM = sourcing_lnum_top;
1224
1225 // parse argument types
1226 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1227 {
1228 SOURCING_LNUM = lnum_save;
1229 goto erret;
1230 }
1231
1232 // parse the return type, if any
1233 if (parse_return_type(ufunc, ret_type) == FAIL)
1234 goto erret;
1235
1236 pt = ALLOC_CLEAR_ONE(partial_T);
1237 if (pt == NULL)
1238 goto erret;
1239 pt->pt_func = ufunc;
1240 pt->pt_refcount = 1;
1241
1242 ufunc->uf_lines = newlines;
1243 newlines.ga_data = NULL;
1244 if (sandbox)
1245 ufunc->uf_flags |= FC_SANDBOX;
1246 if (!ASCII_ISUPPER(*ufunc->uf_name))
1247 ufunc->uf_flags |= FC_VIM9;
1248 ufunc->uf_script_ctx = current_sctx;
1249 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1250 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1251 set_function_type(ufunc);
1252
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001253 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1254
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001255 rettv->vval.v_partial = pt;
1256 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001257 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001258 ret = OK;
1259
1260erret:
1261 if (lnum_save >= 0)
1262 SOURCING_LNUM = lnum_save;
1263 vim_free(line_to_free);
1264 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001265 if (newargs != NULL)
1266 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001267 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001268 if (ufunc != NULL)
1269 {
1270 func_clear(ufunc, TRUE);
1271 func_free(ufunc, TRUE);
1272 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001273 return ret;
1274}
1275
1276/*
1277 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001278 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001279 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001280 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1281 */
1282 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001283get_lambda_tv(
1284 char_u **arg,
1285 typval_T *rettv,
1286 int types_optional,
1287 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001289 int evaluate = evalarg != NULL
1290 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 garray_T newargs;
1292 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001293 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001294 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001295 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001296 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001297 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001298 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001299 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001300 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001301 char_u *s;
1302 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001303 int *old_eval_lavars = eval_lavars_used;
1304 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001305 char_u *tofree1 = NULL;
1306 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001307 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001308 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001309 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001310
1311 if (equal_arrow && !in_vim9script())
1312 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001313
1314 ga_init(&newargs);
1315 ga_init(&newlines);
1316
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001317 // First, check if this is really a lambda expression. "->" or "=>" must
1318 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001319 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001320 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001321 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001322 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001323 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001324 {
1325 if (types_optional)
1326 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001327 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001328 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001329
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001330 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001331 if (evaluate)
1332 pnewargs = &newargs;
1333 else
1334 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001335 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001336 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001337 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001338 &varargs, &default_args,
1339 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001340 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001341 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001342 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001343 {
1344 if (types_optional)
1345 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001346 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001347 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001348 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001349 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001350
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001351 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1352 if (ret_type != NULL)
1353 {
1354 ret_type = vim_strsave(ret_type);
1355 tofree2 = ret_type;
1356 }
1357
Bram Moolenaare38eab22019-12-05 21:50:01 +01001358 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001359 if (evaluate)
1360 eval_lavars_used = &eval_lavars;
1361
Bram Moolenaar65c44152020-12-24 15:14:01 +01001362 *arg = skipwhite_and_linebreak(*arg, evalarg);
1363
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001364 // Recognize "{" as the start of a function body.
1365 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001366 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001367 if (evalarg == NULL)
1368 // cannot happen?
1369 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001370 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1371 types_optional ? &argtypes : NULL, varargs,
1372 &default_args, ret_type) == FAIL)
1373 goto errret;
1374 goto theend;
1375 }
1376 if (default_args.ga_len > 0)
1377 {
1378 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001379 goto errret;
1380 }
1381
Bram Moolenaare38eab22019-12-05 21:50:01 +01001382 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001383 start = *arg;
1384 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001385 if (ret == FAIL)
1386 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001387 if (evalarg != NULL)
1388 {
1389 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001390 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001391 evalarg->eval_tofree = NULL;
1392 }
1393
Bram Moolenaar65c44152020-12-24 15:14:01 +01001394 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001395 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001396 *arg = skipwhite_and_linebreak(*arg, evalarg);
1397 if (**arg != '}')
1398 {
1399 semsg(_("E451: Expected }: %s"), *arg);
1400 goto errret;
1401 }
1402 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404
1405 if (evaluate)
1406 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001407 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001408 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001409 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001410 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001411 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001412
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001413 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001414 if (fp == NULL)
1415 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001416 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001417 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001418 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001419 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001421 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1422 if (ga_grow(&newlines, 1) == FAIL)
1423 goto errret;
1424
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001425 // If there are line breaks, we need to split up the string.
1426 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001427 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001428 line_end = end;
1429
1430 // Add "return " before the expression (or the first line).
1431 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001432 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433 if (p == NULL)
1434 goto errret;
1435 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1436 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001437 vim_strncpy(p + 7, start, line_end - start);
1438
1439 if (line_end != end)
1440 {
1441 // Add more lines, split by line breaks. Thus is used when a
1442 // lambda with { cmds } is encountered.
1443 while (*line_end == '\n')
1444 {
1445 if (ga_grow(&newlines, 1) == FAIL)
1446 goto errret;
1447 start = line_end + 1;
1448 line_end = vim_strchr(start, '\n');
1449 if (line_end == NULL)
1450 line_end = end;
1451 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1452 vim_strnsave(start, line_end - start);
1453 }
1454 }
1455
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001456 if (strstr((char *)p + 7, "a:") == NULL)
1457 // No a: variables are used for sure.
1458 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001459
1460 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001461 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001463 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001464 if (types_optional)
1465 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001466 if (parse_argument_types(fp, &argtypes,
1467 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001468 goto errret;
1469 if (ret_type != NULL)
1470 {
1471 fp->uf_ret_type = parse_type(&ret_type,
1472 &fp->uf_type_list, TRUE);
1473 if (fp->uf_ret_type == NULL)
1474 goto errret;
1475 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001476 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001477 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001478 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001479
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001481 if (current_funccal != NULL && eval_lavars)
1482 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001483 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001484 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001485 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001486 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487
1488#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001489 if (prof_def_func())
1490 func_do_profile(fp);
1491#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001492 if (sandbox)
1493 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001494 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001495 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1496 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001497 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001499 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001500 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001501
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001502 function_using_block_scopes(fp, evalarg->eval_cstack);
1503
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001504 pt->pt_func = fp;
1505 pt->pt_refcount = 1;
1506 rettv->vval.v_partial = pt;
1507 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001508
1509 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001510 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001512theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001513 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001514 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001515 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001516 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001517 vim_free(tofree1);
1518 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001519 if (types_optional)
1520 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001521
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 return OK;
1523
1524errret:
1525 ga_clear_strings(&newargs);
1526 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001527 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001528 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001529 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001530 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001531 if (fp != NULL)
1532 vim_free(fp->uf_arg_types);
1533 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001535 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001536 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001537 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001538 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001539 vim_free(tofree1);
1540 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001541 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001542 return FAIL;
1543}
1544
1545/*
1546 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1547 * name it contains, otherwise return "name".
1548 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1549 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001550 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1551 * type of the variable.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001552 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 */
1554 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001555deref_func_name(
1556 char_u *name,
1557 int *lenp,
1558 partial_T **partialp,
1559 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001560 int no_autoload,
1561 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562{
1563 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001564 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001566 char_u *s = NULL;
1567 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001568 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569
1570 if (partialp != NULL)
1571 *partialp = NULL;
1572
1573 cc = name[*lenp];
1574 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001575
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001576 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001578 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001579 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001580 tv = &v->di_tv;
1581 }
1582 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1583 {
1584 imported_T *import;
1585 char_u *p = name;
1586 int len = *lenp;
1587
1588 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001590 p = name + 2;
1591 len -= 2;
1592 }
1593 import = find_imported(p, len, NULL);
1594
1595 // imported variable from another script
1596 if (import != NULL)
1597 {
1598 if (import->imp_funcname != NULL)
1599 {
1600 s = import->imp_funcname;
1601 *lenp = (int)STRLEN(s);
1602 return s;
1603 }
Bram Moolenaarf8a79fc2021-12-14 12:06:16 +00001604 if (import->imp_flags & IMP_FLAGS_STAR)
1605 {
1606 name[len] = NUL;
1607 semsg(_(e_cannot_use_str_itself_it_is_imported_with_star),
1608 name);
1609 name[len] = cc;
1610 *lenp = 0;
1611 return (char_u *)""; // just in case
1612 }
1613 else
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614 {
1615 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1616 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1617 + import->imp_var_vals_idx;
1618 tv = sv->sv_tv;
1619 if (type != NULL)
1620 *type = sv->sv_type;
1621 did_type = TRUE;
1622 }
1623 }
1624 }
1625
1626 if (tv != NULL)
1627 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001628 if (found_var != NULL)
1629 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001630 if (tv->v_type == VAR_FUNC)
1631 {
1632 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001633 {
1634 *lenp = 0;
1635 return (char_u *)""; // just in case
1636 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001637 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001638 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001641 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001643 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001644
1645 if (pt == NULL)
1646 {
1647 *lenp = 0;
1648 return (char_u *)""; // just in case
1649 }
1650 if (partialp != NULL)
1651 *partialp = pt;
1652 s = partial_name(pt);
1653 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001655
1656 if (s != NULL)
1657 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001658 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001659 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001660 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001661
1662 if (sv != NULL)
1663 *type = sv->sv_type;
1664 }
1665 return s;
1666 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001667 }
1668
1669 return name;
1670}
1671
1672/*
1673 * Give an error message with a function name. Handle <SNR> things.
1674 * "ermsg" is to be passed without translation, use N_() instead of _().
1675 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001676 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001677emsg_funcname(char *ermsg, char_u *name)
1678{
1679 char_u *p;
1680
1681 if (*name == K_SPECIAL)
1682 p = concat_str((char_u *)"<SNR>", name + 3);
1683 else
1684 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001685 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001686 if (p != name)
1687 vim_free(p);
1688}
1689
1690/*
1691 * Allocate a variable for the result of a function.
1692 * Return OK or FAIL.
1693 */
1694 int
1695get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001696 char_u *name, // name of the function
1697 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001698 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001699 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001700 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001701 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001702{
1703 char_u *argp;
1704 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001705 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1706 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001707 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708
1709 /*
1710 * Get the arguments.
1711 */
1712 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001713 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1714 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001716 // skip the '(' or ',' and possibly line breaks
1717 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1718
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 if (*argp == ')' || *argp == ',' || *argp == NUL)
1720 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001721 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 {
1723 ret = FAIL;
1724 break;
1725 }
1726 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001727 // The comma should come right after the argument, but this wasn't
1728 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001729 if (vim9script)
1730 {
1731 if (*argp != ',' && *skipwhite(argp) == ',')
1732 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001733 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001734 ret = FAIL;
1735 break;
1736 }
1737 }
1738 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001739 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 if (*argp != ',')
1741 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001742 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1743 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001744 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001745 ret = FAIL;
1746 break;
1747 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001748 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001749 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 if (*argp == ')')
1751 ++argp;
1752 else
1753 ret = FAIL;
1754
1755 if (ret == OK)
1756 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001757 int i = 0;
1758 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759
1760 if (get_vim_var_nr(VV_TESTING))
1761 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001762 // Prepare for calling test_garbagecollect_now(), need to know
1763 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 if (funcargs.ga_itemsize == 0)
1765 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1766 for (i = 0; i < argcount; ++i)
1767 if (ga_grow(&funcargs, 1) == OK)
1768 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1769 &argvars[i];
1770 }
1771
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001772 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001773 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001774 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001775 // An error in a builtin function does not return FAIL, but we do
1776 // want to abort further processing if an error was given.
1777 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001778 clear_tv(rettv);
1779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780
1781 funcargs.ga_len -= i;
1782 }
1783 else if (!aborting())
1784 {
1785 if (argcount == MAX_FUNC_ARGS)
1786 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1787 else
Bram Moolenaare1242042021-12-16 20:56:57 +00001788 emsg_funcname(N_(e_invalid_arguments_for_function_str), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789 }
1790
1791 while (--argcount >= 0)
1792 clear_tv(&argvars[argcount]);
1793
Bram Moolenaar8294d492020-08-10 22:40:56 +02001794 if (in_vim9script())
1795 *arg = argp;
1796 else
1797 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001798 return ret;
1799}
1800
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801/*
1802 * Return TRUE if "p" starts with "<SID>" or "s:".
1803 * Only works if eval_fname_script() returned non-zero for "p"!
1804 */
1805 static int
1806eval_fname_sid(char_u *p)
1807{
1808 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1809}
1810
1811/*
1812 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1813 * Change <SNR>123_name() to K_SNR 123_name().
1814 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1815 * (slow).
1816 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001817 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1819{
1820 int llen;
1821 char_u *fname;
1822 int i;
1823
1824 llen = eval_fname_script(name);
1825 if (llen > 0)
1826 {
1827 fname_buf[0] = K_SPECIAL;
1828 fname_buf[1] = KS_EXTRA;
1829 fname_buf[2] = (int)KE_SNR;
1830 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001831 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001832 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001833 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001834 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835 else
1836 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001837 sprintf((char *)fname_buf + 3, "%ld_",
1838 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001839 i = (int)STRLEN(fname_buf);
1840 }
1841 }
1842 if (i + STRLEN(name + llen) < FLEN_FIXED)
1843 {
1844 STRCPY(fname_buf + i, name + llen);
1845 fname = fname_buf;
1846 }
1847 else
1848 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001849 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001851 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001852 else
1853 {
1854 *tofree = fname;
1855 mch_memmove(fname, fname_buf, (size_t)i);
1856 STRCPY(fname + i, name + llen);
1857 }
1858 }
1859 }
1860 else
1861 fname = name;
1862 return fname;
1863}
1864
1865/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001866 * Find a function "name" in script "sid".
1867 */
1868 static ufunc_T *
1869find_func_with_sid(char_u *name, int sid)
1870{
1871 hashitem_T *hi;
1872 char_u buffer[200];
1873
1874 buffer[0] = K_SPECIAL;
1875 buffer[1] = KS_EXTRA;
1876 buffer[2] = (int)KE_SNR;
1877 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1878 (long)sid, name);
1879 hi = hash_find(&func_hashtab, buffer);
1880 if (!HASHITEM_EMPTY(hi))
1881 return HI2UF(hi);
1882
1883 return NULL;
1884}
1885
1886/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001888 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001889 * Return NULL for unknown function.
1890 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001891 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001892find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893{
1894 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001895 ufunc_T *func;
1896 imported_T *imported;
1897
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001898 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001899 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001900 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001901 long sid = 0;
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001902 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1903 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001904
Bram Moolenaar95006e32020-08-29 17:47:08 +02001905 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001906 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001907 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001908 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1909 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001910 if (func != NULL)
1911 return func;
1912 }
1913
Bram Moolenaarefa94442020-08-08 22:16:00 +02001914 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001915 && name[1] == KS_EXTRA
1916 && name[2] == KE_SNR)
1917 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001918 // Caller changes s: to <SNR>99_name.
1919
1920 after_script = name + 3;
1921 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001922 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001923 ++after_script;
1924 else
1925 after_script = NULL;
1926 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001927 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001928 {
1929 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001930 if (after_script != NULL && sid != current_sctx.sc_sid)
1931 imported = find_imported_in_script(after_script, 0, sid);
1932 else
1933 imported = find_imported(after_script == NULL
1934 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001935 if (imported != NULL && imported->imp_funcname != NULL)
1936 {
1937 hi = hash_find(&func_hashtab, imported->imp_funcname);
1938 if (!HASHITEM_EMPTY(hi))
1939 return HI2UF(hi);
1940 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001941 }
1942 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943
Bram Moolenaara26b9702020-04-18 19:53:28 +02001944 hi = hash_find(&func_hashtab,
1945 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001946 if (!HASHITEM_EMPTY(hi))
1947 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948
1949 return NULL;
1950}
1951
1952/*
1953 * Find a function by name, return pointer to it in ufuncs.
1954 * "cctx" is passed in a :def function to find imported functions.
1955 * Return NULL for unknown or dead function.
1956 */
1957 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001958find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001959{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001960 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961
1962 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1963 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001964 return NULL;
1965}
1966
1967/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001968 * Return TRUE if "ufunc" is a global function.
1969 */
1970 int
1971func_is_global(ufunc_T *ufunc)
1972{
1973 return ufunc->uf_name[0] != K_SPECIAL;
1974}
1975
1976/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001977 * Copy the function name of "fp" to buffer "buf".
1978 * "buf" must be able to hold the function name plus three bytes.
1979 * Takes care of script-local function names.
1980 */
1981 static void
1982cat_func_name(char_u *buf, ufunc_T *fp)
1983{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001984 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001985 {
1986 STRCPY(buf, "<SNR>");
1987 STRCAT(buf, fp->uf_name + 3);
1988 }
1989 else
1990 STRCPY(buf, fp->uf_name);
1991}
1992
1993/*
1994 * Add a number variable "name" to dict "dp" with value "nr".
1995 */
1996 static void
1997add_nr_var(
1998 dict_T *dp,
1999 dictitem_T *v,
2000 char *name,
2001 varnumber_T nr)
2002{
2003 STRCPY(v->di_key, name);
2004 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2005 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2006 v->di_tv.v_type = VAR_NUMBER;
2007 v->di_tv.v_lock = VAR_FIXED;
2008 v->di_tv.vval.v_number = nr;
2009}
2010
2011/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002012 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002013 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002014 static void
2015free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002017 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002018
2019 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2020 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002021 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002022
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002023 // When garbage collecting a funccall_T may be freed before the
2024 // function that references it, clear its uf_scoped field.
2025 // The function may have been redefined and point to another
2026 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002027 if (fp != NULL && fp->uf_scoped == fc)
2028 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002029 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002030 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002031
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002032 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 vim_free(fc);
2034}
2035
2036/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002037 * Free "fc" and what it contains.
2038 * Can be called only when "fc" is kept beyond the period of it called,
2039 * i.e. after cleanup_function_call(fc).
2040 */
2041 static void
2042free_funccal_contents(funccall_T *fc)
2043{
2044 listitem_T *li;
2045
2046 // Free all l: variables.
2047 vars_clear(&fc->l_vars.dv_hashtab);
2048
2049 // Free all a: variables.
2050 vars_clear(&fc->l_avars.dv_hashtab);
2051
2052 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002053 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002054 clear_tv(&li->li_tv);
2055
2056 free_funccal(fc);
2057}
2058
2059/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002060 * Handle the last part of returning from a function: free the local hashtable.
2061 * Unless it is still in use by a closure.
2062 */
2063 static void
2064cleanup_function_call(funccall_T *fc)
2065{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002066 int may_free_fc = fc->fc_refcount <= 0;
2067 int free_fc = TRUE;
2068
Bram Moolenaar6914c642017-04-01 21:21:30 +02002069 current_funccal = fc->caller;
2070
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002071 // Free all l: variables if not referred.
2072 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2073 vars_clear(&fc->l_vars.dv_hashtab);
2074 else
2075 free_fc = FALSE;
2076
2077 // If the a:000 list and the l: and a: dicts are not referenced and
2078 // there is no closure using it, we can free the funccall_T and what's
2079 // in it.
2080 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2081 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002082 else
2083 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002084 int todo;
2085 hashitem_T *hi;
2086 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002087
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002088 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002089
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002090 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002091 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2092 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2093 {
2094 if (!HASHITEM_EMPTY(hi))
2095 {
2096 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002097 di = HI2DI(hi);
2098 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002099 }
2100 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002101 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002102
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002103 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2104 fc->l_varlist.lv_first = NULL;
2105 else
2106 {
2107 listitem_T *li;
2108
2109 free_fc = FALSE;
2110
2111 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002112 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002113 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002114 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002115
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002116 if (free_fc)
2117 free_funccal(fc);
2118 else
2119 {
2120 static int made_copy = 0;
2121
2122 // "fc" is still in use. This can happen when returning "a:000",
2123 // assigning "l:" to a global variable or defining a closure.
2124 // Link "fc" in the list for garbage collection later.
2125 fc->caller = previous_funccal;
2126 previous_funccal = fc;
2127
2128 if (want_garbage_collect)
2129 // If garbage collector is ready, clear count.
2130 made_copy = 0;
2131 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002132 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 // We have made a lot of copies, worth 4 Mbyte. This can happen
2134 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002135 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002136 // too much memory.
2137 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002138 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002139 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002140 }
2141}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002142
2143/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002144 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2145 */
2146 static int
2147numbered_function(char_u *name)
2148{
2149 return isdigit(*name)
2150 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2151}
2152
2153/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002154 * There are two kinds of function names:
2155 * 1. ordinary names, function defined with :function or :def
2156 * 2. numbered functions and lambdas
2157 * For the first we only count the name stored in func_hashtab as a reference,
2158 * using function() does not count as a reference, because the function is
2159 * looked up by name.
2160 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002161 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002162func_name_refcount(char_u *name)
2163{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002164 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002165}
2166
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002167/*
2168 * Unreference "fc": decrement the reference count and free it when it
2169 * becomes zero. "fp" is detached from "fc".
2170 * When "force" is TRUE we are exiting.
2171 */
2172 static void
2173funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2174{
2175 funccall_T **pfc;
2176 int i;
2177
2178 if (fc == NULL)
2179 return;
2180
2181 if (--fc->fc_refcount <= 0 && (force || (
2182 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2183 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2184 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2185 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2186 {
2187 if (fc == *pfc)
2188 {
2189 *pfc = fc->caller;
2190 free_funccal_contents(fc);
2191 return;
2192 }
2193 }
2194 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2195 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2196 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2197}
2198
2199/*
2200 * Remove the function from the function hashtable. If the function was
2201 * deleted while it still has references this was already done.
2202 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2203 */
2204 static int
2205func_remove(ufunc_T *fp)
2206{
2207 hashitem_T *hi;
2208
2209 // Return if it was already virtually deleted.
2210 if (fp->uf_flags & FC_DEAD)
2211 return FALSE;
2212
2213 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2214 if (!HASHITEM_EMPTY(hi))
2215 {
2216 // When there is a def-function index do not actually remove the
2217 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002218 // Do remove it when it's a copy.
2219 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002220 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002221 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002222 return FALSE;
2223 }
2224 hash_remove(&func_hashtab, hi);
2225 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002226 return TRUE;
2227 }
2228 return FALSE;
2229}
2230
2231 static void
2232func_clear_items(ufunc_T *fp)
2233{
2234 ga_clear_strings(&(fp->uf_args));
2235 ga_clear_strings(&(fp->uf_def_args));
2236 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002237 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002238 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002239 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002240 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002241
2242 // Increment the refcount of this function to avoid it being freed
2243 // recursively when the partial is freed.
2244 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002245 partial_unref(fp->uf_partial);
2246 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002247 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002248
2249#ifdef FEAT_LUA
2250 if (fp->uf_cb_free != NULL)
2251 {
2252 fp->uf_cb_free(fp->uf_cb_state);
2253 fp->uf_cb_free = NULL;
2254 }
2255
2256 fp->uf_cb_state = NULL;
2257 fp->uf_cb = NULL;
2258#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002259#ifdef FEAT_PROFILE
2260 VIM_CLEAR(fp->uf_tml_count);
2261 VIM_CLEAR(fp->uf_tml_total);
2262 VIM_CLEAR(fp->uf_tml_self);
2263#endif
2264}
2265
2266/*
2267 * Free all things that a function contains. Does not free the function
2268 * itself, use func_free() for that.
2269 * When "force" is TRUE we are exiting.
2270 */
2271 static void
2272func_clear(ufunc_T *fp, int force)
2273{
2274 if (fp->uf_cleared)
2275 return;
2276 fp->uf_cleared = TRUE;
2277
2278 // clear this function
2279 func_clear_items(fp);
2280 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002281 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002282}
2283
2284/*
2285 * Free a function and remove it from the list of functions. Does not free
2286 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002287 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002288 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002289 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002290 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002291func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002292{
2293 // Only remove it when not done already, otherwise we would remove a newer
2294 // version of the function with the same name.
2295 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2296 func_remove(fp);
2297
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002298 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002299 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002300 if (fp->uf_dfunc_idx > 0)
2301 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002302 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002303 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002304 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002305 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002306 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002307}
2308
2309/*
2310 * Free all things that a function contains and free the function itself.
2311 * When "force" is TRUE we are exiting.
2312 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002313 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002314func_clear_free(ufunc_T *fp, int force)
2315{
2316 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002317 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2318 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002319 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002320 else
2321 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002322}
2323
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002324/*
2325 * Copy already defined function "lambda" to a new function with name "global".
2326 * This is for when a compiled function defines a global function.
2327 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002328 int
2329copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002330{
2331 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002332 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002333
2334 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002335 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002336 semsg(_(e_lambda_function_not_found_str), lambda);
2337 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002338 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002339
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002340 fp = find_func(global, TRUE, NULL);
2341 if (fp != NULL)
2342 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002343 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002344 semsg(_(e_funcexts), global);
2345 return FAIL;
2346 }
2347
2348 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2349 if (fp == NULL)
2350 return FAIL;
2351
2352 fp->uf_varargs = ufunc->uf_varargs;
2353 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2354 fp->uf_def_status = ufunc->uf_def_status;
2355 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2356 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2357 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2358 == FAIL
2359 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2360 goto failed;
2361
2362 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2363 : vim_strsave(ufunc->uf_name_exp);
2364 if (ufunc->uf_arg_types != NULL)
2365 {
2366 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2367 if (fp->uf_arg_types == NULL)
2368 goto failed;
2369 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2370 sizeof(type_T *) * fp->uf_args.ga_len);
2371 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002372 if (ufunc->uf_va_name != NULL)
2373 {
2374 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2375 if (fp->uf_va_name == NULL)
2376 goto failed;
2377 }
2378 fp->uf_ret_type = ufunc->uf_ret_type;
2379
2380 fp->uf_refcount = 1;
2381 STRCPY(fp->uf_name, global);
2382 hash_add(&func_hashtab, UF2HIKEY(fp));
2383
2384 // the referenced dfunc_T is now used one more time
2385 link_def_function(fp);
2386
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002387 // Create a partial to store the context of the function where it was
2388 // instantiated. Only needs to be done once. Do this on the original
2389 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002390 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2391 {
2392 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2393
2394 if (pt == NULL)
2395 goto failed;
2396 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002397 {
2398 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002399 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002400 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002401 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002402 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002403 }
2404
2405 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002406
2407failed:
2408 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002409 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002410}
2411
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002412static int funcdepth = 0;
2413
2414/*
2415 * Increment the function call depth count.
2416 * Return FAIL when going over 'maxfuncdepth'.
2417 * Otherwise return OK, must call funcdepth_decrement() later!
2418 */
2419 int
2420funcdepth_increment(void)
2421{
2422 if (funcdepth >= p_mfd)
2423 {
2424 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2425 return FAIL;
2426 }
2427 ++funcdepth;
2428 return OK;
2429}
2430
2431 void
2432funcdepth_decrement(void)
2433{
2434 --funcdepth;
2435}
2436
2437/*
2438 * Get the current function call depth.
2439 */
2440 int
2441funcdepth_get(void)
2442{
2443 return funcdepth;
2444}
2445
2446/*
2447 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002448 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002449 * times as funcdepth_increment().
2450 */
2451 void
2452funcdepth_restore(int depth)
2453{
2454 funcdepth = depth;
2455}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002456
2457/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458 * Call a user function.
2459 */
2460 static void
2461call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002462 ufunc_T *fp, // pointer to function
2463 int argcount, // nr of args
2464 typval_T *argvars, // arguments
2465 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002466 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002467 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002469 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002470 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 funccall_T *fc;
2472 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002473 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002475 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 int i;
2477 int ai;
2478 int islambda = FALSE;
2479 char_u numbuf[NUMBUFLEN];
2480 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002481 typval_T *tv_to_free[MAX_FUNC_ARGS];
2482 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002484 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002486 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487
Bram Moolenaarb2049902021-01-24 12:53:53 +01002488#ifdef FEAT_PROFILE
2489 CLEAR_FIELD(profile_info);
2490#endif
2491
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002492 // If depth of calling is getting too high, don't execute the function.
2493 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 rettv->v_type = VAR_NUMBER;
2496 rettv->vval.v_number = -1;
2497 return;
2498 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499
Bram Moolenaare38eab22019-12-05 21:50:01 +01002500 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002502 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002503 if (fc == NULL)
2504 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 fc->caller = current_funccal;
2506 current_funccal = fc;
2507 fc->func = fp;
2508 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002510 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2512 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002513 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002514 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002515 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002517 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002518 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002519#ifdef FEAT_PROFILE
2520 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2521#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002522 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002523#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002524 if (do_profiling == PROF_YES)
2525 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002526#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002527 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002528 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002529#ifdef FEAT_PROFILE
2530 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002531 || (caller != NULL && caller->uf_profiling)))
2532 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002533#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002534 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002535 free_funccal(fc);
2536 return;
2537 }
2538
Bram Moolenaar38453522021-11-28 22:00:12 +00002539 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540
2541 /*
2542 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2543 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2544 * each argument variable and saves a lot of time.
2545 */
2546 /*
2547 * Init l: variables.
2548 */
2549 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2550 if (selfdict != NULL)
2551 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002552 // Set l:self to "selfdict". Use "name" to avoid a warning from
2553 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002554 v = &fc->fixvar[fixvar_idx++].var;
2555 name = v->di_key;
2556 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002557 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2559 v->di_tv.v_type = VAR_DICT;
2560 v->di_tv.v_lock = 0;
2561 v->di_tv.vval.v_dict = selfdict;
2562 ++selfdict->dv_refcount;
2563 }
2564
2565 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002566 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002567 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002568 * Set a:000 to a list with room for the "..." arguments.
2569 */
2570 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002571 if ((fp->uf_flags & FC_NOARGS) == 0)
2572 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002573 (varnumber_T)(argcount >= fp->uf_args.ga_len
2574 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002575 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002576 if ((fp->uf_flags & FC_NOARGS) == 0)
2577 {
2578 // Use "name" to avoid a warning from some compiler that checks the
2579 // destination size.
2580 v = &fc->fixvar[fixvar_idx++].var;
2581 name = v->di_key;
2582 STRCPY(name, "000");
2583 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2584 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2585 v->di_tv.v_type = VAR_LIST;
2586 v->di_tv.v_lock = VAR_FIXED;
2587 v->di_tv.vval.v_list = &fc->l_varlist;
2588 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002589 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2591 fc->l_varlist.lv_lock = VAR_FIXED;
2592
2593 /*
2594 * Set a:firstline to "firstline" and a:lastline to "lastline".
2595 * Set a:name to named arguments.
2596 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002597 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002598 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002599 if ((fp->uf_flags & FC_NOARGS) == 0)
2600 {
2601 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002602 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002603 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002604 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002605 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002606 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607 {
2608 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002609 typval_T def_rettv;
2610 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002611
2612 ai = i - fp->uf_args.ga_len;
2613 if (ai < 0)
2614 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002615 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616 name = FUNCARG(fp, i);
2617 if (islambda)
2618 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002619
2620 // evaluate named argument default expression
2621 isdefault = ai + fp->uf_def_args.ga_len >= 0
2622 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2623 && argvars[i].vval.v_number == VVAL_NONE));
2624 if (isdefault)
2625 {
2626 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002627
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002628 def_rettv.v_type = VAR_NUMBER;
2629 def_rettv.vval.v_number = -1;
2630
2631 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2632 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002633 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002634 {
2635 default_arg_err = 1;
2636 break;
2637 }
2638 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 }
2640 else
2641 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002642 if ((fp->uf_flags & FC_NOARGS) != 0)
2643 // Bail out if no a: arguments used (in lambda).
2644 break;
2645
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 sprintf((char *)numbuf, "%d", ai + 1);
2648 name = numbuf;
2649 }
2650 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2651 {
2652 v = &fc->fixvar[fixvar_idx++].var;
2653 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002654 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 }
2656 else
2657 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002658 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 if (v == NULL)
2660 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002661 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002664 // Note: the values are copied directly to avoid alloc/free.
2665 // "argvars" must have VAR_FIXED for v_lock.
2666 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 v->di_tv.v_lock = VAR_FIXED;
2668
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002669 if (isdefault)
2670 // Need to free this later, no matter where it's stored.
2671 tv_to_free[tv_to_free_len++] = &v->di_tv;
2672
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 if (addlocal)
2674 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002675 // Named arguments should be accessed without the "a:" prefix in
2676 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002677 copy_tv(&v->di_tv, &v->di_tv);
2678 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002680 else
2681 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682
2683 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2684 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002685 listitem_T *li = &fc->l_listitems[ai];
2686
2687 li->li_tv = argvars[i];
2688 li->li_tv.v_lock = VAR_FIXED;
2689 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 }
2691 }
2692
Bram Moolenaare38eab22019-12-05 21:50:01 +01002693 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002695
2696 if (fp->uf_flags & FC_SANDBOX)
2697 {
2698 using_sandbox = TRUE;
2699 ++sandbox;
2700 }
2701
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002702 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002703 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002704 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002706 ++no_wait_return;
2707 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002709 smsg(_("calling %s"), SOURCING_NAME);
2710 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002712 char_u buf[MSG_BUF_LEN];
2713 char_u numbuf2[NUMBUFLEN];
2714 char_u *tofree;
2715 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002717 msg_puts("(");
2718 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002720 if (i > 0)
2721 msg_puts(", ");
2722 if (argvars[i].v_type == VAR_NUMBER)
2723 msg_outnum((long)argvars[i].vval.v_number);
2724 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002726 // Do not want errors such as E724 here.
2727 ++emsg_off;
2728 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2729 --emsg_off;
2730 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002732 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002734 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2735 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002737 msg_puts((char *)s);
2738 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 }
2740 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002741 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002742 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002744 msg_puts("\n"); // don't overwrite this either
2745
2746 verbose_leave_scroll();
2747 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 }
2749#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002750 if (do_profiling == PROF_YES)
2751 profile_may_start_func(&profile_info, fp,
2752 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753#endif
2754
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002755 save_current_sctx = current_sctx;
2756 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 save_did_emsg = did_emsg;
2758 did_emsg = FALSE;
2759
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002760 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2761 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002762 else if (islambda)
2763 {
2764 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2765
2766 // A Lambda always has the command "return {expr}". It is much faster
2767 // to evaluate {expr} directly.
2768 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002769 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002770 --ex_nesting_level;
2771 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002772 else
2773 // call do_cmdline() to execute the lines
2774 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2776
2777 --RedrawingDisabled;
2778
Bram Moolenaare38eab22019-12-05 21:50:01 +01002779 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2781 {
2782 clear_tv(rettv);
2783 rettv->v_type = VAR_NUMBER;
2784 rettv->vval.v_number = -1;
2785 }
2786
2787#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002788 if (do_profiling == PROF_YES)
2789 {
2790 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2791
2792 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2793 profile_may_end_func(&profile_info, fp, caller);
2794 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795#endif
2796
Bram Moolenaare38eab22019-12-05 21:50:01 +01002797 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 if (p_verbose >= 12)
2799 {
2800 ++no_wait_return;
2801 verbose_enter_scroll();
2802
2803 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002804 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002806 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 (long)fc->rettv->vval.v_number);
2808 else
2809 {
2810 char_u buf[MSG_BUF_LEN];
2811 char_u numbuf2[NUMBUFLEN];
2812 char_u *tofree;
2813 char_u *s;
2814
Bram Moolenaare38eab22019-12-05 21:50:01 +01002815 // The value may be very long. Skip the middle part, so that we
2816 // have some idea how it starts and ends. smsg() would always
2817 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 ++emsg_off;
2819 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2820 --emsg_off;
2821 if (s != NULL)
2822 {
2823 if (vim_strsize(s) > MSG_BUF_CLEN)
2824 {
2825 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2826 s = buf;
2827 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002828 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 vim_free(tofree);
2830 }
2831 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002832 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833
2834 verbose_leave_scroll();
2835 --no_wait_return;
2836 }
2837
Bram Moolenaare31ee862020-01-07 20:59:34 +01002838 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002839 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002840 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841#ifdef FEAT_PROFILE
2842 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002843 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002845 if (using_sandbox)
2846 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002848 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 {
2850 ++no_wait_return;
2851 verbose_enter_scroll();
2852
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002853 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002854 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855
2856 verbose_leave_scroll();
2857 --no_wait_return;
2858 }
2859
2860 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002861 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002862 for (i = 0; i < tv_to_free_len; ++i)
2863 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002864 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865}
2866
2867/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002868 * Check the argument count for user function "fp".
2869 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2870 */
2871 int
2872check_user_func_argcount(ufunc_T *fp, int argcount)
2873{
2874 int regular_args = fp->uf_args.ga_len;
2875
2876 if (argcount < regular_args - fp->uf_def_args.ga_len)
2877 return FCERR_TOOFEW;
2878 else if (!has_varargs(fp) && argcount > regular_args)
2879 return FCERR_TOOMANY;
2880 return FCERR_UNKNOWN;
2881}
2882
2883/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002884 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002885 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002886 int
2887call_user_func_check(
2888 ufunc_T *fp,
2889 int argcount,
2890 typval_T *argvars,
2891 typval_T *rettv,
2892 funcexe_T *funcexe,
2893 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002894{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002895 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002896
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002897 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2898 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002899 error = check_user_func_argcount(fp, argcount);
2900 if (error != FCERR_UNKNOWN)
2901 return error;
2902 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002903 error = FCERR_DICT;
2904 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002905 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002906 int did_save_redo = FALSE;
2907 save_redo_T save_redo;
2908
2909 /*
2910 * Call the user function.
2911 * Save and restore search patterns, script variables and
2912 * redo buffer.
2913 */
2914 save_search_patterns();
2915 if (!ins_compl_active())
2916 {
2917 saveRedobuff(&save_redo);
2918 did_save_redo = TRUE;
2919 }
2920 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002921 call_user_func(fp, argcount, argvars, rettv, funcexe,
2922 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002923 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2924 // Function was unreferenced while being used, free it now.
2925 func_clear_free(fp, FALSE);
2926 if (did_save_redo)
2927 restoreRedobuff(&save_redo);
2928 restore_search_patterns();
2929 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002930 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002931 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002932}
2933
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002934static funccal_entry_T *funccal_stack = NULL;
2935
2936/*
2937 * Save the current function call pointer, and set it to NULL.
2938 * Used when executing autocommands and for ":source".
2939 */
2940 void
2941save_funccal(funccal_entry_T *entry)
2942{
2943 entry->top_funccal = current_funccal;
2944 entry->next = funccal_stack;
2945 funccal_stack = entry;
2946 current_funccal = NULL;
2947}
2948
2949 void
2950restore_funccal(void)
2951{
2952 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002953 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002954 else
2955 {
2956 current_funccal = funccal_stack->top_funccal;
2957 funccal_stack = funccal_stack->next;
2958 }
2959}
2960
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002961 funccall_T *
2962get_current_funccal(void)
2963{
2964 return current_funccal;
2965}
2966
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002967/*
2968 * Mark all functions of script "sid" as deleted.
2969 */
2970 void
2971delete_script_functions(int sid)
2972{
2973 hashitem_T *hi;
2974 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002975 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002976 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002977 size_t len;
2978
2979 buf[0] = K_SPECIAL;
2980 buf[1] = KS_EXTRA;
2981 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002982 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002983 len = STRLEN(buf);
2984
Bram Moolenaarce658352020-07-31 23:47:12 +02002985 while (todo > 0)
2986 {
2987 todo = func_hashtab.ht_used;
2988 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2989 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002990 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002991 fp = HI2UF(hi);
2992 if (STRNCMP(fp->uf_name, buf, len) == 0)
2993 {
2994 int changed = func_hashtab.ht_changed;
2995
2996 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002997
2998 if (fp->uf_calls > 0)
2999 {
3000 // Function is executing, don't free it but do remove
3001 // it from the hashtable.
3002 if (func_remove(fp))
3003 fp->uf_refcount--;
3004 }
3005 else
3006 {
3007 func_clear(fp, TRUE);
3008 // When clearing a function another function can be
3009 // cleared as a side effect. When that happens start
3010 // over.
3011 if (changed != func_hashtab.ht_changed)
3012 break;
3013 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003014 }
3015 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003016 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003017 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003018}
3019
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020#if defined(EXITFREE) || defined(PROTO)
3021 void
3022free_all_functions(void)
3023{
3024 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003025 ufunc_T *fp;
3026 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003027 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003028 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029
Bram Moolenaare38eab22019-12-05 21:50:01 +01003030 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003031 while (current_funccal != NULL)
3032 {
3033 clear_tv(current_funccal->rettv);
3034 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003035 if (current_funccal == NULL && funccal_stack != NULL)
3036 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003037 }
3038
Bram Moolenaare38eab22019-12-05 21:50:01 +01003039 // First clear what the functions contain. Since this may lower the
3040 // reference count of a function, it may also free a function and change
3041 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003042 while (todo > 0)
3043 {
3044 todo = func_hashtab.ht_used;
3045 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3046 if (!HASHITEM_EMPTY(hi))
3047 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003048 // clear the def function index now
3049 fp = HI2UF(hi);
3050 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003051 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003052
Bram Moolenaare38eab22019-12-05 21:50:01 +01003053 // Only free functions that are not refcounted, those are
3054 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003055 if (func_name_refcount(fp->uf_name))
3056 ++skipped;
3057 else
3058 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003059 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003060 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003061 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003062 {
3063 skipped = 0;
3064 break;
3065 }
3066 }
3067 --todo;
3068 }
3069 }
3070
Bram Moolenaare38eab22019-12-05 21:50:01 +01003071 // Now actually free the functions. Need to start all over every time,
3072 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003073 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003074 while (func_hashtab.ht_used > skipped)
3075 {
3076 todo = func_hashtab.ht_used;
3077 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003078 if (!HASHITEM_EMPTY(hi))
3079 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003080 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003081 // Only free functions that are not refcounted, those are
3082 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003083 fp = HI2UF(hi);
3084 if (func_name_refcount(fp->uf_name))
3085 ++skipped;
3086 else
3087 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003088 if (func_free(fp, FALSE) == OK)
3089 {
3090 skipped = 0;
3091 break;
3092 }
3093 // did not actually free it
3094 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003095 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003097 }
3098 if (skipped == 0)
3099 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003100
3101 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003102}
3103#endif
3104
3105/*
3106 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003107 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 * "len" is the length of "name", or -1 for NUL terminated.
3109 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003110 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111builtin_function(char_u *name, int len)
3112{
3113 char_u *p;
3114
Bram Moolenaara26b9702020-04-18 19:53:28 +02003115 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 return FALSE;
3117 p = vim_strchr(name, AUTOLOAD_CHAR);
3118 return p == NULL || (len > 0 && p > name + len);
3119}
3120
3121 int
3122func_call(
3123 char_u *name,
3124 typval_T *args,
3125 partial_T *partial,
3126 dict_T *selfdict,
3127 typval_T *rettv)
3128{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003129 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 listitem_T *item;
3131 typval_T argv[MAX_FUNC_ARGS + 1];
3132 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133 int r = 0;
3134
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003135 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003136 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003137 {
3138 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3139 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003140 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141 break;
3142 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003143 // Make a copy of each argument. This is needed to be able to set
3144 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 copy_tv(&item->li_tv, &argv[argc++]);
3146 }
3147
3148 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003149 {
3150 funcexe_T funcexe;
3151
Bram Moolenaara80faa82020-04-12 19:37:17 +02003152 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003153 funcexe.fe_firstline = curwin->w_cursor.lnum;
3154 funcexe.fe_lastline = curwin->w_cursor.lnum;
3155 funcexe.fe_evaluate = TRUE;
3156 funcexe.fe_partial = partial;
3157 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003158 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3159 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160
Bram Moolenaare38eab22019-12-05 21:50:01 +01003161 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162 while (argc > 0)
3163 clear_tv(&argv[--argc]);
3164
3165 return r;
3166}
3167
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003168static int callback_depth = 0;
3169
3170 int
3171get_callback_depth(void)
3172{
3173 return callback_depth;
3174}
3175
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003176/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003177 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003178 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003179 */
3180 int
3181call_callback(
3182 callback_T *callback,
3183 int len, // length of "name" or -1 to use strlen()
3184 typval_T *rettv, // return value goes here
3185 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003186 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003187 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003188{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003189 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003190 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003191
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003192 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3193 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003194 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003195 funcexe.fe_evaluate = TRUE;
3196 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003197 ++callback_depth;
3198 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3199 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003200
3201 // When a :def function was called that uses :try an error would be turned
3202 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003203 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003204 {
3205 need_rethrow = FALSE;
3206 handle_did_throw();
3207 }
3208
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003209 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003210}
3211
3212/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003213 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003214 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003215 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3216 */
3217 varnumber_T
3218call_callback_retnr(
3219 callback_T *callback,
3220 int argcount, // number of "argvars"
3221 typval_T *argvars) // vars for arguments, must have "argcount"
3222 // PLUS ONE elements!
3223{
3224 typval_T rettv;
3225 varnumber_T retval;
3226
3227 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003228 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003229
3230 retval = tv_get_number_chk(&rettv, NULL);
3231 clear_tv(&rettv);
3232 return retval;
3233}
3234
3235/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003236 * Give an error message for the result of a function.
3237 * Nothing if "error" is FCERR_NONE.
3238 */
3239 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003240user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241{
3242 switch (error)
3243 {
3244 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003245 if (funcexe->fe_found_var)
3246 semsg(_(e_not_callable_type_str), name);
3247 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003248 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003249 break;
3250 case FCERR_NOTMETHOD:
3251 emsg_funcname(
3252 N_("E276: Cannot use function as a method: %s"), name);
3253 break;
3254 case FCERR_DELETED:
3255 emsg_funcname(N_(e_func_deleted), name);
3256 break;
3257 case FCERR_TOOMANY:
Bram Moolenaare1242042021-12-16 20:56:57 +00003258 emsg_funcname((char *)e_too_many_arguments_for_function_str,
3259 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003260 break;
3261 case FCERR_TOOFEW:
Bram Moolenaare1242042021-12-16 20:56:57 +00003262 emsg_funcname((char *)e_not_enough_arguments_for_function_str,
3263 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003264 break;
3265 case FCERR_SCRIPT:
3266 emsg_funcname(
Bram Moolenaare1242042021-12-16 20:56:57 +00003267 N_(e_using_sid_not_in_script_context_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 break;
3269 case FCERR_DICT:
3270 emsg_funcname(
3271 N_("E725: Calling dict function without Dictionary: %s"),
3272 name);
3273 break;
3274 }
3275}
3276
3277/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003279 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 * Return FAIL when the function can't be called, OK otherwise.
3281 * Also returns OK when an error was encountered while executing the function.
3282 */
3283 int
3284call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003285 char_u *funcname, // name of the function
3286 int len, // length of "name" or -1 to use strlen()
3287 typval_T *rettv, // return value goes here
3288 int argcount_in, // number of "argvars"
3289 typval_T *argvars_in, // vars for arguments, must have "argcount"
3290 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003291 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292{
3293 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003294 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003295 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003296 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 char_u fname_buf[FLEN_FIXED + 1];
3298 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003299 char_u *fname = NULL;
3300 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003301 int argcount = argcount_in;
3302 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003303 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003304 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003305 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003307 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003308 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003309 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003311 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3312 // even when call_func() returns FAIL.
3313 rettv->v_type = VAR_UNKNOWN;
3314
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003315 if (partial != NULL)
3316 fp = partial->pt_func;
3317 if (fp == NULL)
3318 {
3319 // Make a copy of the name, if it comes from a funcref variable it
3320 // could be changed or deleted in the called function.
3321 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3322 if (name == NULL)
3323 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003324
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003325 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3326 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003328 if (funcexe->fe_doesrange != NULL)
3329 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330
3331 if (partial != NULL)
3332 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003333 // When the function has a partial with a dict and there is a dict
3334 // argument, use the dict argument. That is backwards compatible.
3335 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003336 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003338 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 {
3340 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003341 {
3342 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3343 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003344 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003345 goto theend;
3346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003348 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 for (i = 0; i < argcount_in; ++i)
3350 argv[i + argv_clear] = argvars_in[i];
3351 argvars = argv;
3352 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003353
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003354 if (funcexe->fe_check_type != NULL
3355 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003356 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003357 // Now funcexe->fe_check_type is missing the added arguments,
3358 // make a copy of the type with the correction.
3359 check_type = *funcexe->fe_check_type;
3360 funcexe->fe_check_type = &check_type;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003361 check_type.tt_argcount += partial->pt_argc;
3362 check_type.tt_min_argcount += partial->pt_argc;
3363 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 }
3365 }
3366
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003367 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3368 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003369 {
3370 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003371 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003372 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003373 error = FCERR_OTHER;
3374 }
3375
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003376 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 {
3378 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003379 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380
Bram Moolenaar333894b2020-08-01 18:53:07 +02003381 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003382 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003383 {
3384 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003386 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387
Bram Moolenaare38eab22019-12-05 21:50:01 +01003388 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003390 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003392 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 {
3394 /*
3395 * User defined function.
3396 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003397 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003398 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399
Bram Moolenaare38eab22019-12-05 21:50:01 +01003400 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 if (fp == NULL
3402 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003403 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 && !aborting())
3405 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003406 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003407 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003409 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3411 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003412 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003413 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003415 if (fp == NULL)
3416 {
3417 char_u *p = untrans_function_name(rfname);
3418
3419 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003420 // Don't do this if the name starts with "s:".
3421 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003422 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003423 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003425 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003426 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003427#ifdef FEAT_LUA
3428 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3429 {
3430 cfunc_T cb = fp->uf_cb;
3431
3432 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3433 }
3434#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003435 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003437 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003438 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003439 argcount = funcexe->fe_argv_func(argcount, argvars,
3440 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003441
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003442 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003443 {
3444 // Method call: base->Method()
3445 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003446 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003447 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003448 argvars = argv;
3449 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003450 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003451
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452 error = call_user_func_check(fp, argcount, argvars, rettv,
3453 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 }
3455 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003456 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003457 {
3458 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003459 * expr->method(): Find the method name in the table, call its
3460 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003461 */
3462 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003463 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003464 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 else
3466 {
3467 /*
3468 * Find the function name in the table, call its implementation.
3469 */
3470 error = call_internal_func(fname, argcount, argvars, rettv);
3471 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003472
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473 /*
3474 * The function call (or "FuncUndefined" autocommand sequence) might
3475 * have been aborted by an error, an interrupt, or an explicitly thrown
3476 * exception that has not been caught so far. This situation can be
3477 * tested for by calling aborting(). For an error in an internal
3478 * function or for the "E132" error in call_user_func(), however, the
3479 * throw point at which the "force_abort" flag (temporarily reset by
3480 * emsg()) is normally updated has not been reached yet. We need to
3481 * update that flag first to make aborting() reliable.
3482 */
3483 update_force_abort();
3484 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003485 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 ret = OK;
3487
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003488theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 /*
3490 * Report an error unless the argument evaluation or function call has been
3491 * cancelled due to an aborting error, an interrupt, or an exception.
3492 */
3493 if (!aborting())
3494 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003495 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 }
3497
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003498 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003500 clear_tv(&argv[--argv_clear + argv_base]);
3501
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 vim_free(tofree);
3503 vim_free(name);
3504
3505 return ret;
3506}
3507
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003508 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003509printable_func_name(ufunc_T *fp)
3510{
3511 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3512}
3513
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003515 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 */
3517 static void
3518list_func_head(ufunc_T *fp, int indent)
3519{
3520 int j;
3521
3522 msg_start();
3523 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003524 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003525 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003526 msg_puts("def ");
3527 else
3528 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003529 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 msg_putchar('(');
3531 for (j = 0; j < fp->uf_args.ga_len; ++j)
3532 {
3533 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003534 msg_puts(", ");
3535 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003536 if (fp->uf_arg_types != NULL)
3537 {
3538 char *tofree;
3539
3540 msg_puts(": ");
3541 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3542 vim_free(tofree);
3543 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003544 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3545 {
3546 msg_puts(" = ");
3547 msg_puts(((char **)(fp->uf_def_args.ga_data))
3548 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 }
3551 if (fp->uf_varargs)
3552 {
3553 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003554 msg_puts(", ");
3555 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003557 if (fp->uf_va_name != NULL)
3558 {
3559 if (j)
3560 msg_puts(", ");
3561 msg_puts("...");
3562 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003563 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003564 {
3565 char *tofree;
3566
3567 msg_puts(": ");
3568 msg_puts(type_name(fp->uf_va_type, &tofree));
3569 vim_free(tofree);
3570 }
3571 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003573
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003574 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003575 {
3576 if (fp->uf_ret_type != &t_void)
3577 {
3578 char *tofree;
3579
3580 msg_puts(": ");
3581 msg_puts(type_name(fp->uf_ret_type, &tofree));
3582 vim_free(tofree);
3583 }
3584 }
3585 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003586 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003588 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003590 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003591 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003592 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593 msg_clr_eos();
3594 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003595 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596}
3597
3598/*
3599 * Get a function name, translating "<SID>" and "<SNR>".
3600 * Also handles a Funcref in a List or Dictionary.
3601 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003602 * Set "*is_global" to TRUE when the function must be global, unless
3603 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 * flags:
3605 * TFN_INT: internal function name OK
3606 * TFN_QUIET: be quiet
3607 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003608 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 * Advances "pp" to just after the function name (if no error).
3610 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003611 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612trans_function_name(
3613 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003614 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003615 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003617 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003618 partial_T **partial, // return: partial of a FuncRef
3619 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620{
3621 char_u *name = NULL;
3622 char_u *start;
3623 char_u *end;
3624 int lead;
3625 char_u sid_buf[20];
3626 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003627 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003629 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003630 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631
3632 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003633 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 start = *pp;
3635
Bram Moolenaare38eab22019-12-05 21:50:01 +01003636 // Check for hard coded <SNR>: already translated function ID (from a user
3637 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3639 && (*pp)[2] == (int)KE_SNR)
3640 {
3641 *pp += 3;
3642 len = get_id_len(pp) + 3;
3643 return vim_strnsave(start, len);
3644 }
3645
Bram Moolenaare38eab22019-12-05 21:50:01 +01003646 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3647 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 lead = eval_fname_script(start);
3649 if (lead > 2)
3650 start += lead;
3651
Bram Moolenaare38eab22019-12-05 21:50:01 +01003652 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003653 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654 lead > 2 ? 0 : FNE_CHECK_START);
3655 if (end == start)
3656 {
3657 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003658 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 goto theend;
3660 }
3661 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3662 {
3663 /*
3664 * Report an invalid expression in braces, unless the expression
3665 * evaluation has been cancelled due to an aborting error, an
3666 * interrupt, or an exception.
3667 */
3668 if (!aborting())
3669 {
3670 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003671 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 }
3673 else
3674 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3675 goto theend;
3676 }
3677
3678 if (lv.ll_tv != NULL)
3679 {
3680 if (fdp != NULL)
3681 {
3682 fdp->fd_dict = lv.ll_dict;
3683 fdp->fd_newkey = lv.ll_newkey;
3684 lv.ll_newkey = NULL;
3685 fdp->fd_di = lv.ll_di;
3686 }
3687 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3688 {
3689 name = vim_strsave(lv.ll_tv->vval.v_string);
3690 *pp = end;
3691 }
3692 else if (lv.ll_tv->v_type == VAR_PARTIAL
3693 && lv.ll_tv->vval.v_partial != NULL)
3694 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003695 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 *pp = end;
3697 if (partial != NULL)
3698 *partial = lv.ll_tv->vval.v_partial;
3699 }
3700 else
3701 {
3702 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3703 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003704 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705 else
3706 *pp = end;
3707 name = NULL;
3708 }
3709 goto theend;
3710 }
3711
3712 if (lv.ll_name == NULL)
3713 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003714 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 *pp = end;
3716 goto theend;
3717 }
3718
Bram Moolenaare38eab22019-12-05 21:50:01 +01003719 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720 if (lv.ll_exp_name != NULL)
3721 {
3722 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003723 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003724 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 if (name == lv.ll_exp_name)
3726 name = NULL;
3727 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003728 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 {
3730 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003731 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003732 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 if (name == *pp)
3734 name = NULL;
3735 }
3736 if (name != NULL)
3737 {
3738 name = vim_strsave(name);
3739 *pp = end;
3740 if (STRNCMP(name, "<SNR>", 5) == 0)
3741 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003742 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 name[0] = K_SPECIAL;
3744 name[1] = KS_EXTRA;
3745 name[2] = (int)KE_SNR;
3746 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3747 }
3748 goto theend;
3749 }
3750
3751 if (lv.ll_exp_name != NULL)
3752 {
3753 len = (int)STRLEN(lv.ll_exp_name);
3754 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3755 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3756 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003757 // When there was "s:" already or the name expanded to get a
3758 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759 lv.ll_name += 2;
3760 len -= 2;
3761 lead = 2;
3762 }
3763 }
3764 else
3765 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003766 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003768 {
3769 if (is_global != NULL && lv.ll_name[0] == 'g')
3770 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003772 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003773 len = (int)(end - lv.ll_name);
3774 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003775 if (len <= 0)
3776 {
3777 if (!skip)
3778 emsg(_(e_function_name));
3779 goto theend;
3780 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003782 // In Vim9 script a user function is script-local by default, unless it
3783 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003784 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003785 if (vim9script)
3786 {
3787 char_u *p;
3788
3789 // SomeScript#func() is a global function.
3790 for (p = start; *p != NUL && *p != '('; ++p)
3791 if (*p == AUTOLOAD_CHAR)
3792 vim9script = FALSE;
3793 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003794
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 /*
3796 * Copy the function name to allocated memory.
3797 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3798 * Accept <SNR>123_name() outside a script.
3799 */
3800 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003801 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003802 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003804 if (!vim9script)
3805 lead = 3;
3806 if (vim9script || (lv.ll_exp_name != NULL
3807 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 || eval_fname_sid(*pp))
3809 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003811 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003813 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 goto theend;
3815 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003816 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003817 if (vim9script)
3818 extra = 3 + (int)STRLEN(sid_buf);
3819 else
3820 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 }
3822 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003823 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3824 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003826 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 start);
3828 goto theend;
3829 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003830 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 {
3832 char_u *cp = vim_strchr(lv.ll_name, ':');
3833
3834 if (cp != NULL && cp < end)
3835 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003836 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837 goto theend;
3838 }
3839 }
3840
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 if (name != NULL)
3843 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003844 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845 {
3846 name[0] = K_SPECIAL;
3847 name[1] = KS_EXTRA;
3848 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003849 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850 STRCPY(name + 3, sid_buf);
3851 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003852 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3853 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 }
3855 *pp = end;
3856
3857theend:
3858 clear_lval(&lv);
3859 return name;
3860}
3861
3862/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003863 * Assuming "name" is the result of trans_function_name() and it was prefixed
3864 * to use the script-local name, return the unmodified name (points into
3865 * "name"). Otherwise return NULL.
3866 * This can be used to first search for a script-local function and fall back
3867 * to the global function if not found.
3868 */
3869 char_u *
3870untrans_function_name(char_u *name)
3871{
3872 char_u *p;
3873
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003874 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003875 {
3876 p = vim_strchr(name, '_');
3877 if (p != NULL)
3878 return p + 1;
3879 }
3880 return NULL;
3881}
3882
3883/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003884 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3885 * current script ID and returns the expanded function name. The caller should
3886 * free the returned name. If not called from a script context or the function
3887 * name doesn't start with these prefixes, then returns NULL.
3888 * This doesn't check whether the script-local function exists or not.
3889 */
3890 char_u *
3891get_scriptlocal_funcname(char_u *funcname)
3892{
3893 char sid_buf[25];
3894 int off;
3895 char_u *newname;
3896
3897 if (funcname == NULL)
3898 return NULL;
3899
3900 if (STRNCMP(funcname, "s:", 2) != 0
3901 && STRNCMP(funcname, "<SID>", 5) != 0)
3902 // The function name is not a script-local function name
3903 return NULL;
3904
3905 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3906 {
3907 emsg(_(e_using_sid_not_in_script_context));
3908 return NULL;
3909 }
3910 // Expand s: prefix into <SNR>nr_<name>
3911 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3912 (long)current_sctx.sc_sid);
3913 off = *funcname == 's' ? 2 : 5;
3914 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3915 if (newname == NULL)
3916 return NULL;
3917 STRCPY(newname, sid_buf);
3918 STRCAT(newname, funcname + off);
3919
3920 return newname;
3921}
3922
3923/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003924 * Call trans_function_name(), except that a lambda is returned as-is.
3925 * Returns the name in allocated memory.
3926 */
3927 char_u *
3928save_function_name(
3929 char_u **name,
3930 int *is_global,
3931 int skip,
3932 int flags,
3933 funcdict_T *fudi)
3934{
3935 char_u *p = *name;
3936 char_u *saved;
3937
3938 if (STRNCMP(p, "<lambda>", 8) == 0)
3939 {
3940 p += 8;
3941 (void)getdigits(&p);
3942 saved = vim_strnsave(*name, p - *name);
3943 if (fudi != NULL)
3944 CLEAR_POINTER(fudi);
3945 }
3946 else
3947 saved = trans_function_name(&p, is_global, skip,
3948 flags, fudi, NULL, NULL);
3949 *name = p;
3950 return saved;
3951}
3952
3953/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003954 * List functions. When "regmatch" is NULL all of then.
3955 * Otherwise functions matching "regmatch".
3956 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003957 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003958list_functions(regmatch_T *regmatch)
3959{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003960 int changed = func_hashtab.ht_changed;
3961 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003962 hashitem_T *hi;
3963
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003964 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003965 {
3966 if (!HASHITEM_EMPTY(hi))
3967 {
3968 ufunc_T *fp = HI2UF(hi);
3969
3970 --todo;
3971 if ((fp->uf_flags & FC_DEAD) == 0
3972 && (regmatch == NULL
3973 ? !message_filtered(fp->uf_name)
3974 && !func_name_refcount(fp->uf_name)
3975 : !isdigit(*fp->uf_name)
3976 && vim_regexec(regmatch, fp->uf_name, 0)))
3977 {
3978 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003979 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003980 {
3981 emsg(_("E454: function list was modified"));
3982 return;
3983 }
3984 }
3985 }
3986 }
3987}
3988
3989/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003990 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003991 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3992 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003993 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003995 ufunc_T *
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00003996define_function(exarg_T *eap, char_u *name_arg, char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003997{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 int j;
3999 int c;
4000 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004001 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004002 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004003 char_u *p;
4004 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004005 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006 char_u *line_arg = NULL;
4007 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004008 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004009 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 garray_T newlines;
4011 int varargs = FALSE;
4012 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004013 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004014 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004015 int fp_allocated = FALSE;
4016 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004017 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004018 dictitem_T *v;
4019 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004020 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004023 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004024 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004025 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026
4027 /*
4028 * ":function" without argument: list functions.
4029 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004030 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 {
4032 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004033 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004034 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004035 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 }
4037
4038 /*
4039 * ":function /pat": list functions matching pattern.
4040 */
4041 if (*eap->arg == '/')
4042 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004043 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 if (!eap->skip)
4045 {
4046 regmatch_T regmatch;
4047
4048 c = *p;
4049 *p = NUL;
4050 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4051 *p = c;
4052 if (regmatch.regprog != NULL)
4053 {
4054 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004055 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 vim_regfree(regmatch.regprog);
4057 }
4058 }
4059 if (*p == '/')
4060 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004061 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004062 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 }
4064
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004065 ga_init(&newargs);
4066 ga_init(&argtypes);
4067 ga_init(&default_args);
4068
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 /*
4070 * Get the function name. There are these situations:
4071 * func normal function name
4072 * "name" == func, "fudi.fd_dict" == NULL
4073 * dict.func new dictionary entry
4074 * "name" == NULL, "fudi.fd_dict" set,
4075 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4076 * dict.func existing dict entry with a Funcref
4077 * "name" == func, "fudi.fd_dict" set,
4078 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4079 * dict.func existing dict entry that's not a Funcref
4080 * "name" == NULL, "fudi.fd_dict" set,
4081 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4082 * s:func script-local function name
4083 * g:func global function name, same as "func"
4084 */
4085 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004086 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004088 // nested function, argument is (args).
4089 paren = TRUE;
4090 CLEAR_FIELD(fudi);
4091 }
4092 else
4093 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004094 name = save_function_name(&p, &is_global, eap->skip,
4095 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004096 paren = (vim_strchr(p, '(') != NULL);
4097 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004099 /*
4100 * Return on an invalid expression in braces, unless the expression
4101 * evaluation has been cancelled due to an aborting error, an
4102 * interrupt, or an exception.
4103 */
4104 if (!aborting())
4105 {
4106 if (!eap->skip && fudi.fd_newkey != NULL)
4107 semsg(_(e_dictkey), fudi.fd_newkey);
4108 vim_free(fudi.fd_newkey);
4109 return NULL;
4110 }
4111 else
4112 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004114 }
4115
Bram Moolenaare38eab22019-12-05 21:50:01 +01004116 // An error in a function call during evaluation of an expression in magic
4117 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 saved_did_emsg = did_emsg;
4119 did_emsg = FALSE;
4120
4121 /*
4122 * ":function func" with only function name: list function.
4123 */
4124 if (!paren)
4125 {
4126 if (!ends_excmd(*skipwhite(p)))
4127 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004128 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 goto ret_free;
4130 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004131 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132 if (eap->nextcmd != NULL)
4133 *p = NUL;
4134 if (!eap->skip && !got_int)
4135 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004136 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004137 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4138 {
4139 char_u *up = untrans_function_name(name);
4140
4141 // With Vim9 script the name was made script-local, if not
4142 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004143 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004144 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004145 }
4146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 if (fp != NULL)
4148 {
4149 list_func_head(fp, TRUE);
4150 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4151 {
4152 if (FUNCLINE(fp, j) == NULL)
4153 continue;
4154 msg_putchar('\n');
4155 msg_outnum((long)(j + 1));
4156 if (j < 9)
4157 msg_putchar(' ');
4158 if (j < 99)
4159 msg_putchar(' ');
4160 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004161 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162 ui_breakcheck();
4163 }
4164 if (!got_int)
4165 {
4166 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004167 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004168 msg_puts(" enddef");
4169 else
4170 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 }
4172 }
4173 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004174 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 }
4176 goto ret_free;
4177 }
4178
4179 /*
4180 * ":function name(arg1, arg2)" Define function.
4181 */
4182 p = skipwhite(p);
4183 if (*p != '(')
4184 {
4185 if (!eap->skip)
4186 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004187 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 goto ret_free;
4189 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004190 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191 if (vim_strchr(p, '(') != NULL)
4192 p = vim_strchr(p, '(');
4193 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004195 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4196 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004197 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004198 goto ret_free;
4199 }
4200
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004201 // In Vim9 script only global functions can be redefined.
4202 if (vim9script && eap->forceit && !is_global)
4203 {
4204 emsg(_(e_nobang));
4205 goto ret_free;
4206 }
4207
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004208 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209
Bram Moolenaar04b12692020-05-04 23:24:44 +02004210 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004212 // Check the name of the function. Unless it's a dictionary function
4213 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 if (name != NULL)
4215 arg = name;
4216 else
4217 arg = fudi.fd_newkey;
4218 if (arg != NULL && (fudi.fd_di == NULL
4219 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4220 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4221 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004222 char_u *name_base = arg;
4223 int i;
4224
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004226 {
4227 name_base = vim_strchr(arg, '_');
4228 if (name_base == NULL)
4229 name_base = arg + 3;
4230 else
4231 ++name_base;
4232 }
4233 for (i = 0; name_base[i] != NUL && (i == 0
4234 ? eval_isnamec1(name_base[i])
4235 : eval_isnamec(name_base[i])); ++i)
4236 ;
4237 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004239
4240 // In Vim9 script a function cannot have the same name as a
4241 // variable.
4242 if (vim9script && *arg == K_SPECIAL
Mike Williams1821d142021-12-15 16:38:33 +00004243 && eval_variable(name_base, (int)STRLEN(name_base), NULL, NULL,
Bram Moolenaar052ff292021-12-11 13:54:46 +00004244 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4245 + EVAL_VAR_NO_FUNC) == OK)
4246 {
4247 semsg(_(e_redefining_script_item_str), name_base);
4248 goto ret_free;
4249 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004251 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004253 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004254 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004255 goto ret_free;
4256 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257 }
4258
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004259 // This may get more lines and make the pointers into the first line
4260 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004261 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004262 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004263 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004264 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004265 eap, line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004267 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004269 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004271 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004272 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004274 if (*p != ':')
4275 {
4276 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4277 p = skipwhite(p);
4278 }
4279 else if (!IS_WHITE_OR_NUL(p[1]))
4280 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004281 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004282 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004283 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004284 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004285 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004286 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004287 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004288 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004289 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004290 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004291 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004292 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004295 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004297 else
4298 // find extra arguments "range", "dict", "abort" and "closure"
4299 for (;;)
4300 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004301 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004302 p = skipwhite(p);
4303 if (STRNCMP(p, "range", 5) == 0)
4304 {
4305 flags |= FC_RANGE;
4306 p += 5;
4307 }
4308 else if (STRNCMP(p, "dict", 4) == 0)
4309 {
4310 flags |= FC_DICT;
4311 p += 4;
4312 }
4313 else if (STRNCMP(p, "abort", 5) == 0)
4314 {
4315 flags |= FC_ABORT;
4316 p += 5;
4317 }
4318 else if (STRNCMP(p, "closure", 7) == 0)
4319 {
4320 flags |= FC_CLOSURE;
4321 p += 7;
4322 if (current_funccal == NULL)
4323 {
4324 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4325 name == NULL ? (char_u *)"" : name);
4326 goto erret;
4327 }
4328 }
4329 else
4330 break;
4331 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332
Bram Moolenaare38eab22019-12-05 21:50:01 +01004333 // When there is a line break use what follows for the function body.
4334 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 if (*p == '\n')
4336 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004337 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004338 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4339 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004340 && !(VIM_ISWHITE(*whitep) && *p == '#'
4341 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004342 && !eap->skip
4343 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004344 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345
4346 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004347 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4348 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 */
4350 if (KeyTyped)
4351 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004352 // Check if the function already exists, don't let the user type the
4353 // whole function before telling him it doesn't work! For a script we
4354 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 if (!eap->skip && !eap->forceit)
4356 {
4357 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004358 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004359 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004360 emsg_funcname(e_funcexts, name);
4361 }
4362
4363 if (!eap->skip && did_emsg)
4364 goto erret;
4365
Bram Moolenaare38eab22019-12-05 21:50:01 +01004366 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 cmdline_row = msg_row;
4368 }
4369
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004370 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004371 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004372
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004373 // Do not define the function when getting the body fails and when
4374 // skipping.
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004375 if (get_function_body(eap, &newlines, line_arg, line_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004376 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 goto erret;
4378
4379 /*
4380 * If there are no errors, add the function
4381 */
4382 if (fudi.fd_dict == NULL)
4383 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004384 hashtab_T *ht;
4385
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004386 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4388 {
4389 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4390 name);
4391 goto erret;
4392 }
4393
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004394 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004395 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004397 char_u *uname = untrans_function_name(name);
4398
4399 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4400 }
4401
4402 if (fp != NULL || import != NULL)
4403 {
4404 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004405
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004406 // Function can be replaced with "function!" and when sourcing the
4407 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004408 // A name that is used by an import can not be overruled.
4409 if (import != NULL
4410 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004411 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004412 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004414 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004415 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004416 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004417 else
4418 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 goto erret;
4420 }
4421 if (fp->uf_calls > 0)
4422 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004423 emsg_funcname(
4424 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 name);
4426 goto erret;
4427 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004428 if (fp->uf_refcount > 1)
4429 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004430 // This function is referenced somewhere, don't redefine it but
4431 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004432 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004433 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004434 fp = NULL;
4435 overwrite = TRUE;
4436 }
4437 else
4438 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004439 char_u *exp_name = fp->uf_name_exp;
4440
4441 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004442 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004443 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004444 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004445 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004446 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004447#ifdef FEAT_PROFILE
4448 fp->uf_profiling = FALSE;
4449 fp->uf_prof_initialized = FALSE;
4450#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004451 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453 }
4454 }
4455 else
4456 {
4457 char numbuf[20];
4458
4459 fp = NULL;
4460 if (fudi.fd_newkey == NULL && !eap->forceit)
4461 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004462 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004463 goto erret;
4464 }
4465 if (fudi.fd_di == NULL)
4466 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004467 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004468 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 goto erret;
4470 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004471 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004472 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 goto erret;
4474
Bram Moolenaare38eab22019-12-05 21:50:01 +01004475 // Give the function a sequential number. Can only be used with a
4476 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 vim_free(name);
4478 sprintf(numbuf, "%d", ++func_nr);
4479 name = vim_strsave((char_u *)numbuf);
4480 if (name == NULL)
4481 goto erret;
4482 }
4483
4484 if (fp == NULL)
4485 {
4486 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4487 {
4488 int slen, plen;
4489 char_u *scriptname;
4490
Bram Moolenaare38eab22019-12-05 21:50:01 +01004491 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004492 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004493 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 {
4495 scriptname = autoload_name(name);
4496 if (scriptname != NULL)
4497 {
4498 p = vim_strchr(scriptname, '/');
4499 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004500 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004502 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004503 j = OK;
4504 vim_free(scriptname);
4505 }
4506 }
4507 if (j == FAIL)
4508 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004509 linenr_T save_lnum = SOURCING_LNUM;
4510
4511 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004512 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004513 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 goto erret;
4515 }
4516 }
4517
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004518 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 if (fp == NULL)
4520 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004521 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522
4523 if (fudi.fd_dict != NULL)
4524 {
4525 if (fudi.fd_di == NULL)
4526 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004527 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4529 if (fudi.fd_di == NULL)
4530 {
4531 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004532 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533 goto erret;
4534 }
4535 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4536 {
4537 vim_free(fudi.fd_di);
4538 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004539 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540 goto erret;
4541 }
4542 }
4543 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004544 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545 clear_tv(&fudi.fd_di->di_tv);
4546 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548
Bram Moolenaare38eab22019-12-05 21:50:01 +01004549 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 flags |= FC_DICT;
4551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 }
4553 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004554 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004555 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004556 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004557
4558 if (eap->cmdidx == CMD_def)
4559 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004560 int lnum_save = SOURCING_LNUM;
4561 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004562
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004563 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004564
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004565 // error messages are for the first function line
4566 SOURCING_LNUM = sourcing_lnum_top;
4567
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004568 // The function may use script variables from the context.
4569 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004570
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004571 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004572 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004573 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004574 free_fp = fp_allocated;
4575 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004576 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004577 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004578
4579 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004580 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004581 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004582 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004583 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004584 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004585 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004586 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004587 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004588 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004589 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004590
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004591 if (fp_allocated)
4592 {
4593 // insert the new function in the function list
4594 set_ufunc_name(fp, name);
4595 if (overwrite)
4596 {
4597 hi = hash_find(&func_hashtab, name);
4598 hi->hi_key = UF2HIKEY(fp);
4599 }
4600 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4601 {
4602 free_fp = TRUE;
4603 goto erret;
4604 }
4605 fp->uf_refcount = 1;
4606 }
4607
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004608 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004609 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004610 if ((flags & FC_CLOSURE) != 0)
4611 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004612 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004613 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004614 }
4615 else
4616 fp->uf_scoped = NULL;
4617
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004618#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 if (prof_def_func())
4620 func_do_profile(fp);
4621#endif
4622 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004623 if (sandbox)
4624 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004625 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004626 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627 fp->uf_flags = flags;
4628 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004629 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004630 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004631 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004632 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004633 if (is_export)
4634 {
4635 fp->uf_flags |= FC_EXPORT;
4636 // let ex_export() know the export worked.
4637 is_export = FALSE;
4638 }
4639
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004640 if (eap->cmdidx == CMD_def)
4641 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004642 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4643 // :func does not use Vim9 script syntax, even in a Vim9 script file
4644 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004645
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004646 goto ret_free;
4647
4648erret:
4649 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004650 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004651 if (fp != NULL)
4652 {
4653 ga_init(&fp->uf_args);
4654 ga_init(&fp->uf_def_args);
4655 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656errret_2:
4657 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004658 if (fp != NULL)
4659 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004660 if (free_fp)
4661 {
4662 vim_free(fp);
4663 fp = NULL;
4664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004666 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004668 if (name != name_arg)
4669 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004670 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004672
4673 return fp;
4674}
4675
4676/*
4677 * ":function"
4678 */
4679 void
4680ex_function(exarg_T *eap)
4681{
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004682 char_u *line_to_free = NULL;
4683
4684 (void)define_function(eap, NULL, &line_to_free);
4685 vim_free(line_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004686}
4687
4688/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004689 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004690 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004691 */
4692 void
4693ex_defcompile(exarg_T *eap UNUSED)
4694{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004695 long todo = (long)func_hashtab.ht_used;
4696 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004697 hashitem_T *hi;
4698 ufunc_T *ufunc;
4699
4700 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4701 {
4702 if (!HASHITEM_EMPTY(hi))
4703 {
4704 --todo;
4705 ufunc = HI2UF(hi);
4706 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004707 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4708 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004709 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004710 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004711
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004712 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004713 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004714 // a function has been added or removed, need to start over
4715 todo = (long)func_hashtab.ht_used;
4716 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004717 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004718 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004719 }
4720 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004721 }
4722 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723}
4724
4725/*
4726 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4727 * Return 2 if "p" starts with "s:".
4728 * Return 0 otherwise.
4729 */
4730 int
4731eval_fname_script(char_u *p)
4732{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004733 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4734 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4736 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4737 return 5;
4738 if (p[0] == 's' && p[1] == ':')
4739 return 2;
4740 return 0;
4741}
4742
4743 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004744translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745{
4746 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004747 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004748 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004749}
4750
4751/*
4752 * Return TRUE when "ufunc" has old-style "..." varargs
4753 * or named varargs "...name: type".
4754 */
4755 int
4756has_varargs(ufunc_T *ufunc)
4757{
4758 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759}
4760
4761/*
4762 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004763 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004764 */
4765 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004766function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767{
4768 char_u *nm = name;
4769 char_u *p;
4770 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004771 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004772 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004774 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4775 if (no_deref)
4776 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004777 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 nm = skipwhite(nm);
4779
Bram Moolenaare38eab22019-12-05 21:50:01 +01004780 // Only accept "funcname", "funcname ", "funcname (..." and
4781 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004783 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 vim_free(p);
4785 return n;
4786}
4787
Bram Moolenaar113e1072019-01-20 15:30:40 +01004788#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789 char_u *
4790get_expanded_name(char_u *name, int check)
4791{
4792 char_u *nm = name;
4793 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004794 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004796 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004797 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004799 if (p != NULL && *nm == NUL
4800 && (!check || translated_function_exists(p, is_global)))
4801 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004802
4803 vim_free(p);
4804 return NULL;
4805}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004806#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004808/*
4809 * Function given to ExpandGeneric() to obtain the list of user defined
4810 * function names.
4811 */
4812 char_u *
4813get_user_func_name(expand_T *xp, int idx)
4814{
4815 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004816 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817 static hashitem_T *hi;
4818 ufunc_T *fp;
4819
4820 if (idx == 0)
4821 {
4822 done = 0;
4823 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004824 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004826 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 {
4828 if (done++ > 0)
4829 ++hi;
4830 while (HASHITEM_EMPTY(hi))
4831 ++hi;
4832 fp = HI2UF(hi);
4833
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004834 // don't show dead, dict and lambda functions
4835 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004836 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004837 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838
4839 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004840 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841
4842 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004843 if (xp->xp_context != EXPAND_USER_FUNC
4844 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845 {
4846 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004847 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 STRCAT(IObuff, ")");
4849 }
4850 return IObuff;
4851 }
4852 return NULL;
4853}
4854
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855/*
4856 * ":delfunction {name}"
4857 */
4858 void
4859ex_delfunction(exarg_T *eap)
4860{
4861 ufunc_T *fp = NULL;
4862 char_u *p;
4863 char_u *name;
4864 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004865 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866
4867 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004868 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4869 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 vim_free(fudi.fd_newkey);
4871 if (name == NULL)
4872 {
4873 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004874 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 return;
4876 }
4877 if (!ends_excmd(*skipwhite(p)))
4878 {
4879 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004880 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004881 return;
4882 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004883 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004884 if (eap->nextcmd != NULL)
4885 *p = NUL;
4886
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004887 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004888 {
4889 if (!eap->skip)
4890 semsg(_(e_invarg2), eap->arg);
4891 vim_free(name);
4892 return;
4893 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004895 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004896 vim_free(name);
4897
4898 if (!eap->skip)
4899 {
4900 if (fp == NULL)
4901 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004902 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004903 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904 return;
4905 }
4906 if (fp->uf_calls > 0)
4907 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004908 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004909 return;
4910 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004911 if (fp->uf_flags & FC_VIM9)
4912 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004913 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004914 return;
4915 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916
4917 if (fudi.fd_dict != NULL)
4918 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004919 // Delete the dict item that refers to the function, it will
4920 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004921 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4922 }
4923 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004924 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004925 // A normal function (not a numbered function or lambda) has a
4926 // refcount of 1 for the entry in the hashtable. When deleting
4927 // it and the refcount is more than one, it should be kept.
4928 // A numbered function and lambda should be kept if the refcount is
4929 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004930 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004931 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004932 // Function is still referenced somewhere. Don't free it but
4933 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004934 if (func_remove(fp))
4935 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004936 }
4937 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004938 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004939 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004940 }
4941}
4942
4943/*
4944 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004945 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 */
4947 void
4948func_unref(char_u *name)
4949{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004950 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004952 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004954 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004955 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004958 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004959#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004960 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004961 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004962 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004963}
4964
4965/*
4966 * Unreference a Function: decrement the reference count and free it when it
4967 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004968 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004969 */
4970 void
4971func_ptr_unref(ufunc_T *fp)
4972{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004973 if (fp != NULL && (--fp->uf_refcount <= 0
4974 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4975 && fp->uf_partial->pt_refcount <= 1
4976 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004977 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004978 // Only delete it when it's not being used. Otherwise it's done
4979 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004980 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004981 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982 }
4983}
4984
4985/*
4986 * Count a reference to a Function.
4987 */
4988 void
4989func_ref(char_u *name)
4990{
4991 ufunc_T *fp;
4992
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004993 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004994 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004995 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004996 if (fp != NULL)
4997 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004998 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004999 // Only give an error for a numbered function.
5000 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005001 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005002}
5003
5004/*
5005 * Count a reference to a Function.
5006 */
5007 void
5008func_ptr_ref(ufunc_T *fp)
5009{
5010 if (fp != NULL)
5011 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012}
5013
5014/*
5015 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5016 * referenced from anywhere that is in use.
5017 */
5018 static int
5019can_free_funccal(funccall_T *fc, int copyID)
5020{
5021 return (fc->l_varlist.lv_copyID != copyID
5022 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005023 && fc->l_avars.dv_copyID != copyID
5024 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005025}
5026
5027/*
5028 * ":return [expr]"
5029 */
5030 void
5031ex_return(exarg_T *eap)
5032{
5033 char_u *arg = eap->arg;
5034 typval_T rettv;
5035 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005036 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037
5038 if (current_funccal == NULL)
5039 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005040 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 return;
5042 }
5043
Bram Moolenaar844fb642021-10-23 13:32:30 +01005044 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005045 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5046
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 if (eap->skip)
5048 ++emsg_skip;
5049
5050 eap->nextcmd = NULL;
5051 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005052 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005053 {
5054 if (!eap->skip)
5055 returning = do_return(eap, FALSE, TRUE, &rettv);
5056 else
5057 clear_tv(&rettv);
5058 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005059 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060 else if (!eap->skip)
5061 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005062 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005063 update_force_abort();
5064
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 /*
5066 * Return unless the expression evaluation has been cancelled due to an
5067 * aborting error, an interrupt, or an exception.
5068 */
5069 if (!aborting())
5070 returning = do_return(eap, FALSE, TRUE, NULL);
5071 }
5072
Bram Moolenaare38eab22019-12-05 21:50:01 +01005073 // When skipping or the return gets pending, advance to the next command
5074 // in this line (!returning). Otherwise, ignore the rest of the line.
5075 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076 if (returning)
5077 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005078 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005079 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080
5081 if (eap->skip)
5082 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005083 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005084}
5085
5086/*
5087 * ":1,25call func(arg1, arg2)" function call.
5088 */
5089 void
5090ex_call(exarg_T *eap)
5091{
5092 char_u *arg = eap->arg;
5093 char_u *startarg;
5094 char_u *name;
5095 char_u *tofree;
5096 int len;
5097 typval_T rettv;
5098 linenr_T lnum;
5099 int doesrange;
5100 int failed = FALSE;
5101 funcdict_T fudi;
5102 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005103 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005104 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005105 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106
Bram Moolenaare6b53242020-07-01 17:28:33 +02005107 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005108 if (eap->skip)
5109 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005110 // trans_function_name() doesn't work well when skipping, use eval0()
5111 // instead to skip to any following command, e.g. for:
5112 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005114 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 clear_tv(&rettv);
5116 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005117 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005118 return;
5119 }
5120
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005121 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5122 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005123 if (fudi.fd_newkey != NULL)
5124 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005125 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005126 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127 vim_free(fudi.fd_newkey);
5128 }
5129 if (tofree == NULL)
5130 return;
5131
Bram Moolenaare38eab22019-12-05 21:50:01 +01005132 // Increase refcount on dictionary, it could get deleted when evaluating
5133 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005134 if (fudi.fd_dict != NULL)
5135 ++fudi.fd_dict->dv_refcount;
5136
Bram Moolenaare38eab22019-12-05 21:50:01 +01005137 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5138 // contents. For VAR_PARTIAL get its partial, unless we already have one
5139 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005141 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005142 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005143
Bram Moolenaare38eab22019-12-05 21:50:01 +01005144 // Skip white space to allow ":call func ()". Not good, but required for
5145 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 if (*startarg != '(')
5148 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005149 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150 goto end;
5151 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005152 if (in_vim9script() && startarg > arg)
5153 {
5154 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5155 goto end;
5156 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005157
5158 /*
5159 * When skipping, evaluate the function once, to find the end of the
5160 * arguments.
5161 * When the function takes a range, this is discovered after the first
5162 * call, and the loop is broken.
5163 */
5164 if (eap->skip)
5165 {
5166 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005167 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 }
5169 else
5170 lnum = eap->line1;
5171 for ( ; lnum <= eap->line2; ++lnum)
5172 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005173 funcexe_T funcexe;
5174
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175 if (!eap->skip && eap->addr_count > 0)
5176 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005177 if (lnum > curbuf->b_ml.ml_line_count)
5178 {
5179 // If the function deleted lines or switched to another buffer
5180 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005181 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005182 break;
5183 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005184 curwin->w_cursor.lnum = lnum;
5185 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005187 }
5188 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005189
Bram Moolenaara80faa82020-04-12 19:37:17 +02005190 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005191 funcexe.fe_firstline = eap->line1;
5192 funcexe.fe_lastline = eap->line2;
5193 funcexe.fe_doesrange = &doesrange;
5194 funcexe.fe_evaluate = !eap->skip;
5195 funcexe.fe_partial = partial;
5196 funcexe.fe_selfdict = fudi.fd_dict;
5197 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005198 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005199 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005200 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 {
5202 failed = TRUE;
5203 break;
5204 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005205 if (has_watchexpr())
5206 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005208 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005209 if (handle_subscript(&arg, &rettv,
5210 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005211 {
5212 failed = TRUE;
5213 break;
5214 }
5215
5216 clear_tv(&rettv);
5217 if (doesrange || eap->skip)
5218 break;
5219
Bram Moolenaare38eab22019-12-05 21:50:01 +01005220 // Stop when immediately aborting on error, or when an interrupt
5221 // occurred or an exception was thrown but not caught.
5222 // get_func_tv() returned OK, so that the check for trailing
5223 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 if (aborting())
5225 break;
5226 }
5227 if (eap->skip)
5228 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005229 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005230
Bram Moolenaar1d341892021-09-18 15:25:52 +02005231 // When inside :try we need to check for following "| catch" or "| endtry".
5232 // Not when there was an error, but do check if an exception was thrown.
5233 if ((!aborting() || did_throw)
5234 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005235 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005236 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005237 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005238 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005239 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005240 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005241 {
5242 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005243 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005245 }
5246 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005247 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005248 }
5249
5250end:
5251 dict_unref(fudi.fd_dict);
5252 vim_free(tofree);
5253}
5254
5255/*
5256 * Return from a function. Possibly makes the return pending. Also called
5257 * for a pending return at the ":endtry" or after returning from an extra
5258 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5259 * when called due to a ":return" command. "rettv" may point to a typval_T
5260 * with the return rettv. Returns TRUE when the return can be carried out,
5261 * FALSE when the return gets pending.
5262 */
5263 int
5264do_return(
5265 exarg_T *eap,
5266 int reanimate,
5267 int is_cmd,
5268 void *rettv)
5269{
5270 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005271 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005272
5273 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005274 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275 current_funccal->returned = FALSE;
5276
5277 /*
5278 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5279 * not in its finally clause (which then is to be executed next) is found.
5280 * In this case, make the ":return" pending for execution at the ":endtry".
5281 * Otherwise, return normally.
5282 */
5283 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5284 if (idx >= 0)
5285 {
5286 cstack->cs_pending[idx] = CSTP_RETURN;
5287
5288 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005289 // A pending return again gets pending. "rettv" points to an
5290 // allocated variable with the rettv of the original ":return"'s
5291 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005292 cstack->cs_rettv[idx] = rettv;
5293 else
5294 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005295 // When undoing a return in order to make it pending, get the stored
5296 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 if (reanimate)
5298 rettv = current_funccal->rettv;
5299
5300 if (rettv != NULL)
5301 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005302 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5304 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5305 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005306 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005307 }
5308 else
5309 cstack->cs_rettv[idx] = NULL;
5310
5311 if (reanimate)
5312 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005313 // The pending return value could be overwritten by a ":return"
5314 // without argument in a finally clause; reset the default
5315 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316 current_funccal->rettv->v_type = VAR_NUMBER;
5317 current_funccal->rettv->vval.v_number = 0;
5318 }
5319 }
5320 report_make_pending(CSTP_RETURN, rettv);
5321 }
5322 else
5323 {
5324 current_funccal->returned = TRUE;
5325
Bram Moolenaare38eab22019-12-05 21:50:01 +01005326 // If the return is carried out now, store the return value. For
5327 // a return immediately after reanimation, the value is already
5328 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 if (!reanimate && rettv != NULL)
5330 {
5331 clear_tv(current_funccal->rettv);
5332 *current_funccal->rettv = *(typval_T *)rettv;
5333 if (!is_cmd)
5334 vim_free(rettv);
5335 }
5336 }
5337
5338 return idx < 0;
5339}
5340
5341/*
5342 * Free the variable with a pending return value.
5343 */
5344 void
5345discard_pending_return(void *rettv)
5346{
5347 free_tv((typval_T *)rettv);
5348}
5349
5350/*
5351 * Generate a return command for producing the value of "rettv". The result
5352 * is an allocated string. Used by report_pending() for verbose messages.
5353 */
5354 char_u *
5355get_return_cmd(void *rettv)
5356{
5357 char_u *s = NULL;
5358 char_u *tofree = NULL;
5359 char_u numbuf[NUMBUFLEN];
5360
5361 if (rettv != NULL)
5362 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5363 if (s == NULL)
5364 s = (char_u *)"";
5365
5366 STRCPY(IObuff, ":return ");
5367 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5368 if (STRLEN(s) + 8 >= IOSIZE)
5369 STRCPY(IObuff + IOSIZE - 4, "...");
5370 vim_free(tofree);
5371 return vim_strsave(IObuff);
5372}
5373
5374/*
5375 * Get next function line.
5376 * Called by do_cmdline() to get the next line.
5377 * Returns allocated string, or NULL for end of function.
5378 */
5379 char_u *
5380get_func_line(
5381 int c UNUSED,
5382 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005383 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005384 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385{
5386 funccall_T *fcp = (funccall_T *)cookie;
5387 ufunc_T *fp = fcp->func;
5388 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005389 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005390
Bram Moolenaare38eab22019-12-05 21:50:01 +01005391 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005392 if (fcp->dbg_tick != debug_tick)
5393 {
5394 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005395 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396 fcp->dbg_tick = debug_tick;
5397 }
5398#ifdef FEAT_PROFILE
5399 if (do_profiling == PROF_YES)
5400 func_line_end(cookie);
5401#endif
5402
5403 gap = &fp->uf_lines;
5404 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5405 || fcp->returned)
5406 retval = NULL;
5407 else
5408 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005409 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005410 while (fcp->linenr < gap->ga_len
5411 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5412 ++fcp->linenr;
5413 if (fcp->linenr >= gap->ga_len)
5414 retval = NULL;
5415 else
5416 {
5417 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005418 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005419#ifdef FEAT_PROFILE
5420 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005421 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005422#endif
5423 }
5424 }
5425
Bram Moolenaare38eab22019-12-05 21:50:01 +01005426 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005427 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005428 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005429 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005430 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005431 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005432 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005433 fcp->dbg_tick = debug_tick;
5434 }
5435
5436 return retval;
5437}
5438
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439/*
5440 * Return TRUE if the currently active function should be ended, because a
5441 * return was encountered or an error occurred. Used inside a ":while".
5442 */
5443 int
5444func_has_ended(void *cookie)
5445{
5446 funccall_T *fcp = (funccall_T *)cookie;
5447
Bram Moolenaare38eab22019-12-05 21:50:01 +01005448 // Ignore the "abort" flag if the abortion behavior has been changed due to
5449 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005450 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5451 || fcp->returned);
5452}
5453
5454/*
5455 * return TRUE if cookie indicates a function which "abort"s on errors.
5456 */
5457 int
5458func_has_abort(
5459 void *cookie)
5460{
5461 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5462}
5463
5464
5465/*
5466 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5467 * Don't do this when "Func" is already a partial that was bound
5468 * explicitly (pt_auto is FALSE).
5469 * Changes "rettv" in-place.
5470 * Returns the updated "selfdict_in".
5471 */
5472 dict_T *
5473make_partial(dict_T *selfdict_in, typval_T *rettv)
5474{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005475 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476 char_u *tofree = NULL;
5477 ufunc_T *fp;
5478 char_u fname_buf[FLEN_FIXED + 1];
5479 int error;
5480 dict_T *selfdict = selfdict_in;
5481
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005482 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5483 fp = rettv->vval.v_partial->pt_func;
5484 else
5485 {
5486 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5487 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005488 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005489 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005490 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005491 vim_free(tofree);
5492 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005493
5494 if (fp != NULL && (fp->uf_flags & FC_DICT))
5495 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005496 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005497
5498 if (pt != NULL)
5499 {
5500 pt->pt_refcount = 1;
5501 pt->pt_dict = selfdict;
5502 pt->pt_auto = TRUE;
5503 selfdict = NULL;
5504 if (rettv->v_type == VAR_FUNC)
5505 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005506 // Just a function: Take over the function name and use
5507 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005508 pt->pt_name = rettv->vval.v_string;
5509 }
5510 else
5511 {
5512 partial_T *ret_pt = rettv->vval.v_partial;
5513 int i;
5514
Bram Moolenaare38eab22019-12-05 21:50:01 +01005515 // Partial: copy the function name, use selfdict and copy
5516 // args. Can't take over name or args, the partial might
5517 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005518 if (ret_pt->pt_name != NULL)
5519 {
5520 pt->pt_name = vim_strsave(ret_pt->pt_name);
5521 func_ref(pt->pt_name);
5522 }
5523 else
5524 {
5525 pt->pt_func = ret_pt->pt_func;
5526 func_ptr_ref(pt->pt_func);
5527 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005528 if (ret_pt->pt_argc > 0)
5529 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005530 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005531 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005532 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005533 pt->pt_argc = 0;
5534 else
5535 {
5536 pt->pt_argc = ret_pt->pt_argc;
5537 for (i = 0; i < pt->pt_argc; i++)
5538 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5539 }
5540 }
5541 partial_unref(ret_pt);
5542 }
5543 rettv->v_type = VAR_PARTIAL;
5544 rettv->vval.v_partial = pt;
5545 }
5546 }
5547 return selfdict;
5548}
5549
5550/*
5551 * Return the name of the executed function.
5552 */
5553 char_u *
5554func_name(void *cookie)
5555{
5556 return ((funccall_T *)cookie)->func->uf_name;
5557}
5558
5559/*
5560 * Return the address holding the next breakpoint line for a funccall cookie.
5561 */
5562 linenr_T *
5563func_breakpoint(void *cookie)
5564{
5565 return &((funccall_T *)cookie)->breakpoint;
5566}
5567
5568/*
5569 * Return the address holding the debug tick for a funccall cookie.
5570 */
5571 int *
5572func_dbg_tick(void *cookie)
5573{
5574 return &((funccall_T *)cookie)->dbg_tick;
5575}
5576
5577/*
5578 * Return the nesting level for a funccall cookie.
5579 */
5580 int
5581func_level(void *cookie)
5582{
5583 return ((funccall_T *)cookie)->level;
5584}
5585
5586/*
5587 * Return TRUE when a function was ended by a ":return" command.
5588 */
5589 int
5590current_func_returned(void)
5591{
5592 return current_funccal->returned;
5593}
5594
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005595 int
5596free_unref_funccal(int copyID, int testing)
5597{
5598 int did_free = FALSE;
5599 int did_free_funccal = FALSE;
5600 funccall_T *fc, **pfc;
5601
5602 for (pfc = &previous_funccal; *pfc != NULL; )
5603 {
5604 if (can_free_funccal(*pfc, copyID))
5605 {
5606 fc = *pfc;
5607 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005608 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005609 did_free = TRUE;
5610 did_free_funccal = TRUE;
5611 }
5612 else
5613 pfc = &(*pfc)->caller;
5614 }
5615 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005616 // When a funccal was freed some more items might be garbage
5617 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005618 (void)garbage_collect(testing);
5619
5620 return did_free;
5621}
5622
5623/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005624 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005625 */
5626 static funccall_T *
5627get_funccal(void)
5628{
5629 int i;
5630 funccall_T *funccal;
5631 funccall_T *temp_funccal;
5632
5633 funccal = current_funccal;
5634 if (debug_backtrace_level > 0)
5635 {
5636 for (i = 0; i < debug_backtrace_level; i++)
5637 {
5638 temp_funccal = funccal->caller;
5639 if (temp_funccal)
5640 funccal = temp_funccal;
5641 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005642 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005643 debug_backtrace_level = i;
5644 }
5645 }
5646 return funccal;
5647}
5648
5649/*
5650 * Return the hashtable used for local variables in the current funccal.
5651 * Return NULL if there is no current funccal.
5652 */
5653 hashtab_T *
5654get_funccal_local_ht()
5655{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005656 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005657 return NULL;
5658 return &get_funccal()->l_vars.dv_hashtab;
5659}
5660
5661/*
5662 * Return the l: scope variable.
5663 * Return NULL if there is no current funccal.
5664 */
5665 dictitem_T *
5666get_funccal_local_var()
5667{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005668 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005669 return NULL;
5670 return &get_funccal()->l_vars_var;
5671}
5672
5673/*
5674 * Return the hashtable used for argument in the current funccal.
5675 * Return NULL if there is no current funccal.
5676 */
5677 hashtab_T *
5678get_funccal_args_ht()
5679{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005680 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005681 return NULL;
5682 return &get_funccal()->l_avars.dv_hashtab;
5683}
5684
5685/*
5686 * Return the a: scope variable.
5687 * Return NULL if there is no current funccal.
5688 */
5689 dictitem_T *
5690get_funccal_args_var()
5691{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005692 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005693 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005694 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005695}
5696
5697/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005698 * List function variables, if there is a function.
5699 */
5700 void
5701list_func_vars(int *first)
5702{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005703 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005704 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005705 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005706}
5707
5708/*
5709 * If "ht" is the hashtable for local variables in the current funccal, return
5710 * the dict that contains it.
5711 * Otherwise return NULL.
5712 */
5713 dict_T *
5714get_current_funccal_dict(hashtab_T *ht)
5715{
5716 if (current_funccal != NULL
5717 && ht == &current_funccal->l_vars.dv_hashtab)
5718 return &current_funccal->l_vars;
5719 return NULL;
5720}
5721
5722/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005723 * Search hashitem in parent scope.
5724 */
5725 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005726find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005727{
5728 funccall_T *old_current_funccal = current_funccal;
5729 hashtab_T *ht;
5730 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005731 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005732
5733 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5734 return NULL;
5735
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005736 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005737 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005738 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005739 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005740 ht = find_var_ht(name, &varname);
5741 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005742 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005743 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005744 if (!HASHITEM_EMPTY(hi))
5745 {
5746 *pht = ht;
5747 break;
5748 }
5749 }
5750 if (current_funccal == current_funccal->func->uf_scoped)
5751 break;
5752 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005753 }
5754 current_funccal = old_current_funccal;
5755
5756 return hi;
5757}
5758
5759/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005760 * Search variable in parent scope.
5761 */
5762 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005763find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005764{
5765 dictitem_T *v = NULL;
5766 funccall_T *old_current_funccal = current_funccal;
5767 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005768 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005769
5770 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5771 return NULL;
5772
Bram Moolenaare38eab22019-12-05 21:50:01 +01005773 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005774 current_funccal = current_funccal->func->uf_scoped;
5775 while (current_funccal)
5776 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005777 ht = find_var_ht(name, &varname);
5778 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005779 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005780 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005781 if (v != NULL)
5782 break;
5783 }
5784 if (current_funccal == current_funccal->func->uf_scoped)
5785 break;
5786 current_funccal = current_funccal->func->uf_scoped;
5787 }
5788 current_funccal = old_current_funccal;
5789
5790 return v;
5791}
5792
5793/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005794 * Set "copyID + 1" in previous_funccal and callers.
5795 */
5796 int
5797set_ref_in_previous_funccal(int copyID)
5798{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005799 funccall_T *fc;
5800
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005801 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005802 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005803 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005804 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5805 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5806 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5807 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005808 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005809 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810}
5811
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005812 static int
5813set_ref_in_funccal(funccall_T *fc, int copyID)
5814{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005815 if (fc->fc_copyID != copyID)
5816 {
5817 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005818 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5819 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5820 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5821 || set_ref_in_func(NULL, fc->func, copyID))
5822 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005823 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005824 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005825}
5826
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005827/*
5828 * Set "copyID" in all local vars and arguments in the call stack.
5829 */
5830 int
5831set_ref_in_call_stack(int copyID)
5832{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005833 funccall_T *fc;
5834 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005835
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005836 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5837 if (set_ref_in_funccal(fc, copyID))
5838 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005839
5840 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005841 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5842 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5843 if (set_ref_in_funccal(fc, copyID))
5844 return TRUE;
5845 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005846}
5847
5848/*
5849 * Set "copyID" in all functions available by name.
5850 */
5851 int
5852set_ref_in_functions(int copyID)
5853{
5854 int todo;
5855 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005856 ufunc_T *fp;
5857
5858 todo = (int)func_hashtab.ht_used;
5859 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005860 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005861 if (!HASHITEM_EMPTY(hi))
5862 {
5863 --todo;
5864 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005865 if (!func_name_refcount(fp->uf_name)
5866 && set_ref_in_func(NULL, fp, copyID))
5867 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005868 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005869 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005870 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005871}
5872
5873/*
5874 * Set "copyID" in all function arguments.
5875 */
5876 int
5877set_ref_in_func_args(int copyID)
5878{
5879 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005880
5881 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005882 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5883 copyID, NULL, NULL))
5884 return TRUE;
5885 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005886}
5887
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005888/*
5889 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005890 * Returns TRUE if setting references failed somehow.
5891 */
5892 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005893set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005894{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005895 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005896 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005897 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005898 char_u fname_buf[FLEN_FIXED + 1];
5899 char_u *tofree = NULL;
5900 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005901 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005902
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005903 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005904 return FALSE;
5905
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005906 if (fp_in == NULL)
5907 {
5908 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005909 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005910 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005911 if (fp != NULL)
5912 {
5913 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005914 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005915 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005916
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005917 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005918 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005919}
5920
Bram Moolenaare38eab22019-12-05 21:50:01 +01005921#endif // FEAT_EVAL