blob: e51df51ffd4a7f79860c32f82e83d4a5e9c12dc4 [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;
526 fp->uf_flags = FC_CFUNC;
527 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 {
723 vim_free(*line_to_free);
724 if (eap->getline == NULL)
725 theline = getcmdline(':', 0L, indent, getline_options);
726 else
727 theline = eap->getline(':', eap->cookie, indent,
728 getline_options);
729 *line_to_free = theline;
730 }
731 if (KeyTyped)
732 lines_left = Rows - 1;
733 if (theline == NULL)
734 {
735 // Use the start of the function for the line number.
736 SOURCING_LNUM = sourcing_lnum_top;
737 if (skip_until != NULL)
738 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200739 else if (nesting_inline[nesting])
740 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100741 else if (eap->cmdidx == CMD_def)
742 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100743 else
744 emsg(_("E126: Missing :endfunction"));
745 goto theend;
746 }
747
748 // Detect line continuation: SOURCING_LNUM increased more than one.
749 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
750 if (SOURCING_LNUM < sourcing_lnum_off)
751 sourcing_lnum_off -= SOURCING_LNUM;
752 else
753 sourcing_lnum_off = 0;
754
755 if (skip_until != NULL)
756 {
757 // Don't check for ":endfunc"/":enddef" between
758 // * ":append" and "."
759 // * ":python <<EOF" and "EOF"
760 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
761 if (heredoc_trimmed == NULL
762 || (is_heredoc && skipwhite(theline) == theline)
763 || STRNCMP(theline, heredoc_trimmed,
764 STRLEN(heredoc_trimmed)) == 0)
765 {
766 if (heredoc_trimmed == NULL)
767 p = theline;
768 else if (is_heredoc)
769 p = skipwhite(theline) == theline
770 ? theline : theline + STRLEN(heredoc_trimmed);
771 else
772 p = theline + STRLEN(heredoc_trimmed);
773 if (STRCMP(p, skip_until) == 0)
774 {
775 VIM_CLEAR(skip_until);
776 VIM_CLEAR(heredoc_trimmed);
777 getline_options = vim9_function
778 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
779 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200780
781 if (heredoc_concat_len > 0)
782 {
783 // Replace the starting line with all the concatenated
784 // lines.
785 ga_concat(&heredoc_ga, theline);
786 vim_free(((char_u **)(newlines->ga_data))[
787 heredoc_concat_len - 1]);
788 ((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1] = heredoc_ga.ga_data;
790 ga_init(&heredoc_ga);
791 heredoc_concat_len = 0;
792 theline += STRLEN(theline); // skip the "EOF"
793 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 }
795 }
796 }
797 else
798 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200799 int c;
800 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100801
802 // skip ':' and blanks
803 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
804 ;
805
806 // Check for "endfunction", "enddef" or "}".
807 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200808 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100809 ? *p == '}'
810 : (checkforcmd(&p, nesting_def[nesting]
811 ? "enddef" : "endfunction", 4)
812 && *p != ':'))
813 {
814 if (nesting-- == 0)
815 {
816 char_u *nextcmd = NULL;
817
818 if (*p == '|' || *p == '}')
819 nextcmd = p + 1;
820 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
821 nextcmd = line_arg;
822 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100823 && (vim9_function || p_verbose > 0))
824 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200825 SOURCING_LNUM = sourcing_lnum_top
826 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100827 if (eap->cmdidx == CMD_def)
828 semsg(_(e_text_found_after_enddef_str), p);
829 else
830 give_warning2((char_u *)
831 _("W22: Text found after :endfunction: %s"),
832 p, TRUE);
833 }
834 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100835 {
836 // Another command follows. If the line came from "eap"
837 // we can simply point into it, otherwise we need to
838 // change "eap->cmdlinep".
839 eap->nextcmd = nextcmd;
840 if (*line_to_free != NULL)
841 {
842 vim_free(*eap->cmdlinep);
843 *eap->cmdlinep = *line_to_free;
844 *line_to_free = NULL;
845 }
846 }
847 break;
848 }
849 }
850
851 // Check for mismatched "endfunc" or "enddef".
852 // We don't check for "def" inside "func" thus we also can't check
853 // for "enddef".
854 // We continue to find the end of the function, although we might
855 // not find it.
856 else if (nesting_def[nesting])
857 {
858 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
859 emsg(_(e_mismatched_endfunction));
860 }
861 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
862 emsg(_(e_mismatched_enddef));
863
864 // Increase indent inside "if", "while", "for" and "try", decrease
865 // at "end".
866 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
867 indent -= 2;
868 else if (STRNCMP(p, "if", 2) == 0
869 || STRNCMP(p, "wh", 2) == 0
870 || STRNCMP(p, "for", 3) == 0
871 || STRNCMP(p, "try", 3) == 0)
872 indent += 2;
873
874 // Check for defining a function inside this function.
875 // Only recognize "def" inside "def", not inside "function",
876 // For backwards compatibility, see Test_function_python().
877 c = *p;
878 if (is_function_cmd(&p)
879 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
880 {
881 if (*p == '!')
882 p = skipwhite(p + 1);
883 p += eval_fname_script(p);
884 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
885 NULL, NULL));
886 if (*skipwhite(p) == '(')
887 {
888 if (nesting == MAX_FUNC_NESTING - 1)
889 emsg(_(e_function_nesting_too_deep));
890 else
891 {
892 ++nesting;
893 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200894 nesting_inline[nesting] = FALSE;
895 indent += 2;
896 }
897 }
898 }
899
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200900 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200901 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200902 // Not a comment line: check for nested inline function.
903 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200904 while (end > p && VIM_ISWHITE(*end))
905 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200906 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200907 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200908 int is_block;
909
910 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200911 --end;
912 while (end > p && VIM_ISWHITE(*end))
913 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200914 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
915 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200916 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200917 char_u *s = p;
918
919 // check for line starting with "au" for :autocmd or
920 // "com" for :command, these can use a {} block
921 is_block = checkforcmd_noparen(&s, "autocmd", 2)
922 || checkforcmd_noparen(&s, "command", 3);
923 }
924
925 if (is_block)
926 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting == MAX_FUNC_NESTING - 1)
928 emsg(_(e_function_nesting_too_deep));
929 else
930 {
931 ++nesting;
932 nesting_def[nesting] = TRUE;
933 nesting_inline[nesting] = TRUE;
934 indent += 2;
935 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100936 }
937 }
938 }
939
940 // Check for ":append", ":change", ":insert". Not for :def.
941 p = skip_range(p, FALSE, NULL);
942 if (!vim9_function
943 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
944 || (p[0] == 'c'
945 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
946 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
947 && (STRNCMP(&p[3], "nge", 3) != 0
948 || !ASCII_ISALPHA(p[6])))))))
949 || (p[0] == 'i'
950 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
951 && (!ASCII_ISALPHA(p[2])
952 || (p[2] == 's'
953 && (!ASCII_ISALPHA(p[3])
954 || p[3] == 'e'))))))))
955 skip_until = vim_strsave((char_u *)".");
956
957 // Check for ":python <<EOF", ":tcl <<EOF", etc.
958 arg = skipwhite(skiptowhite(p));
959 if (arg[0] == '<' && arg[1] =='<'
960 && ((p[0] == 'p' && p[1] == 'y'
961 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
962 || ((p[2] == '3' || p[2] == 'x')
963 && !ASCII_ISALPHA(p[3]))))
964 || (p[0] == 'p' && p[1] == 'e'
965 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
966 || (p[0] == 't' && p[1] == 'c'
967 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
968 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
969 && !ASCII_ISALPHA(p[3]))
970 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
971 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
972 || (p[0] == 'm' && p[1] == 'z'
973 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
974 ))
975 {
976 // ":python <<" continues until a dot, like ":append"
977 p = skipwhite(arg + 2);
978 if (STRNCMP(p, "trim", 4) == 0)
979 {
980 // Ignore leading white space.
981 p = skipwhite(p + 4);
982 heredoc_trimmed = vim_strnsave(theline,
983 skipwhite(theline) - theline);
984 }
985 if (*p == NUL)
986 skip_until = vim_strsave((char_u *)".");
987 else
988 skip_until = vim_strnsave(p, skiptowhite(p) - p);
989 getline_options = GETLINE_NONE;
990 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200991 if (eap->cmdidx == CMD_def)
992 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 }
994
995 // Check for ":cmd v =<< [trim] EOF"
996 // and ":cmd [a, b] =<< [trim] EOF"
997 // and "lines =<< [trim] EOF" for Vim9
998 // Where "cmd" can be "let", "var", "final" or "const".
999 arg = skipwhite(skiptowhite(p));
1000 if (*arg == '[')
1001 arg = vim_strchr(arg, ']');
1002 if (arg != NULL)
1003 {
1004 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1005 && arg[1] == '<' && arg[2] =='<');
1006
1007 if (!found)
1008 // skip over the argument after "cmd"
1009 arg = skipwhite(skiptowhite(arg));
1010 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1011 && (checkforcmd(&p, "let", 2)
1012 || checkforcmd(&p, "var", 3)
1013 || checkforcmd(&p, "final", 5)
1014 || checkforcmd(&p, "const", 5))))
1015 {
1016 p = skipwhite(arg + 3);
1017 if (STRNCMP(p, "trim", 4) == 0)
1018 {
1019 // Ignore leading white space.
1020 p = skipwhite(p + 4);
1021 heredoc_trimmed = vim_strnsave(theline,
1022 skipwhite(theline) - theline);
1023 }
1024 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1025 getline_options = GETLINE_NONE;
1026 is_heredoc = TRUE;
1027 }
1028 }
1029 }
1030
1031 // Add the line to the function.
1032 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1033 goto theend;
1034
Bram Moolenaar20677332021-06-06 17:02:53 +02001035 if (heredoc_concat_len > 0)
1036 {
1037 // For a :def function "python << EOF" concatenats all the lines,
1038 // to be used for the instruction later.
1039 ga_concat(&heredoc_ga, theline);
1040 ga_concat(&heredoc_ga, (char_u *)"\n");
1041 p = vim_strsave((char_u *)"");
1042 }
1043 else
1044 {
1045 // Copy the line to newly allocated memory. get_one_sourceline()
1046 // allocates 250 bytes per line, this saves 80% on average. The
1047 // cost is an extra alloc/free.
1048 p = vim_strsave(theline);
1049 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001050 if (p == NULL)
1051 goto theend;
1052 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1053
1054 // Add NULL lines for continuation lines, so that the line count is
1055 // equal to the index in the growarray.
1056 while (sourcing_lnum_off-- > 0)
1057 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1058
1059 // Check for end of eap->arg.
1060 if (line_arg != NULL && *line_arg == NUL)
1061 line_arg = NULL;
1062 }
1063
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001064 // Return OK when no error was detected.
1065 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001066 ret = OK;
1067
1068theend:
1069 vim_free(skip_until);
1070 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001071 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001072 need_wait_return |= saved_wait_return;
1073 return ret;
1074}
1075
1076/*
1077 * Handle the body of a lambda. *arg points to the "{", process statements
1078 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001079 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 * When successful "rettv" is set to a funcref.
1081 */
1082 static int
1083lambda_function_body(
1084 char_u **arg,
1085 typval_T *rettv,
1086 evalarg_T *evalarg,
1087 garray_T *newargs,
1088 garray_T *argtypes,
1089 int varargs,
1090 garray_T *default_args,
1091 char_u *ret_type)
1092{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001093 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001094 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001095 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001096 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001097 exarg_T eap;
1098 garray_T newlines;
1099 char_u *cmdline = NULL;
1100 int ret = FAIL;
1101 char_u *line_to_free = NULL;
1102 partial_T *pt;
1103 char_u *name;
1104 int lnum_save = -1;
1105 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1106
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001107 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1108 {
1109 semsg(_(e_trailing_arg), *arg + 1);
1110 return FAIL;
1111 }
1112
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001113 CLEAR_FIELD(eap);
1114 eap.cmdidx = CMD_block;
1115 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001116 eap.cmdlinep = &cmdline;
1117 eap.skip = !evaluate;
1118 if (evalarg->eval_cctx != NULL)
1119 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1120 else
1121 {
1122 eap.getline = evalarg->eval_getline;
1123 eap.cookie = evalarg->eval_cookie;
1124 }
1125
1126 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1127 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001128 {
1129 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001130 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001131 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001132
1133 // When inside a lambda must add the function lines to evalarg.eval_ga.
1134 evalarg->eval_break_count += newlines.ga_len;
1135 if (gap->ga_itemsize > 0)
1136 {
1137 int idx;
1138 char_u *last;
1139 size_t plen;
1140 char_u *pnl;
1141
1142 for (idx = 0; idx < newlines.ga_len; ++idx)
1143 {
1144 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1145
Bram Moolenaarecb66452021-05-18 15:09:18 +02001146 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001147 goto erret;
1148
1149 // Going to concatenate the lines after parsing. For an empty or
1150 // comment line use an empty string.
1151 // Insert NL characters at the start of each line, the string will
1152 // be split again later in .get_lambda_tv().
1153 if (*p == NUL || vim9_comment_start(p))
1154 p = (char_u *)"";
1155 plen = STRLEN(p);
1156 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1157 if (pnl != NULL)
1158 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001159 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1160 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001161 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001162 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001163 goto erret;
1164 if (cmdline != NULL)
1165 // more is following after the "}", which was skipped
1166 last = cmdline;
1167 else
1168 // nothing is following the "}"
1169 last = (char_u *)"}";
1170 plen = STRLEN(last);
1171 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1172 if (pnl != NULL)
1173 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001174 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1175 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001176 }
1177
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 if (cmdline != NULL)
1179 {
1180 // Something comes after the "}".
1181 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001182
1183 // "arg" points into cmdline, need to keep the line and free it later.
1184 vim_free(evalarg->eval_tofree_cmdline);
1185 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001186 }
1187 else
1188 *arg = (char_u *)"";
1189
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001190 if (!evaluate)
1191 {
1192 ret = OK;
1193 goto erret;
1194 }
1195
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001196 name = get_lambda_name();
1197 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1198 if (ufunc == NULL)
1199 goto erret;
1200 set_ufunc_name(ufunc, name);
1201 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001202 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001203 ufunc->uf_refcount = 1;
1204 ufunc->uf_args = *newargs;
1205 newargs->ga_data = NULL;
1206 ufunc->uf_def_args = *default_args;
1207 default_args->ga_data = NULL;
1208 ufunc->uf_func_type = &t_func_any;
1209
1210 // error messages are for the first function line
1211 lnum_save = SOURCING_LNUM;
1212 SOURCING_LNUM = sourcing_lnum_top;
1213
1214 // parse argument types
1215 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1216 {
1217 SOURCING_LNUM = lnum_save;
1218 goto erret;
1219 }
1220
1221 // parse the return type, if any
1222 if (parse_return_type(ufunc, ret_type) == FAIL)
1223 goto erret;
1224
1225 pt = ALLOC_CLEAR_ONE(partial_T);
1226 if (pt == NULL)
1227 goto erret;
1228 pt->pt_func = ufunc;
1229 pt->pt_refcount = 1;
1230
1231 ufunc->uf_lines = newlines;
1232 newlines.ga_data = NULL;
1233 if (sandbox)
1234 ufunc->uf_flags |= FC_SANDBOX;
1235 if (!ASCII_ISUPPER(*ufunc->uf_name))
1236 ufunc->uf_flags |= FC_VIM9;
1237 ufunc->uf_script_ctx = current_sctx;
1238 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1239 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1240 set_function_type(ufunc);
1241
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001242 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1243
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001244 rettv->vval.v_partial = pt;
1245 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001246 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001247 ret = OK;
1248
1249erret:
1250 if (lnum_save >= 0)
1251 SOURCING_LNUM = lnum_save;
1252 vim_free(line_to_free);
1253 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001254 if (newargs != NULL)
1255 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001256 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001257 if (ufunc != NULL)
1258 {
1259 func_clear(ufunc, TRUE);
1260 func_free(ufunc, TRUE);
1261 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262 return ret;
1263}
1264
1265/*
1266 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001267 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001268 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001269 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1270 */
1271 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001272get_lambda_tv(
1273 char_u **arg,
1274 typval_T *rettv,
1275 int types_optional,
1276 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001277{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001278 int evaluate = evalarg != NULL
1279 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001280 garray_T newargs;
1281 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001282 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001283 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001284 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001286 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001288 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001289 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001290 char_u *s;
1291 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001292 int *old_eval_lavars = eval_lavars_used;
1293 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001294 char_u *tofree1 = NULL;
1295 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001296 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001297 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001298 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001299
1300 if (equal_arrow && !in_vim9script())
1301 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001302
1303 ga_init(&newargs);
1304 ga_init(&newlines);
1305
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001306 // First, check if this is really a lambda expression. "->" or "=>" must
1307 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001308 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001309 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001310 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001311 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001312 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001313 {
1314 if (types_optional)
1315 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001316 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001319 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001320 if (evaluate)
1321 pnewargs = &newargs;
1322 else
1323 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001324 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001325 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001326 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001327 &varargs, &default_args,
1328 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001329 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001330 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001331 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001332 {
1333 if (types_optional)
1334 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001335 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001336 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001337 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001338 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001339
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001340 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1341 if (ret_type != NULL)
1342 {
1343 ret_type = vim_strsave(ret_type);
1344 tofree2 = ret_type;
1345 }
1346
Bram Moolenaare38eab22019-12-05 21:50:01 +01001347 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001348 if (evaluate)
1349 eval_lavars_used = &eval_lavars;
1350
Bram Moolenaar65c44152020-12-24 15:14:01 +01001351 *arg = skipwhite_and_linebreak(*arg, evalarg);
1352
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001353 // Recognize "{" as the start of a function body.
1354 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001355 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001356 if (evalarg == NULL)
1357 // cannot happen?
1358 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001359 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1360 types_optional ? &argtypes : NULL, varargs,
1361 &default_args, ret_type) == FAIL)
1362 goto errret;
1363 goto theend;
1364 }
1365 if (default_args.ga_len > 0)
1366 {
1367 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001368 goto errret;
1369 }
1370
Bram Moolenaare38eab22019-12-05 21:50:01 +01001371 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001372 start = *arg;
1373 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001374 if (ret == FAIL)
1375 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001376 if (evalarg != NULL)
1377 {
1378 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001379 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001380 evalarg->eval_tofree = NULL;
1381 }
1382
Bram Moolenaar65c44152020-12-24 15:14:01 +01001383 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001384 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001385 *arg = skipwhite_and_linebreak(*arg, evalarg);
1386 if (**arg != '}')
1387 {
1388 semsg(_("E451: Expected }: %s"), *arg);
1389 goto errret;
1390 }
1391 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001392 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001393
1394 if (evaluate)
1395 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001396 int len;
1397 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001398 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001399 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001400 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001401
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001402 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001403 if (fp == NULL)
1404 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001405 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001406 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001407 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001408 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001410 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1411 if (ga_grow(&newlines, 1) == FAIL)
1412 goto errret;
1413
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001414 // If there are line breaks, we need to split up the string.
1415 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001416 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001417 line_end = end;
1418
1419 // Add "return " before the expression (or the first line).
1420 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001421 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422 if (p == NULL)
1423 goto errret;
1424 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1425 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001426 vim_strncpy(p + 7, start, line_end - start);
1427
1428 if (line_end != end)
1429 {
1430 // Add more lines, split by line breaks. Thus is used when a
1431 // lambda with { cmds } is encountered.
1432 while (*line_end == '\n')
1433 {
1434 if (ga_grow(&newlines, 1) == FAIL)
1435 goto errret;
1436 start = line_end + 1;
1437 line_end = vim_strchr(start, '\n');
1438 if (line_end == NULL)
1439 line_end = end;
1440 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1441 vim_strnsave(start, line_end - start);
1442 }
1443 }
1444
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001445 if (strstr((char *)p + 7, "a:") == NULL)
1446 // No a: variables are used for sure.
1447 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448
1449 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001450 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001452 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001453 if (types_optional)
1454 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001455 if (parse_argument_types(fp, &argtypes,
1456 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001457 goto errret;
1458 if (ret_type != NULL)
1459 {
1460 fp->uf_ret_type = parse_type(&ret_type,
1461 &fp->uf_type_list, TRUE);
1462 if (fp->uf_ret_type == NULL)
1463 goto errret;
1464 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001465 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001466 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001467 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001468
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001469 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001470 if (current_funccal != NULL && eval_lavars)
1471 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001472 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001473 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001474 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001475 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476
1477#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478 if (prof_def_func())
1479 func_do_profile(fp);
1480#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001481 if (sandbox)
1482 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001483 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001484 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1485 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001486 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001488 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001489 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001490
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001491 function_using_block_scopes(fp, evalarg->eval_cstack);
1492
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001493 pt->pt_func = fp;
1494 pt->pt_refcount = 1;
1495 rettv->vval.v_partial = pt;
1496 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001497
1498 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001501theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001502 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001503 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001504 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001505 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001506 vim_free(tofree1);
1507 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001508 if (types_optional)
1509 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001510
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 return OK;
1512
1513errret:
1514 ga_clear_strings(&newargs);
1515 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001516 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001517 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001518 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001519 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001520 if (fp != NULL)
1521 vim_free(fp->uf_arg_types);
1522 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001524 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001525 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001526 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001527 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001528 vim_free(tofree1);
1529 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001530 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 return FAIL;
1532}
1533
1534/*
1535 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1536 * name it contains, otherwise return "name".
1537 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1538 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001539 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1540 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001541 */
1542 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001543deref_func_name(
1544 char_u *name,
1545 int *lenp,
1546 partial_T **partialp,
1547 type_T **type,
1548 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549{
1550 dictitem_T *v;
1551 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001552 char_u *s = NULL;
1553 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554
1555 if (partialp != NULL)
1556 *partialp = NULL;
1557
1558 cc = name[*lenp];
1559 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001560
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001561 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001563 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001565 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001567 if (v->di_tv.vval.v_string == NULL)
1568 {
1569 *lenp = 0;
1570 return (char_u *)""; // just in case
1571 }
1572 s = v->di_tv.vval.v_string;
1573 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001576 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001578 partial_T *pt = v->di_tv.vval.v_partial;
1579
1580 if (pt == NULL)
1581 {
1582 *lenp = 0;
1583 return (char_u *)""; // just in case
1584 }
1585 if (partialp != NULL)
1586 *partialp = pt;
1587 s = partial_name(pt);
1588 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001590
1591 if (s != NULL)
1592 {
1593 if (type != NULL && ht == get_script_local_ht())
1594 {
Bram Moolenaarc967d572021-07-08 21:38:50 +02001595 svar_T *sv = find_typval_in_script(&v->di_tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001596
1597 if (sv != NULL)
1598 *type = sv->sv_type;
1599 }
1600 return s;
1601 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001602 }
1603
1604 return name;
1605}
1606
1607/*
1608 * Give an error message with a function name. Handle <SNR> things.
1609 * "ermsg" is to be passed without translation, use N_() instead of _().
1610 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001611 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612emsg_funcname(char *ermsg, char_u *name)
1613{
1614 char_u *p;
1615
1616 if (*name == K_SPECIAL)
1617 p = concat_str((char_u *)"<SNR>", name + 3);
1618 else
1619 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001620 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621 if (p != name)
1622 vim_free(p);
1623}
1624
1625/*
1626 * Allocate a variable for the result of a function.
1627 * Return OK or FAIL.
1628 */
1629 int
1630get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001631 char_u *name, // name of the function
1632 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001634 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001635 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001636 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637{
1638 char_u *argp;
1639 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001640 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1641 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001642 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643
1644 /*
1645 * Get the arguments.
1646 */
1647 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001648 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1649 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001651 // skip the '(' or ',' and possibly line breaks
1652 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1653
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 if (*argp == ')' || *argp == ',' || *argp == NUL)
1655 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001656 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 {
1658 ret = FAIL;
1659 break;
1660 }
1661 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001662 // The comma should come right after the argument, but this wasn't
1663 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001664 if (vim9script)
1665 {
1666 if (*argp != ',' && *skipwhite(argp) == ',')
1667 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001668 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001669 ret = FAIL;
1670 break;
1671 }
1672 }
1673 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001674 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 if (*argp != ',')
1676 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001677 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1678 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001679 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001680 ret = FAIL;
1681 break;
1682 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001684 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 if (*argp == ')')
1686 ++argp;
1687 else
1688 ret = FAIL;
1689
1690 if (ret == OK)
1691 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001692 int i = 0;
1693 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694
1695 if (get_vim_var_nr(VV_TESTING))
1696 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001697 // Prepare for calling test_garbagecollect_now(), need to know
1698 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001699 if (funcargs.ga_itemsize == 0)
1700 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1701 for (i = 0; i < argcount; ++i)
1702 if (ga_grow(&funcargs, 1) == OK)
1703 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1704 &argvars[i];
1705 }
1706
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001707 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001708 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001709 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001710 // An error in a builtin function does not return FAIL, but we do
1711 // want to abort further processing if an error was given.
1712 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001713 clear_tv(rettv);
1714 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715
1716 funcargs.ga_len -= i;
1717 }
1718 else if (!aborting())
1719 {
1720 if (argcount == MAX_FUNC_ARGS)
1721 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1722 else
1723 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1724 }
1725
1726 while (--argcount >= 0)
1727 clear_tv(&argvars[argcount]);
1728
Bram Moolenaar8294d492020-08-10 22:40:56 +02001729 if (in_vim9script())
1730 *arg = argp;
1731 else
1732 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 return ret;
1734}
1735
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736/*
1737 * Return TRUE if "p" starts with "<SID>" or "s:".
1738 * Only works if eval_fname_script() returned non-zero for "p"!
1739 */
1740 static int
1741eval_fname_sid(char_u *p)
1742{
1743 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1744}
1745
1746/*
1747 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1748 * Change <SNR>123_name() to K_SNR 123_name().
1749 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1750 * (slow).
1751 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001752 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1754{
1755 int llen;
1756 char_u *fname;
1757 int i;
1758
1759 llen = eval_fname_script(name);
1760 if (llen > 0)
1761 {
1762 fname_buf[0] = K_SPECIAL;
1763 fname_buf[1] = KS_EXTRA;
1764 fname_buf[2] = (int)KE_SNR;
1765 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001766 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001768 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001769 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001770 else
1771 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001772 sprintf((char *)fname_buf + 3, "%ld_",
1773 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774 i = (int)STRLEN(fname_buf);
1775 }
1776 }
1777 if (i + STRLEN(name + llen) < FLEN_FIXED)
1778 {
1779 STRCPY(fname_buf + i, name + llen);
1780 fname = fname_buf;
1781 }
1782 else
1783 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001784 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001786 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 else
1788 {
1789 *tofree = fname;
1790 mch_memmove(fname, fname_buf, (size_t)i);
1791 STRCPY(fname + i, name + llen);
1792 }
1793 }
1794 }
1795 else
1796 fname = name;
1797 return fname;
1798}
1799
1800/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001801 * Find a function "name" in script "sid".
1802 */
1803 static ufunc_T *
1804find_func_with_sid(char_u *name, int sid)
1805{
1806 hashitem_T *hi;
1807 char_u buffer[200];
1808
1809 buffer[0] = K_SPECIAL;
1810 buffer[1] = KS_EXTRA;
1811 buffer[2] = (int)KE_SNR;
1812 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1813 (long)sid, name);
1814 hi = hash_find(&func_hashtab, buffer);
1815 if (!HASHITEM_EMPTY(hi))
1816 return HI2UF(hi);
1817
1818 return NULL;
1819}
1820
1821/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001823 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001824 * Return NULL for unknown function.
1825 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001826 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001827find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828{
1829 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001830 ufunc_T *func;
1831 imported_T *imported;
1832
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001833 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001834 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001835 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001836 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001837 int find_script_local = in_vim9script()
1838 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001839
Bram Moolenaar95006e32020-08-29 17:47:08 +02001840 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001841 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001842 // Find script-local function before global one.
1843 func = find_func_with_sid(name, current_sctx.sc_sid);
1844 if (func != NULL)
1845 return func;
1846 }
1847
Bram Moolenaarefa94442020-08-08 22:16:00 +02001848 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001849 && name[1] == KS_EXTRA
1850 && name[2] == KE_SNR)
1851 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001852 // Caller changes s: to <SNR>99_name.
1853
1854 after_script = name + 3;
1855 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001856 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001857 ++after_script;
1858 else
1859 after_script = NULL;
1860 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001861 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001862 {
1863 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001864 if (after_script != NULL && sid != current_sctx.sc_sid)
1865 imported = find_imported_in_script(after_script, 0, sid);
1866 else
1867 imported = find_imported(after_script == NULL
1868 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001869 if (imported != NULL && imported->imp_funcname != NULL)
1870 {
1871 hi = hash_find(&func_hashtab, imported->imp_funcname);
1872 if (!HASHITEM_EMPTY(hi))
1873 return HI2UF(hi);
1874 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001875 }
1876 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877
Bram Moolenaara26b9702020-04-18 19:53:28 +02001878 hi = hash_find(&func_hashtab,
1879 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001880 if (!HASHITEM_EMPTY(hi))
1881 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001882
1883 return NULL;
1884}
1885
1886/*
1887 * Find a function by name, return pointer to it in ufuncs.
1888 * "cctx" is passed in a :def function to find imported functions.
1889 * Return NULL for unknown or dead function.
1890 */
1891 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001892find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001893{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001894 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001895
1896 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1897 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001898 return NULL;
1899}
1900
1901/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001902 * Return TRUE if "ufunc" is a global function.
1903 */
1904 int
1905func_is_global(ufunc_T *ufunc)
1906{
1907 return ufunc->uf_name[0] != K_SPECIAL;
1908}
1909
1910/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001911 * Copy the function name of "fp" to buffer "buf".
1912 * "buf" must be able to hold the function name plus three bytes.
1913 * Takes care of script-local function names.
1914 */
1915 static void
1916cat_func_name(char_u *buf, ufunc_T *fp)
1917{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001918 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 {
1920 STRCPY(buf, "<SNR>");
1921 STRCAT(buf, fp->uf_name + 3);
1922 }
1923 else
1924 STRCPY(buf, fp->uf_name);
1925}
1926
1927/*
1928 * Add a number variable "name" to dict "dp" with value "nr".
1929 */
1930 static void
1931add_nr_var(
1932 dict_T *dp,
1933 dictitem_T *v,
1934 char *name,
1935 varnumber_T nr)
1936{
1937 STRCPY(v->di_key, name);
1938 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1939 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1940 v->di_tv.v_type = VAR_NUMBER;
1941 v->di_tv.v_lock = VAR_FIXED;
1942 v->di_tv.vval.v_number = nr;
1943}
1944
1945/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001946 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001948 static void
1949free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001951 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001952
1953 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1954 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001955 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001956
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001957 // When garbage collecting a funccall_T may be freed before the
1958 // function that references it, clear its uf_scoped field.
1959 // The function may have been redefined and point to another
1960 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001961 if (fp != NULL && fp->uf_scoped == fc)
1962 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001963 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001964 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001966 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967 vim_free(fc);
1968}
1969
1970/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001971 * Free "fc" and what it contains.
1972 * Can be called only when "fc" is kept beyond the period of it called,
1973 * i.e. after cleanup_function_call(fc).
1974 */
1975 static void
1976free_funccal_contents(funccall_T *fc)
1977{
1978 listitem_T *li;
1979
1980 // Free all l: variables.
1981 vars_clear(&fc->l_vars.dv_hashtab);
1982
1983 // Free all a: variables.
1984 vars_clear(&fc->l_avars.dv_hashtab);
1985
1986 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001987 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001988 clear_tv(&li->li_tv);
1989
1990 free_funccal(fc);
1991}
1992
1993/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001994 * Handle the last part of returning from a function: free the local hashtable.
1995 * Unless it is still in use by a closure.
1996 */
1997 static void
1998cleanup_function_call(funccall_T *fc)
1999{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002000 int may_free_fc = fc->fc_refcount <= 0;
2001 int free_fc = TRUE;
2002
Bram Moolenaar6914c642017-04-01 21:21:30 +02002003 current_funccal = fc->caller;
2004
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002005 // Free all l: variables if not referred.
2006 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2007 vars_clear(&fc->l_vars.dv_hashtab);
2008 else
2009 free_fc = FALSE;
2010
2011 // If the a:000 list and the l: and a: dicts are not referenced and
2012 // there is no closure using it, we can free the funccall_T and what's
2013 // in it.
2014 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2015 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002016 else
2017 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002018 int todo;
2019 hashitem_T *hi;
2020 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002021
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002022 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002023
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002024 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002025 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2026 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2027 {
2028 if (!HASHITEM_EMPTY(hi))
2029 {
2030 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002031 di = HI2DI(hi);
2032 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002033 }
2034 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002035 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002036
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002037 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2038 fc->l_varlist.lv_first = NULL;
2039 else
2040 {
2041 listitem_T *li;
2042
2043 free_fc = FALSE;
2044
2045 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002046 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002047 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002048 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002049
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002050 if (free_fc)
2051 free_funccal(fc);
2052 else
2053 {
2054 static int made_copy = 0;
2055
2056 // "fc" is still in use. This can happen when returning "a:000",
2057 // assigning "l:" to a global variable or defining a closure.
2058 // Link "fc" in the list for garbage collection later.
2059 fc->caller = previous_funccal;
2060 previous_funccal = fc;
2061
2062 if (want_garbage_collect)
2063 // If garbage collector is ready, clear count.
2064 made_copy = 0;
2065 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002066 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002067 // We have made a lot of copies, worth 4 Mbyte. This can happen
2068 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002069 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002070 // too much memory.
2071 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002072 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002073 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002074 }
2075}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002076
2077/*
2078 * There are two kinds of function names:
2079 * 1. ordinary names, function defined with :function or :def
2080 * 2. numbered functions and lambdas
2081 * For the first we only count the name stored in func_hashtab as a reference,
2082 * using function() does not count as a reference, because the function is
2083 * looked up by name.
2084 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002085 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002086func_name_refcount(char_u *name)
2087{
2088 return isdigit(*name) || *name == '<';
2089}
2090
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002091/*
2092 * Unreference "fc": decrement the reference count and free it when it
2093 * becomes zero. "fp" is detached from "fc".
2094 * When "force" is TRUE we are exiting.
2095 */
2096 static void
2097funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2098{
2099 funccall_T **pfc;
2100 int i;
2101
2102 if (fc == NULL)
2103 return;
2104
2105 if (--fc->fc_refcount <= 0 && (force || (
2106 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2107 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2108 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2109 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2110 {
2111 if (fc == *pfc)
2112 {
2113 *pfc = fc->caller;
2114 free_funccal_contents(fc);
2115 return;
2116 }
2117 }
2118 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2119 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2120 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2121}
2122
2123/*
2124 * Remove the function from the function hashtable. If the function was
2125 * deleted while it still has references this was already done.
2126 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2127 */
2128 static int
2129func_remove(ufunc_T *fp)
2130{
2131 hashitem_T *hi;
2132
2133 // Return if it was already virtually deleted.
2134 if (fp->uf_flags & FC_DEAD)
2135 return FALSE;
2136
2137 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2138 if (!HASHITEM_EMPTY(hi))
2139 {
2140 // When there is a def-function index do not actually remove the
2141 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002142 // Do remove it when it's a copy.
2143 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002144 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002145 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002146 return FALSE;
2147 }
2148 hash_remove(&func_hashtab, hi);
2149 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002150 return TRUE;
2151 }
2152 return FALSE;
2153}
2154
2155 static void
2156func_clear_items(ufunc_T *fp)
2157{
2158 ga_clear_strings(&(fp->uf_args));
2159 ga_clear_strings(&(fp->uf_def_args));
2160 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002161 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002162 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002163 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002164 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002165
2166 // Increment the refcount of this function to avoid it being freed
2167 // recursively when the partial is freed.
2168 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002169 partial_unref(fp->uf_partial);
2170 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002171 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002172
2173#ifdef FEAT_LUA
2174 if (fp->uf_cb_free != NULL)
2175 {
2176 fp->uf_cb_free(fp->uf_cb_state);
2177 fp->uf_cb_free = NULL;
2178 }
2179
2180 fp->uf_cb_state = NULL;
2181 fp->uf_cb = NULL;
2182#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002183#ifdef FEAT_PROFILE
2184 VIM_CLEAR(fp->uf_tml_count);
2185 VIM_CLEAR(fp->uf_tml_total);
2186 VIM_CLEAR(fp->uf_tml_self);
2187#endif
2188}
2189
2190/*
2191 * Free all things that a function contains. Does not free the function
2192 * itself, use func_free() for that.
2193 * When "force" is TRUE we are exiting.
2194 */
2195 static void
2196func_clear(ufunc_T *fp, int force)
2197{
2198 if (fp->uf_cleared)
2199 return;
2200 fp->uf_cleared = TRUE;
2201
2202 // clear this function
2203 func_clear_items(fp);
2204 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002205 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002206}
2207
2208/*
2209 * Free a function and remove it from the list of functions. Does not free
2210 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002211 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002212 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002213 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002214 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002215func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002216{
2217 // Only remove it when not done already, otherwise we would remove a newer
2218 // version of the function with the same name.
2219 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2220 func_remove(fp);
2221
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002222 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002223 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002224 if (fp->uf_dfunc_idx > 0)
2225 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002226 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002227 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002228 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002229 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002230 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002231}
2232
2233/*
2234 * Free all things that a function contains and free the function itself.
2235 * When "force" is TRUE we are exiting.
2236 */
2237 static void
2238func_clear_free(ufunc_T *fp, int force)
2239{
2240 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002241 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2242 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002243 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002244 else
2245 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002246}
2247
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002248/*
2249 * Copy already defined function "lambda" to a new function with name "global".
2250 * This is for when a compiled function defines a global function.
2251 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002252 int
2253copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002254{
2255 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002256 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002257
2258 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002259 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002260 semsg(_(e_lambda_function_not_found_str), lambda);
2261 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002262 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002263
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002264 fp = find_func(global, TRUE, NULL);
2265 if (fp != NULL)
2266 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002267 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002268 semsg(_(e_funcexts), global);
2269 return FAIL;
2270 }
2271
2272 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2273 if (fp == NULL)
2274 return FAIL;
2275
2276 fp->uf_varargs = ufunc->uf_varargs;
2277 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2278 fp->uf_def_status = ufunc->uf_def_status;
2279 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2280 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2281 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2282 == FAIL
2283 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2284 goto failed;
2285
2286 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2287 : vim_strsave(ufunc->uf_name_exp);
2288 if (ufunc->uf_arg_types != NULL)
2289 {
2290 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2291 if (fp->uf_arg_types == NULL)
2292 goto failed;
2293 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2294 sizeof(type_T *) * fp->uf_args.ga_len);
2295 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002296 if (ufunc->uf_va_name != NULL)
2297 {
2298 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2299 if (fp->uf_va_name == NULL)
2300 goto failed;
2301 }
2302 fp->uf_ret_type = ufunc->uf_ret_type;
2303
2304 fp->uf_refcount = 1;
2305 STRCPY(fp->uf_name, global);
2306 hash_add(&func_hashtab, UF2HIKEY(fp));
2307
2308 // the referenced dfunc_T is now used one more time
2309 link_def_function(fp);
2310
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002311 // Create a partial to store the context of the function where it was
2312 // instantiated. Only needs to be done once. Do this on the original
2313 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002314 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2315 {
2316 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2317
2318 if (pt == NULL)
2319 goto failed;
2320 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002321 {
2322 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002323 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002324 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002325 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002326 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002327 }
2328
2329 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002330
2331failed:
2332 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002333 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002334}
2335
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002336static int funcdepth = 0;
2337
2338/*
2339 * Increment the function call depth count.
2340 * Return FAIL when going over 'maxfuncdepth'.
2341 * Otherwise return OK, must call funcdepth_decrement() later!
2342 */
2343 int
2344funcdepth_increment(void)
2345{
2346 if (funcdepth >= p_mfd)
2347 {
2348 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2349 return FAIL;
2350 }
2351 ++funcdepth;
2352 return OK;
2353}
2354
2355 void
2356funcdepth_decrement(void)
2357{
2358 --funcdepth;
2359}
2360
2361/*
2362 * Get the current function call depth.
2363 */
2364 int
2365funcdepth_get(void)
2366{
2367 return funcdepth;
2368}
2369
2370/*
2371 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002372 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002373 * times as funcdepth_increment().
2374 */
2375 void
2376funcdepth_restore(int depth)
2377{
2378 funcdepth = depth;
2379}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002380
2381/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 * Call a user function.
2383 */
2384 static void
2385call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002386 ufunc_T *fp, // pointer to function
2387 int argcount, // nr of args
2388 typval_T *argvars, // arguments
2389 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002390 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002391 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002393 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002394 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002395 funccall_T *fc;
2396 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002397 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002399 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002400 int i;
2401 int ai;
2402 int islambda = FALSE;
2403 char_u numbuf[NUMBUFLEN];
2404 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002405 typval_T *tv_to_free[MAX_FUNC_ARGS];
2406 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002408 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002410 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411
Bram Moolenaarb2049902021-01-24 12:53:53 +01002412#ifdef FEAT_PROFILE
2413 CLEAR_FIELD(profile_info);
2414#endif
2415
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002416 // If depth of calling is getting too high, don't execute the function.
2417 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002419 rettv->v_type = VAR_NUMBER;
2420 rettv->vval.v_number = -1;
2421 return;
2422 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423
Bram Moolenaare38eab22019-12-05 21:50:01 +01002424 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002426 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002427 if (fc == NULL)
2428 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 fc->caller = current_funccal;
2430 current_funccal = fc;
2431 fc->func = fp;
2432 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002434 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002435 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2436 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002437 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002438 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002439 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002441 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002442 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002443#ifdef FEAT_PROFILE
2444 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2445#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002446 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002447#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002448 if (do_profiling == PROF_YES)
2449 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002450#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002451 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002452 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002453#ifdef FEAT_PROFILE
2454 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002455 || (caller != NULL && caller->uf_profiling)))
2456 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002457#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002458 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002459 free_funccal(fc);
2460 return;
2461 }
2462
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2464 islambda = TRUE;
2465
2466 /*
2467 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2468 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2469 * each argument variable and saves a lot of time.
2470 */
2471 /*
2472 * Init l: variables.
2473 */
2474 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2475 if (selfdict != NULL)
2476 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002477 // Set l:self to "selfdict". Use "name" to avoid a warning from
2478 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 v = &fc->fixvar[fixvar_idx++].var;
2480 name = v->di_key;
2481 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002482 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2484 v->di_tv.v_type = VAR_DICT;
2485 v->di_tv.v_lock = 0;
2486 v->di_tv.vval.v_dict = selfdict;
2487 ++selfdict->dv_refcount;
2488 }
2489
2490 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002491 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002492 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 * Set a:000 to a list with room for the "..." arguments.
2494 */
2495 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002496 if ((fp->uf_flags & FC_NOARGS) == 0)
2497 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002498 (varnumber_T)(argcount >= fp->uf_args.ga_len
2499 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002500 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002501 if ((fp->uf_flags & FC_NOARGS) == 0)
2502 {
2503 // Use "name" to avoid a warning from some compiler that checks the
2504 // destination size.
2505 v = &fc->fixvar[fixvar_idx++].var;
2506 name = v->di_key;
2507 STRCPY(name, "000");
2508 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2509 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2510 v->di_tv.v_type = VAR_LIST;
2511 v->di_tv.v_lock = VAR_FIXED;
2512 v->di_tv.vval.v_list = &fc->l_varlist;
2513 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002514 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2516 fc->l_varlist.lv_lock = VAR_FIXED;
2517
2518 /*
2519 * Set a:firstline to "firstline" and a:lastline to "lastline".
2520 * Set a:name to named arguments.
2521 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002522 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002524 if ((fp->uf_flags & FC_NOARGS) == 0)
2525 {
2526 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002527 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002528 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002529 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002530 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002531 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532 {
2533 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002534 typval_T def_rettv;
2535 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536
2537 ai = i - fp->uf_args.ga_len;
2538 if (ai < 0)
2539 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002540 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 name = FUNCARG(fp, i);
2542 if (islambda)
2543 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002544
2545 // evaluate named argument default expression
2546 isdefault = ai + fp->uf_def_args.ga_len >= 0
2547 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2548 && argvars[i].vval.v_number == VVAL_NONE));
2549 if (isdefault)
2550 {
2551 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002552
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002553 def_rettv.v_type = VAR_NUMBER;
2554 def_rettv.vval.v_number = -1;
2555
2556 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2557 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002558 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002559 {
2560 default_arg_err = 1;
2561 break;
2562 }
2563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 }
2565 else
2566 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002567 if ((fp->uf_flags & FC_NOARGS) != 0)
2568 // Bail out if no a: arguments used (in lambda).
2569 break;
2570
Bram Moolenaare38eab22019-12-05 21:50:01 +01002571 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572 sprintf((char *)numbuf, "%d", ai + 1);
2573 name = numbuf;
2574 }
2575 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2576 {
2577 v = &fc->fixvar[fixvar_idx++].var;
2578 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002579 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002580 }
2581 else
2582 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002583 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584 if (v == NULL)
2585 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002586 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002589 // Note: the values are copied directly to avoid alloc/free.
2590 // "argvars" must have VAR_FIXED for v_lock.
2591 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592 v->di_tv.v_lock = VAR_FIXED;
2593
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002594 if (isdefault)
2595 // Need to free this later, no matter where it's stored.
2596 tv_to_free[tv_to_free_len++] = &v->di_tv;
2597
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002598 if (addlocal)
2599 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002600 // Named arguments should be accessed without the "a:" prefix in
2601 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002602 copy_tv(&v->di_tv, &v->di_tv);
2603 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002604 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002605 else
2606 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607
2608 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2609 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002610 listitem_T *li = &fc->l_listitems[ai];
2611
2612 li->li_tv = argvars[i];
2613 li->li_tv.v_lock = VAR_FIXED;
2614 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 }
2616 }
2617
Bram Moolenaare38eab22019-12-05 21:50:01 +01002618 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002620
2621 if (fp->uf_flags & FC_SANDBOX)
2622 {
2623 using_sandbox = TRUE;
2624 ++sandbox;
2625 }
2626
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002627 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002628 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002629 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002631 ++no_wait_return;
2632 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002634 smsg(_("calling %s"), SOURCING_NAME);
2635 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002637 char_u buf[MSG_BUF_LEN];
2638 char_u numbuf2[NUMBUFLEN];
2639 char_u *tofree;
2640 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002641
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002642 msg_puts("(");
2643 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002645 if (i > 0)
2646 msg_puts(", ");
2647 if (argvars[i].v_type == VAR_NUMBER)
2648 msg_outnum((long)argvars[i].vval.v_number);
2649 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002651 // Do not want errors such as E724 here.
2652 ++emsg_off;
2653 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2654 --emsg_off;
2655 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002657 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002659 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2660 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002662 msg_puts((char *)s);
2663 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 }
2665 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002667 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002669 msg_puts("\n"); // don't overwrite this either
2670
2671 verbose_leave_scroll();
2672 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 }
2674#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002675 if (do_profiling == PROF_YES)
2676 profile_may_start_func(&profile_info, fp,
2677 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678#endif
2679
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002680 save_current_sctx = current_sctx;
2681 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 save_did_emsg = did_emsg;
2683 did_emsg = FALSE;
2684
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002685 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2686 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002687 else if (islambda)
2688 {
2689 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2690
2691 // A Lambda always has the command "return {expr}". It is much faster
2692 // to evaluate {expr} directly.
2693 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002694 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002695 --ex_nesting_level;
2696 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002697 else
2698 // call do_cmdline() to execute the lines
2699 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2701
2702 --RedrawingDisabled;
2703
Bram Moolenaare38eab22019-12-05 21:50:01 +01002704 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2706 {
2707 clear_tv(rettv);
2708 rettv->v_type = VAR_NUMBER;
2709 rettv->vval.v_number = -1;
2710 }
2711
2712#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002713 if (do_profiling == PROF_YES)
2714 {
2715 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2716
2717 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2718 profile_may_end_func(&profile_info, fp, caller);
2719 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720#endif
2721
Bram Moolenaare38eab22019-12-05 21:50:01 +01002722 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 if (p_verbose >= 12)
2724 {
2725 ++no_wait_return;
2726 verbose_enter_scroll();
2727
2728 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002729 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002731 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 (long)fc->rettv->vval.v_number);
2733 else
2734 {
2735 char_u buf[MSG_BUF_LEN];
2736 char_u numbuf2[NUMBUFLEN];
2737 char_u *tofree;
2738 char_u *s;
2739
Bram Moolenaare38eab22019-12-05 21:50:01 +01002740 // The value may be very long. Skip the middle part, so that we
2741 // have some idea how it starts and ends. smsg() would always
2742 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 ++emsg_off;
2744 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2745 --emsg_off;
2746 if (s != NULL)
2747 {
2748 if (vim_strsize(s) > MSG_BUF_CLEN)
2749 {
2750 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2751 s = buf;
2752 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002753 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 vim_free(tofree);
2755 }
2756 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002757 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758
2759 verbose_leave_scroll();
2760 --no_wait_return;
2761 }
2762
Bram Moolenaare31ee862020-01-07 20:59:34 +01002763 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002764 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002765 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766#ifdef FEAT_PROFILE
2767 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002768 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002770 if (using_sandbox)
2771 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002773 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 {
2775 ++no_wait_return;
2776 verbose_enter_scroll();
2777
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002778 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002779 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780
2781 verbose_leave_scroll();
2782 --no_wait_return;
2783 }
2784
2785 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002786 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002787 for (i = 0; i < tv_to_free_len; ++i)
2788 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002789 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790}
2791
2792/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002793 * Check the argument count for user function "fp".
2794 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2795 */
2796 int
2797check_user_func_argcount(ufunc_T *fp, int argcount)
2798{
2799 int regular_args = fp->uf_args.ga_len;
2800
2801 if (argcount < regular_args - fp->uf_def_args.ga_len)
2802 return FCERR_TOOFEW;
2803 else if (!has_varargs(fp) && argcount > regular_args)
2804 return FCERR_TOOMANY;
2805 return FCERR_UNKNOWN;
2806}
2807
2808/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002809 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002810 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002811 int
2812call_user_func_check(
2813 ufunc_T *fp,
2814 int argcount,
2815 typval_T *argvars,
2816 typval_T *rettv,
2817 funcexe_T *funcexe,
2818 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002819{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002820 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002821
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002822 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2823 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002824 error = check_user_func_argcount(fp, argcount);
2825 if (error != FCERR_UNKNOWN)
2826 return error;
2827 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002828 error = FCERR_DICT;
2829 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002830 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002831 int did_save_redo = FALSE;
2832 save_redo_T save_redo;
2833
2834 /*
2835 * Call the user function.
2836 * Save and restore search patterns, script variables and
2837 * redo buffer.
2838 */
2839 save_search_patterns();
2840 if (!ins_compl_active())
2841 {
2842 saveRedobuff(&save_redo);
2843 did_save_redo = TRUE;
2844 }
2845 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002846 call_user_func(fp, argcount, argvars, rettv, funcexe,
2847 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002848 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2849 // Function was unreferenced while being used, free it now.
2850 func_clear_free(fp, FALSE);
2851 if (did_save_redo)
2852 restoreRedobuff(&save_redo);
2853 restore_search_patterns();
2854 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002855 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002856 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002857}
2858
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002859static funccal_entry_T *funccal_stack = NULL;
2860
2861/*
2862 * Save the current function call pointer, and set it to NULL.
2863 * Used when executing autocommands and for ":source".
2864 */
2865 void
2866save_funccal(funccal_entry_T *entry)
2867{
2868 entry->top_funccal = current_funccal;
2869 entry->next = funccal_stack;
2870 funccal_stack = entry;
2871 current_funccal = NULL;
2872}
2873
2874 void
2875restore_funccal(void)
2876{
2877 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002878 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002879 else
2880 {
2881 current_funccal = funccal_stack->top_funccal;
2882 funccal_stack = funccal_stack->next;
2883 }
2884}
2885
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002886 funccall_T *
2887get_current_funccal(void)
2888{
2889 return current_funccal;
2890}
2891
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002892/*
2893 * Mark all functions of script "sid" as deleted.
2894 */
2895 void
2896delete_script_functions(int sid)
2897{
2898 hashitem_T *hi;
2899 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002900 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002901 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002902 size_t len;
2903
2904 buf[0] = K_SPECIAL;
2905 buf[1] = KS_EXTRA;
2906 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002907 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002908 len = STRLEN(buf);
2909
Bram Moolenaarce658352020-07-31 23:47:12 +02002910 while (todo > 0)
2911 {
2912 todo = func_hashtab.ht_used;
2913 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2914 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002915 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002916 fp = HI2UF(hi);
2917 if (STRNCMP(fp->uf_name, buf, len) == 0)
2918 {
2919 int changed = func_hashtab.ht_changed;
2920
2921 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002922
2923 if (fp->uf_calls > 0)
2924 {
2925 // Function is executing, don't free it but do remove
2926 // it from the hashtable.
2927 if (func_remove(fp))
2928 fp->uf_refcount--;
2929 }
2930 else
2931 {
2932 func_clear(fp, TRUE);
2933 // When clearing a function another function can be
2934 // cleared as a side effect. When that happens start
2935 // over.
2936 if (changed != func_hashtab.ht_changed)
2937 break;
2938 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002939 }
2940 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002941 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002942 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002943}
2944
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002945#if defined(EXITFREE) || defined(PROTO)
2946 void
2947free_all_functions(void)
2948{
2949 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002950 ufunc_T *fp;
2951 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002952 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002953 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954
Bram Moolenaare38eab22019-12-05 21:50:01 +01002955 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002956 while (current_funccal != NULL)
2957 {
2958 clear_tv(current_funccal->rettv);
2959 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002960 if (current_funccal == NULL && funccal_stack != NULL)
2961 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002962 }
2963
Bram Moolenaare38eab22019-12-05 21:50:01 +01002964 // First clear what the functions contain. Since this may lower the
2965 // reference count of a function, it may also free a function and change
2966 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002967 while (todo > 0)
2968 {
2969 todo = func_hashtab.ht_used;
2970 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2971 if (!HASHITEM_EMPTY(hi))
2972 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002973 // clear the def function index now
2974 fp = HI2UF(hi);
2975 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002976 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002977
Bram Moolenaare38eab22019-12-05 21:50:01 +01002978 // Only free functions that are not refcounted, those are
2979 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002980 if (func_name_refcount(fp->uf_name))
2981 ++skipped;
2982 else
2983 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002984 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002985 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002986 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002987 {
2988 skipped = 0;
2989 break;
2990 }
2991 }
2992 --todo;
2993 }
2994 }
2995
Bram Moolenaare38eab22019-12-05 21:50:01 +01002996 // Now actually free the functions. Need to start all over every time,
2997 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002998 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002999 while (func_hashtab.ht_used > skipped)
3000 {
3001 todo = func_hashtab.ht_used;
3002 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 if (!HASHITEM_EMPTY(hi))
3004 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003005 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003006 // Only free functions that are not refcounted, those are
3007 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003008 fp = HI2UF(hi);
3009 if (func_name_refcount(fp->uf_name))
3010 ++skipped;
3011 else
3012 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003013 if (func_free(fp, FALSE) == OK)
3014 {
3015 skipped = 0;
3016 break;
3017 }
3018 // did not actually free it
3019 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003020 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003022 }
3023 if (skipped == 0)
3024 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003025
3026 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027}
3028#endif
3029
3030/*
3031 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003032 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 * "len" is the length of "name", or -1 for NUL terminated.
3034 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003035 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003036builtin_function(char_u *name, int len)
3037{
3038 char_u *p;
3039
Bram Moolenaara26b9702020-04-18 19:53:28 +02003040 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 return FALSE;
3042 p = vim_strchr(name, AUTOLOAD_CHAR);
3043 return p == NULL || (len > 0 && p > name + len);
3044}
3045
3046 int
3047func_call(
3048 char_u *name,
3049 typval_T *args,
3050 partial_T *partial,
3051 dict_T *selfdict,
3052 typval_T *rettv)
3053{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003054 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 listitem_T *item;
3056 typval_T argv[MAX_FUNC_ARGS + 1];
3057 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003058 int r = 0;
3059
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003060 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003061 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 {
3063 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3064 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003065 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 break;
3067 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003068 // Make a copy of each argument. This is needed to be able to set
3069 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003070 copy_tv(&item->li_tv, &argv[argc++]);
3071 }
3072
3073 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003074 {
3075 funcexe_T funcexe;
3076
Bram Moolenaara80faa82020-04-12 19:37:17 +02003077 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003078 funcexe.firstline = curwin->w_cursor.lnum;
3079 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003080 funcexe.evaluate = TRUE;
3081 funcexe.partial = partial;
3082 funcexe.selfdict = selfdict;
3083 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3084 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085
Bram Moolenaare38eab22019-12-05 21:50:01 +01003086 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 while (argc > 0)
3088 clear_tv(&argv[--argc]);
3089
3090 return r;
3091}
3092
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003093static int callback_depth = 0;
3094
3095 int
3096get_callback_depth(void)
3097{
3098 return callback_depth;
3099}
3100
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003102 * Invoke call_func() with a callback.
3103 */
3104 int
3105call_callback(
3106 callback_T *callback,
3107 int len, // length of "name" or -1 to use strlen()
3108 typval_T *rettv, // return value goes here
3109 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003110 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003111 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003112{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003113 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003114 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003115
Bram Moolenaara80faa82020-04-12 19:37:17 +02003116 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003117 funcexe.evaluate = TRUE;
3118 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003119 ++callback_depth;
3120 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3121 --callback_depth;
3122 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003123}
3124
3125/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003126 * Give an error message for the result of a function.
3127 * Nothing if "error" is FCERR_NONE.
3128 */
3129 void
3130user_func_error(int error, char_u *name)
3131{
3132 switch (error)
3133 {
3134 case FCERR_UNKNOWN:
3135 emsg_funcname(e_unknownfunc, name);
3136 break;
3137 case FCERR_NOTMETHOD:
3138 emsg_funcname(
3139 N_("E276: Cannot use function as a method: %s"), name);
3140 break;
3141 case FCERR_DELETED:
3142 emsg_funcname(N_(e_func_deleted), name);
3143 break;
3144 case FCERR_TOOMANY:
3145 emsg_funcname((char *)e_toomanyarg, name);
3146 break;
3147 case FCERR_TOOFEW:
3148 emsg_funcname((char *)e_toofewarg, name);
3149 break;
3150 case FCERR_SCRIPT:
3151 emsg_funcname(
3152 N_("E120: Using <SID> not in a script context: %s"), name);
3153 break;
3154 case FCERR_DICT:
3155 emsg_funcname(
3156 N_("E725: Calling dict function without Dictionary: %s"),
3157 name);
3158 break;
3159 }
3160}
3161
3162/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003164 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 * Return FAIL when the function can't be called, OK otherwise.
3166 * Also returns OK when an error was encountered while executing the function.
3167 */
3168 int
3169call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003170 char_u *funcname, // name of the function
3171 int len, // length of "name" or -1 to use strlen()
3172 typval_T *rettv, // return value goes here
3173 int argcount_in, // number of "argvars"
3174 typval_T *argvars_in, // vars for arguments, must have "argcount"
3175 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003176 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177{
3178 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003179 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003181 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003182 char_u fname_buf[FLEN_FIXED + 1];
3183 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003184 char_u *fname = NULL;
3185 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 int argcount = argcount_in;
3187 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003188 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003189 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3190 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003192 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003193 partial_T *partial = funcexe->partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003194 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003196 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3197 // even when call_func() returns FAIL.
3198 rettv->v_type = VAR_UNKNOWN;
3199
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003200 if (partial != NULL)
3201 fp = partial->pt_func;
3202 if (fp == NULL)
3203 {
3204 // Make a copy of the name, if it comes from a funcref variable it
3205 // could be changed or deleted in the called function.
3206 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3207 if (name == NULL)
3208 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003210 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3211 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003213 if (funcexe->doesrange != NULL)
3214 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215
3216 if (partial != NULL)
3217 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003218 // When the function has a partial with a dict and there is a dict
3219 // argument, use the dict argument. That is backwards compatible.
3220 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003221 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003222 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003223 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003224 {
3225 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003226 {
3227 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3228 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003229 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003230 goto theend;
3231 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003233 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 for (i = 0; i < argcount_in; ++i)
3235 argv[i + argv_clear] = argvars_in[i];
3236 argvars = argv;
3237 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003238
Bram Moolenaar22f85d02021-07-04 23:29:30 +02003239 if (funcexe->check_type != NULL
3240 && funcexe->check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003241 {
3242 // Now funcexe->check_type is missing the added arguments, make
3243 // a copy of the type with the correction.
3244 check_type = *funcexe->check_type;
3245 funcexe->check_type = &check_type;
3246 check_type.tt_argcount += partial->pt_argc;
3247 check_type.tt_min_argcount += partial->pt_argc;
3248 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 }
3250 }
3251
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003252 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3253 {
3254 // Check that the argument types are OK for the types of the funcref.
3255 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003256 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003257 error = FCERR_OTHER;
3258 }
3259
Bram Moolenaaref140542019-12-31 21:27:13 +01003260 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 {
3262 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003263 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264
Bram Moolenaar333894b2020-08-01 18:53:07 +02003265 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003266 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003267 {
3268 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271
Bram Moolenaare38eab22019-12-05 21:50:01 +01003272 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003274 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003276 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 {
3278 /*
3279 * User defined function.
3280 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003281 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003282 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003283
Bram Moolenaare38eab22019-12-05 21:50:01 +01003284 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285 if (fp == NULL
3286 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003287 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288 && !aborting())
3289 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003290 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003291 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003293 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3295 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003296 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003297 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003298 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003299 if (fp == NULL)
3300 {
3301 char_u *p = untrans_function_name(rfname);
3302
3303 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003304 // Don't do this if the name starts with "s:".
3305 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003306 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003307 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003308
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003309 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003310 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003311#ifdef FEAT_LUA
3312 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3313 {
3314 cfunc_T cb = fp->uf_cb;
3315
3316 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3317 }
3318#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003319 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003321 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003322 // postponed filling in the arguments, do it now
3323 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003324 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003325
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003326 if (funcexe->basetv != NULL)
3327 {
3328 // Method call: base->Method()
3329 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3330 argv[0] = *funcexe->basetv;
3331 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003332 argvars = argv;
3333 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003334 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003335
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336 error = call_user_func_check(fp, argcount, argvars, rettv,
3337 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 }
3339 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003340 else if (funcexe->basetv != NULL)
3341 {
3342 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003343 * expr->method(): Find the method name in the table, call its
3344 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003345 */
3346 error = call_internal_method(fname, argcount, argvars, rettv,
3347 funcexe->basetv);
3348 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 else
3350 {
3351 /*
3352 * Find the function name in the table, call its implementation.
3353 */
3354 error = call_internal_func(fname, argcount, argvars, rettv);
3355 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003356
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 /*
3358 * The function call (or "FuncUndefined" autocommand sequence) might
3359 * have been aborted by an error, an interrupt, or an explicitly thrown
3360 * exception that has not been caught so far. This situation can be
3361 * tested for by calling aborting(). For an error in an internal
3362 * function or for the "E132" error in call_user_func(), however, the
3363 * throw point at which the "force_abort" flag (temporarily reset by
3364 * emsg()) is normally updated has not been reached yet. We need to
3365 * update that flag first to make aborting() reliable.
3366 */
3367 update_force_abort();
3368 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003369 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 ret = OK;
3371
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003372theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 /*
3374 * Report an error unless the argument evaluation or function call has been
3375 * cancelled due to an aborting error, an interrupt, or an exception.
3376 */
3377 if (!aborting())
3378 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003379 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 }
3381
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003382 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003383 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003384 clear_tv(&argv[--argv_clear + argv_base]);
3385
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 vim_free(tofree);
3387 vim_free(name);
3388
3389 return ret;
3390}
3391
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003392 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003393printable_func_name(ufunc_T *fp)
3394{
3395 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3396}
3397
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003399 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 */
3401 static void
3402list_func_head(ufunc_T *fp, int indent)
3403{
3404 int j;
3405
3406 msg_start();
3407 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003408 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003409 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003410 msg_puts("def ");
3411 else
3412 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003413 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 msg_putchar('(');
3415 for (j = 0; j < fp->uf_args.ga_len; ++j)
3416 {
3417 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003418 msg_puts(", ");
3419 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003420 if (fp->uf_arg_types != NULL)
3421 {
3422 char *tofree;
3423
3424 msg_puts(": ");
3425 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3426 vim_free(tofree);
3427 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003428 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3429 {
3430 msg_puts(" = ");
3431 msg_puts(((char **)(fp->uf_def_args.ga_data))
3432 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 }
3435 if (fp->uf_varargs)
3436 {
3437 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003438 msg_puts(", ");
3439 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003441 if (fp->uf_va_name != NULL)
3442 {
3443 if (j)
3444 msg_puts(", ");
3445 msg_puts("...");
3446 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003447 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003448 {
3449 char *tofree;
3450
3451 msg_puts(": ");
3452 msg_puts(type_name(fp->uf_va_type, &tofree));
3453 vim_free(tofree);
3454 }
3455 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003457
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003458 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003459 {
3460 if (fp->uf_ret_type != &t_void)
3461 {
3462 char *tofree;
3463
3464 msg_puts(": ");
3465 msg_puts(type_name(fp->uf_ret_type, &tofree));
3466 vim_free(tofree);
3467 }
3468 }
3469 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003470 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003472 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003474 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003475 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003476 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477 msg_clr_eos();
3478 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003479 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480}
3481
3482/*
3483 * Get a function name, translating "<SID>" and "<SNR>".
3484 * Also handles a Funcref in a List or Dictionary.
3485 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003486 * Set "*is_global" to TRUE when the function must be global, unless
3487 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003488 * flags:
3489 * TFN_INT: internal function name OK
3490 * TFN_QUIET: be quiet
3491 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003492 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 * Advances "pp" to just after the function name (if no error).
3494 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003495 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496trans_function_name(
3497 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003498 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003499 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003500 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003501 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003502 partial_T **partial, // return: partial of a FuncRef
3503 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504{
3505 char_u *name = NULL;
3506 char_u *start;
3507 char_u *end;
3508 int lead;
3509 char_u sid_buf[20];
3510 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003511 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003514 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515
3516 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003517 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003518 start = *pp;
3519
Bram Moolenaare38eab22019-12-05 21:50:01 +01003520 // Check for hard coded <SNR>: already translated function ID (from a user
3521 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003522 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3523 && (*pp)[2] == (int)KE_SNR)
3524 {
3525 *pp += 3;
3526 len = get_id_len(pp) + 3;
3527 return vim_strnsave(start, len);
3528 }
3529
Bram Moolenaare38eab22019-12-05 21:50:01 +01003530 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3531 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 lead = eval_fname_script(start);
3533 if (lead > 2)
3534 start += lead;
3535
Bram Moolenaare38eab22019-12-05 21:50:01 +01003536 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003537 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 lead > 2 ? 0 : FNE_CHECK_START);
3539 if (end == start)
3540 {
3541 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003542 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 goto theend;
3544 }
3545 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3546 {
3547 /*
3548 * Report an invalid expression in braces, unless the expression
3549 * evaluation has been cancelled due to an aborting error, an
3550 * interrupt, or an exception.
3551 */
3552 if (!aborting())
3553 {
3554 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003555 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 }
3557 else
3558 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3559 goto theend;
3560 }
3561
3562 if (lv.ll_tv != NULL)
3563 {
3564 if (fdp != NULL)
3565 {
3566 fdp->fd_dict = lv.ll_dict;
3567 fdp->fd_newkey = lv.ll_newkey;
3568 lv.ll_newkey = NULL;
3569 fdp->fd_di = lv.ll_di;
3570 }
3571 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3572 {
3573 name = vim_strsave(lv.ll_tv->vval.v_string);
3574 *pp = end;
3575 }
3576 else if (lv.ll_tv->v_type == VAR_PARTIAL
3577 && lv.ll_tv->vval.v_partial != NULL)
3578 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003579 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580 *pp = end;
3581 if (partial != NULL)
3582 *partial = lv.ll_tv->vval.v_partial;
3583 }
3584 else
3585 {
3586 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3587 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003588 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 else
3590 *pp = end;
3591 name = NULL;
3592 }
3593 goto theend;
3594 }
3595
3596 if (lv.ll_name == NULL)
3597 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003598 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 *pp = end;
3600 goto theend;
3601 }
3602
Bram Moolenaare38eab22019-12-05 21:50:01 +01003603 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 if (lv.ll_exp_name != NULL)
3605 {
3606 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003607 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 flags & TFN_NO_AUTOLOAD);
3609 if (name == lv.ll_exp_name)
3610 name = NULL;
3611 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003612 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613 {
3614 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003615 name = deref_func_name(*pp, &len, partial, type,
3616 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 if (name == *pp)
3618 name = NULL;
3619 }
3620 if (name != NULL)
3621 {
3622 name = vim_strsave(name);
3623 *pp = end;
3624 if (STRNCMP(name, "<SNR>", 5) == 0)
3625 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003626 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 name[0] = K_SPECIAL;
3628 name[1] = KS_EXTRA;
3629 name[2] = (int)KE_SNR;
3630 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3631 }
3632 goto theend;
3633 }
3634
3635 if (lv.ll_exp_name != NULL)
3636 {
3637 len = (int)STRLEN(lv.ll_exp_name);
3638 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3639 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3640 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003641 // When there was "s:" already or the name expanded to get a
3642 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643 lv.ll_name += 2;
3644 len -= 2;
3645 lead = 2;
3646 }
3647 }
3648 else
3649 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003650 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003652 {
3653 if (is_global != NULL && lv.ll_name[0] == 'g')
3654 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003656 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 len = (int)(end - lv.ll_name);
3658 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003659 if (len <= 0)
3660 {
3661 if (!skip)
3662 emsg(_(e_function_name));
3663 goto theend;
3664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003666 // In Vim9 script a user function is script-local by default, unless it
3667 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003668 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003669 if (vim9script)
3670 {
3671 char_u *p;
3672
3673 // SomeScript#func() is a global function.
3674 for (p = start; *p != NUL && *p != '('; ++p)
3675 if (*p == AUTOLOAD_CHAR)
3676 vim9script = FALSE;
3677 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003678
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 /*
3680 * Copy the function name to allocated memory.
3681 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3682 * Accept <SNR>123_name() outside a script.
3683 */
3684 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003685 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003686 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003688 if (!vim9script)
3689 lead = 3;
3690 if (vim9script || (lv.ll_exp_name != NULL
3691 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 || eval_fname_sid(*pp))
3693 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003694 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003695 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003697 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 goto theend;
3699 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003700 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003701 if (vim9script)
3702 extra = 3 + (int)STRLEN(sid_buf);
3703 else
3704 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705 }
3706 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003707 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3708 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003710 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711 start);
3712 goto theend;
3713 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003714 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 {
3716 char_u *cp = vim_strchr(lv.ll_name, ':');
3717
3718 if (cp != NULL && cp < end)
3719 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003720 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 goto theend;
3722 }
3723 }
3724
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003725 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 if (name != NULL)
3727 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003728 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 {
3730 name[0] = K_SPECIAL;
3731 name[1] = KS_EXTRA;
3732 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003733 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 STRCPY(name + 3, sid_buf);
3735 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003736 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3737 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 }
3739 *pp = end;
3740
3741theend:
3742 clear_lval(&lv);
3743 return name;
3744}
3745
3746/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003747 * Assuming "name" is the result of trans_function_name() and it was prefixed
3748 * to use the script-local name, return the unmodified name (points into
3749 * "name"). Otherwise return NULL.
3750 * This can be used to first search for a script-local function and fall back
3751 * to the global function if not found.
3752 */
3753 char_u *
3754untrans_function_name(char_u *name)
3755{
3756 char_u *p;
3757
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003758 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003759 {
3760 p = vim_strchr(name, '_');
3761 if (p != NULL)
3762 return p + 1;
3763 }
3764 return NULL;
3765}
3766
3767/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003768 * List functions. When "regmatch" is NULL all of then.
3769 * Otherwise functions matching "regmatch".
3770 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003771 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003772list_functions(regmatch_T *regmatch)
3773{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003774 int changed = func_hashtab.ht_changed;
3775 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003776 hashitem_T *hi;
3777
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003778 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003779 {
3780 if (!HASHITEM_EMPTY(hi))
3781 {
3782 ufunc_T *fp = HI2UF(hi);
3783
3784 --todo;
3785 if ((fp->uf_flags & FC_DEAD) == 0
3786 && (regmatch == NULL
3787 ? !message_filtered(fp->uf_name)
3788 && !func_name_refcount(fp->uf_name)
3789 : !isdigit(*fp->uf_name)
3790 && vim_regexec(regmatch, fp->uf_name, 0)))
3791 {
3792 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003793 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003794 {
3795 emsg(_("E454: function list was modified"));
3796 return;
3797 }
3798 }
3799 }
3800 }
3801}
3802
3803/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003804 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003805 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3806 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003807 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003809 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003810define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003812 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813 int j;
3814 int c;
3815 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003816 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003817 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 char_u *p;
3819 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003820 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 char_u *line_arg = NULL;
3822 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003823 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003824 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 garray_T newlines;
3826 int varargs = FALSE;
3827 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003828 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003829 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003830 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 dictitem_T *v;
3832 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003833 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003836 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003837 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003838 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003839
3840 /*
3841 * ":function" without argument: list functions.
3842 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003843 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 {
3845 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003846 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003847 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003848 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 }
3850
3851 /*
3852 * ":function /pat": list functions matching pattern.
3853 */
3854 if (*eap->arg == '/')
3855 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003856 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 if (!eap->skip)
3858 {
3859 regmatch_T regmatch;
3860
3861 c = *p;
3862 *p = NUL;
3863 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3864 *p = c;
3865 if (regmatch.regprog != NULL)
3866 {
3867 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003868 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 vim_regfree(regmatch.regprog);
3870 }
3871 }
3872 if (*p == '/')
3873 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02003874 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003875 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003876 }
3877
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003878 ga_init(&newargs);
3879 ga_init(&argtypes);
3880 ga_init(&default_args);
3881
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882 /*
3883 * Get the function name. There are these situations:
3884 * func normal function name
3885 * "name" == func, "fudi.fd_dict" == NULL
3886 * dict.func new dictionary entry
3887 * "name" == NULL, "fudi.fd_dict" set,
3888 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3889 * dict.func existing dict entry with a Funcref
3890 * "name" == func, "fudi.fd_dict" set,
3891 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3892 * dict.func existing dict entry that's not a Funcref
3893 * "name" == NULL, "fudi.fd_dict" set,
3894 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3895 * s:func script-local function name
3896 * g:func global function name, same as "func"
3897 */
3898 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003899 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003900 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003901 // nested function, argument is (args).
3902 paren = TRUE;
3903 CLEAR_FIELD(fudi);
3904 }
3905 else
3906 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003907 if (STRNCMP(p, "<lambda>", 8) == 0)
3908 {
3909 p += 8;
3910 (void)getdigits(&p);
3911 name = vim_strnsave(eap->arg, p - eap->arg);
3912 CLEAR_FIELD(fudi);
3913 }
3914 else
3915 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003916 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003917 paren = (vim_strchr(p, '(') != NULL);
3918 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003920 /*
3921 * Return on an invalid expression in braces, unless the expression
3922 * evaluation has been cancelled due to an aborting error, an
3923 * interrupt, or an exception.
3924 */
3925 if (!aborting())
3926 {
3927 if (!eap->skip && fudi.fd_newkey != NULL)
3928 semsg(_(e_dictkey), fudi.fd_newkey);
3929 vim_free(fudi.fd_newkey);
3930 return NULL;
3931 }
3932 else
3933 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 }
3936
Bram Moolenaare38eab22019-12-05 21:50:01 +01003937 // An error in a function call during evaluation of an expression in magic
3938 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 saved_did_emsg = did_emsg;
3940 did_emsg = FALSE;
3941
3942 /*
3943 * ":function func" with only function name: list function.
3944 */
3945 if (!paren)
3946 {
3947 if (!ends_excmd(*skipwhite(p)))
3948 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003949 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 goto ret_free;
3951 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02003952 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 if (eap->nextcmd != NULL)
3954 *p = NUL;
3955 if (!eap->skip && !got_int)
3956 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003957 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003958 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3959 {
3960 char_u *up = untrans_function_name(name);
3961
3962 // With Vim9 script the name was made script-local, if not
3963 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003964 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003965 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003966 }
3967
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 if (fp != NULL)
3969 {
3970 list_func_head(fp, TRUE);
3971 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3972 {
3973 if (FUNCLINE(fp, j) == NULL)
3974 continue;
3975 msg_putchar('\n');
3976 msg_outnum((long)(j + 1));
3977 if (j < 9)
3978 msg_putchar(' ');
3979 if (j < 99)
3980 msg_putchar(' ');
3981 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 ui_breakcheck();
3984 }
3985 if (!got_int)
3986 {
3987 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003988 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003989 msg_puts(" enddef");
3990 else
3991 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003992 }
3993 }
3994 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003995 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 }
3997 goto ret_free;
3998 }
3999
4000 /*
4001 * ":function name(arg1, arg2)" Define function.
4002 */
4003 p = skipwhite(p);
4004 if (*p != '(')
4005 {
4006 if (!eap->skip)
4007 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004008 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004009 goto ret_free;
4010 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004011 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 if (vim_strchr(p, '(') != NULL)
4013 p = vim_strchr(p, '(');
4014 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004016 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4017 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004018 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004019 goto ret_free;
4020 }
4021
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004022 // In Vim9 script only global functions can be redefined.
4023 if (vim9script && eap->forceit && !is_global)
4024 {
4025 emsg(_(e_nobang));
4026 goto ret_free;
4027 }
4028
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004029 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030
Bram Moolenaar04b12692020-05-04 23:24:44 +02004031 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004033 // Check the name of the function. Unless it's a dictionary function
4034 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035 if (name != NULL)
4036 arg = name;
4037 else
4038 arg = fudi.fd_newkey;
4039 if (arg != NULL && (fudi.fd_di == NULL
4040 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4041 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4042 {
4043 if (*arg == K_SPECIAL)
4044 j = 3;
4045 else
4046 j = 0;
4047 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
4048 : eval_isnamec(arg[j])))
4049 ++j;
4050 if (arg[j] != NUL)
4051 emsg_funcname((char *)e_invarg2, arg);
4052 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004053 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004055 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 }
4057
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004058 // This may get more lines and make the pointers into the first line
4059 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004060 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004061 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004062 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004063 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004064 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004066 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004068 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004070 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004071 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004073 if (*p != ':')
4074 {
4075 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4076 p = skipwhite(p);
4077 }
4078 else if (!IS_WHITE_OR_NUL(p[1]))
4079 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004080 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004081 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004082 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004083 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004084 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004085 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004086 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004087 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004088 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004089 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004090 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004091 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004092 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004094 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004096 else
4097 // find extra arguments "range", "dict", "abort" and "closure"
4098 for (;;)
4099 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004100 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004101 p = skipwhite(p);
4102 if (STRNCMP(p, "range", 5) == 0)
4103 {
4104 flags |= FC_RANGE;
4105 p += 5;
4106 }
4107 else if (STRNCMP(p, "dict", 4) == 0)
4108 {
4109 flags |= FC_DICT;
4110 p += 4;
4111 }
4112 else if (STRNCMP(p, "abort", 5) == 0)
4113 {
4114 flags |= FC_ABORT;
4115 p += 5;
4116 }
4117 else if (STRNCMP(p, "closure", 7) == 0)
4118 {
4119 flags |= FC_CLOSURE;
4120 p += 7;
4121 if (current_funccal == NULL)
4122 {
4123 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4124 name == NULL ? (char_u *)"" : name);
4125 goto erret;
4126 }
4127 }
4128 else
4129 break;
4130 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004131
Bram Moolenaare38eab22019-12-05 21:50:01 +01004132 // When there is a line break use what follows for the function body.
4133 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 if (*p == '\n')
4135 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004136 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004137 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4138 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004139 && !(VIM_ISWHITE(*whitep) && *p == '#'
4140 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004141 && !eap->skip
4142 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004143 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004144
4145 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004146 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4147 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148 */
4149 if (KeyTyped)
4150 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004151 // Check if the function already exists, don't let the user type the
4152 // whole function before telling him it doesn't work! For a script we
4153 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 if (!eap->skip && !eap->forceit)
4155 {
4156 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004157 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004158 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 emsg_funcname(e_funcexts, name);
4160 }
4161
4162 if (!eap->skip && did_emsg)
4163 goto erret;
4164
Bram Moolenaare38eab22019-12-05 21:50:01 +01004165 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166 cmdline_row = msg_row;
4167 }
4168
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004169 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004170 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004171
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004172 // Do not define the function when getting the body fails and when
4173 // skipping.
4174 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4175 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 goto erret;
4177
4178 /*
4179 * If there are no errors, add the function
4180 */
4181 if (fudi.fd_dict == NULL)
4182 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004183 hashtab_T *ht;
4184
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004185 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4187 {
4188 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4189 name);
4190 goto erret;
4191 }
4192
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004193 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004194 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004196 char_u *uname = untrans_function_name(name);
4197
4198 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4199 }
4200
4201 if (fp != NULL || import != NULL)
4202 {
4203 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004204
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004205 // Function can be replaced with "function!" and when sourcing the
4206 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004207 // A name that is used by an import can not be overruled.
4208 if (import != NULL
4209 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004210 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004211 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004213 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004214 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004215 else
4216 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217 goto erret;
4218 }
4219 if (fp->uf_calls > 0)
4220 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004221 emsg_funcname(
4222 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004223 name);
4224 goto erret;
4225 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004226 if (fp->uf_refcount > 1)
4227 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004228 // This function is referenced somewhere, don't redefine it but
4229 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004230 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004231 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004232 fp = NULL;
4233 overwrite = TRUE;
4234 }
4235 else
4236 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004237 char_u *exp_name = fp->uf_name_exp;
4238
4239 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004240 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004241 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004242 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004243 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004244 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004245#ifdef FEAT_PROFILE
4246 fp->uf_profiling = FALSE;
4247 fp->uf_prof_initialized = FALSE;
4248#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004249 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004250 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004251 }
4252 }
4253 else
4254 {
4255 char numbuf[20];
4256
4257 fp = NULL;
4258 if (fudi.fd_newkey == NULL && !eap->forceit)
4259 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004260 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 goto erret;
4262 }
4263 if (fudi.fd_di == NULL)
4264 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004265 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004266 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 goto erret;
4268 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004269 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004270 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271 goto erret;
4272
Bram Moolenaare38eab22019-12-05 21:50:01 +01004273 // Give the function a sequential number. Can only be used with a
4274 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 vim_free(name);
4276 sprintf(numbuf, "%d", ++func_nr);
4277 name = vim_strsave((char_u *)numbuf);
4278 if (name == NULL)
4279 goto erret;
4280 }
4281
4282 if (fp == NULL)
4283 {
4284 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4285 {
4286 int slen, plen;
4287 char_u *scriptname;
4288
Bram Moolenaare38eab22019-12-05 21:50:01 +01004289 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004291 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 {
4293 scriptname = autoload_name(name);
4294 if (scriptname != NULL)
4295 {
4296 p = vim_strchr(scriptname, '/');
4297 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004298 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004300 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 j = OK;
4302 vim_free(scriptname);
4303 }
4304 }
4305 if (j == FAIL)
4306 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004307 linenr_T save_lnum = SOURCING_LNUM;
4308
4309 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004310 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004311 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312 goto erret;
4313 }
4314 }
4315
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004316 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 if (fp == NULL)
4318 goto erret;
4319
4320 if (fudi.fd_dict != NULL)
4321 {
4322 if (fudi.fd_di == NULL)
4323 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004324 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4326 if (fudi.fd_di == NULL)
4327 {
4328 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004329 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004330 goto erret;
4331 }
4332 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4333 {
4334 vim_free(fudi.fd_di);
4335 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004336 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 goto erret;
4338 }
4339 }
4340 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004341 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342 clear_tv(&fudi.fd_di->di_tv);
4343 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345
Bram Moolenaare38eab22019-12-05 21:50:01 +01004346 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 flags |= FC_DICT;
4348 }
4349
Bram Moolenaare38eab22019-12-05 21:50:01 +01004350 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004351 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004352 if (overwrite)
4353 {
4354 hi = hash_find(&func_hashtab, name);
4355 hi->hi_key = UF2HIKEY(fp);
4356 }
4357 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 {
4359 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004360 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 goto erret;
4362 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004363 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004364 }
4365 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004366 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004367 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004368 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004369
4370 if (eap->cmdidx == CMD_def)
4371 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004372 int lnum_save = SOURCING_LNUM;
4373 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004374
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004375 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004376
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004377 // error messages are for the first function line
4378 SOURCING_LNUM = sourcing_lnum_top;
4379
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004380 // The function may use script variables from the context.
4381 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004382
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004383 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004384 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004385 SOURCING_LNUM = lnum_save;
4386 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004387 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004388 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004389
4390 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004391 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004392 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004393 SOURCING_LNUM = lnum_save;
4394 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004395 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004396 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004397 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004398 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004399 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004400
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004402 if ((flags & FC_CLOSURE) != 0)
4403 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004404 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004405 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004406 }
4407 else
4408 fp->uf_scoped = NULL;
4409
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 if (prof_def_func())
4412 func_do_profile(fp);
4413#endif
4414 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004415 if (sandbox)
4416 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004417 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004418 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 fp->uf_flags = flags;
4420 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004421 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004422 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004423 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004424 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004425 if (is_export)
4426 {
4427 fp->uf_flags |= FC_EXPORT;
4428 // let ex_export() know the export worked.
4429 is_export = FALSE;
4430 }
4431
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004432 if (eap->cmdidx == CMD_def)
4433 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004434 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4435 // :func does not use Vim9 script syntax, even in a Vim9 script file
4436 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004437
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004438 goto ret_free;
4439
4440erret:
4441 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004442 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004443 if (fp != NULL)
4444 {
4445 ga_init(&fp->uf_args);
4446 ga_init(&fp->uf_def_args);
4447 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448errret_2:
4449 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004450 if (fp != NULL)
4451 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004453 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004454 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004456 if (name != name_arg)
4457 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004458 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004460
4461 return fp;
4462}
4463
4464/*
4465 * ":function"
4466 */
4467 void
4468ex_function(exarg_T *eap)
4469{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004470 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004471}
4472
4473/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004474 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004475 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004476 */
4477 void
4478ex_defcompile(exarg_T *eap UNUSED)
4479{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004480 long todo = (long)func_hashtab.ht_used;
4481 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004482 hashitem_T *hi;
4483 ufunc_T *ufunc;
4484
4485 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4486 {
4487 if (!HASHITEM_EMPTY(hi))
4488 {
4489 --todo;
4490 ufunc = HI2UF(hi);
4491 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004492 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4493 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004494 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004495 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004496
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004497 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004498 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004499 // a function has been added or removed, need to start over
4500 todo = (long)func_hashtab.ht_used;
4501 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004502 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004503 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004504 }
4505 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004506 }
4507 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508}
4509
4510/*
4511 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4512 * Return 2 if "p" starts with "s:".
4513 * Return 0 otherwise.
4514 */
4515 int
4516eval_fname_script(char_u *p)
4517{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004518 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4519 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4521 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4522 return 5;
4523 if (p[0] == 's' && p[1] == ':')
4524 return 2;
4525 return 0;
4526}
4527
4528 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004529translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530{
4531 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004532 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004533 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534}
4535
4536/*
4537 * Return TRUE when "ufunc" has old-style "..." varargs
4538 * or named varargs "...name: type".
4539 */
4540 int
4541has_varargs(ufunc_T *ufunc)
4542{
4543 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004544}
4545
4546/*
4547 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004548 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 */
4550 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004551function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552{
4553 char_u *nm = name;
4554 char_u *p;
4555 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004556 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004557 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004559 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4560 if (no_deref)
4561 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004562 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563 nm = skipwhite(nm);
4564
Bram Moolenaare38eab22019-12-05 21:50:01 +01004565 // Only accept "funcname", "funcname ", "funcname (..." and
4566 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004568 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 vim_free(p);
4570 return n;
4571}
4572
Bram Moolenaar113e1072019-01-20 15:30:40 +01004573#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574 char_u *
4575get_expanded_name(char_u *name, int check)
4576{
4577 char_u *nm = name;
4578 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004579 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004581 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004582 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004584 if (p != NULL && *nm == NUL
4585 && (!check || translated_function_exists(p, is_global)))
4586 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587
4588 vim_free(p);
4589 return NULL;
4590}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004591#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593/*
4594 * Function given to ExpandGeneric() to obtain the list of user defined
4595 * function names.
4596 */
4597 char_u *
4598get_user_func_name(expand_T *xp, int idx)
4599{
4600 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004601 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004602 static hashitem_T *hi;
4603 ufunc_T *fp;
4604
4605 if (idx == 0)
4606 {
4607 done = 0;
4608 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004609 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004611 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004612 {
4613 if (done++ > 0)
4614 ++hi;
4615 while (HASHITEM_EMPTY(hi))
4616 ++hi;
4617 fp = HI2UF(hi);
4618
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004619 // don't show dead, dict and lambda functions
4620 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004621 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004623
4624 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004625 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626
4627 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004628 if (xp->xp_context != EXPAND_USER_FUNC
4629 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630 {
4631 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004632 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 STRCAT(IObuff, ")");
4634 }
4635 return IObuff;
4636 }
4637 return NULL;
4638}
4639
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004640/*
4641 * ":delfunction {name}"
4642 */
4643 void
4644ex_delfunction(exarg_T *eap)
4645{
4646 ufunc_T *fp = NULL;
4647 char_u *p;
4648 char_u *name;
4649 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004650 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651
4652 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004653 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4654 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655 vim_free(fudi.fd_newkey);
4656 if (name == NULL)
4657 {
4658 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004659 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004660 return;
4661 }
4662 if (!ends_excmd(*skipwhite(p)))
4663 {
4664 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004665 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004666 return;
4667 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004668 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669 if (eap->nextcmd != NULL)
4670 *p = NUL;
4671
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004672 if (isdigit(*name) && fudi.fd_dict == NULL)
4673 {
4674 if (!eap->skip)
4675 semsg(_(e_invarg2), eap->arg);
4676 vim_free(name);
4677 return;
4678 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004680 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 vim_free(name);
4682
4683 if (!eap->skip)
4684 {
4685 if (fp == NULL)
4686 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004687 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004688 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 return;
4690 }
4691 if (fp->uf_calls > 0)
4692 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004693 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 return;
4695 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004696 if (fp->uf_flags & FC_VIM9)
4697 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004698 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004699 return;
4700 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701
4702 if (fudi.fd_dict != NULL)
4703 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004704 // Delete the dict item that refers to the function, it will
4705 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004706 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4707 }
4708 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004709 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004710 // A normal function (not a numbered function or lambda) has a
4711 // refcount of 1 for the entry in the hashtable. When deleting
4712 // it and the refcount is more than one, it should be kept.
4713 // A numbered function and lambda should be kept if the refcount is
4714 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004715 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004716 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004717 // Function is still referenced somewhere. Don't free it but
4718 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004719 if (func_remove(fp))
4720 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004721 }
4722 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004723 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004724 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 }
4726}
4727
4728/*
4729 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004730 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 */
4732 void
4733func_unref(char_u *name)
4734{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004735 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004736
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004737 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004739 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004740 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004741 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004742#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004743 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004745 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004747 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004748}
4749
4750/*
4751 * Unreference a Function: decrement the reference count and free it when it
4752 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004753 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004754 */
4755 void
4756func_ptr_unref(ufunc_T *fp)
4757{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004758 if (fp != NULL && (--fp->uf_refcount <= 0
4759 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4760 && fp->uf_partial->pt_refcount <= 1
4761 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004762 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004763 // Only delete it when it's not being used. Otherwise it's done
4764 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004765 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004766 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767 }
4768}
4769
4770/*
4771 * Count a reference to a Function.
4772 */
4773 void
4774func_ref(char_u *name)
4775{
4776 ufunc_T *fp;
4777
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004778 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004779 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004780 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004781 if (fp != NULL)
4782 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004784 // Only give an error for a numbered function.
4785 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004786 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004787}
4788
4789/*
4790 * Count a reference to a Function.
4791 */
4792 void
4793func_ptr_ref(ufunc_T *fp)
4794{
4795 if (fp != NULL)
4796 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797}
4798
4799/*
4800 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4801 * referenced from anywhere that is in use.
4802 */
4803 static int
4804can_free_funccal(funccall_T *fc, int copyID)
4805{
4806 return (fc->l_varlist.lv_copyID != copyID
4807 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004808 && fc->l_avars.dv_copyID != copyID
4809 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810}
4811
4812/*
4813 * ":return [expr]"
4814 */
4815 void
4816ex_return(exarg_T *eap)
4817{
4818 char_u *arg = eap->arg;
4819 typval_T rettv;
4820 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004821 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822
4823 if (current_funccal == NULL)
4824 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004825 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 return;
4827 }
4828
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004829 CLEAR_FIELD(evalarg);
4830 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4831
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832 if (eap->skip)
4833 ++emsg_skip;
4834
4835 eap->nextcmd = NULL;
4836 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004837 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 {
4839 if (!eap->skip)
4840 returning = do_return(eap, FALSE, TRUE, &rettv);
4841 else
4842 clear_tv(&rettv);
4843 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004844 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845 else if (!eap->skip)
4846 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004847 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004848 update_force_abort();
4849
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 /*
4851 * Return unless the expression evaluation has been cancelled due to an
4852 * aborting error, an interrupt, or an exception.
4853 */
4854 if (!aborting())
4855 returning = do_return(eap, FALSE, TRUE, NULL);
4856 }
4857
Bram Moolenaare38eab22019-12-05 21:50:01 +01004858 // When skipping or the return gets pending, advance to the next command
4859 // in this line (!returning). Otherwise, ignore the rest of the line.
4860 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004861 if (returning)
4862 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004863 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02004864 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004865
4866 if (eap->skip)
4867 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004868 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869}
4870
4871/*
4872 * ":1,25call func(arg1, arg2)" function call.
4873 */
4874 void
4875ex_call(exarg_T *eap)
4876{
4877 char_u *arg = eap->arg;
4878 char_u *startarg;
4879 char_u *name;
4880 char_u *tofree;
4881 int len;
4882 typval_T rettv;
4883 linenr_T lnum;
4884 int doesrange;
4885 int failed = FALSE;
4886 funcdict_T fudi;
4887 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004888 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004889 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890
Bram Moolenaare6b53242020-07-01 17:28:33 +02004891 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 if (eap->skip)
4893 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004894 // trans_function_name() doesn't work well when skipping, use eval0()
4895 // instead to skip to any following command, e.g. for:
4896 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004897 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004898 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004899 clear_tv(&rettv);
4900 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004901 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902 return;
4903 }
4904
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004905 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4906 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 if (fudi.fd_newkey != NULL)
4908 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004909 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004910 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911 vim_free(fudi.fd_newkey);
4912 }
4913 if (tofree == NULL)
4914 return;
4915
Bram Moolenaare38eab22019-12-05 21:50:01 +01004916 // Increase refcount on dictionary, it could get deleted when evaluating
4917 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918 if (fudi.fd_dict != NULL)
4919 ++fudi.fd_dict->dv_refcount;
4920
Bram Moolenaare38eab22019-12-05 21:50:01 +01004921 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4922 // contents. For VAR_PARTIAL get its partial, unless we already have one
4923 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004924 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004925 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4926 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927
Bram Moolenaare38eab22019-12-05 21:50:01 +01004928 // Skip white space to allow ":call func ()". Not good, but required for
4929 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 if (*startarg != '(')
4932 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004933 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934 goto end;
4935 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02004936 if (in_vim9script() && startarg > arg)
4937 {
4938 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
4939 goto end;
4940 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004941
4942 /*
4943 * When skipping, evaluate the function once, to find the end of the
4944 * arguments.
4945 * When the function takes a range, this is discovered after the first
4946 * call, and the loop is broken.
4947 */
4948 if (eap->skip)
4949 {
4950 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004951 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004952 }
4953 else
4954 lnum = eap->line1;
4955 for ( ; lnum <= eap->line2; ++lnum)
4956 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004957 funcexe_T funcexe;
4958
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004959 if (!eap->skip && eap->addr_count > 0)
4960 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004961 if (lnum > curbuf->b_ml.ml_line_count)
4962 {
4963 // If the function deleted lines or switched to another buffer
4964 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02004965 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004966 break;
4967 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968 curwin->w_cursor.lnum = lnum;
4969 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971 }
4972 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004973
Bram Moolenaara80faa82020-04-12 19:37:17 +02004974 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004975 funcexe.firstline = eap->line1;
4976 funcexe.lastline = eap->line2;
4977 funcexe.doesrange = &doesrange;
4978 funcexe.evaluate = !eap->skip;
4979 funcexe.partial = partial;
4980 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004981 funcexe.check_type = type;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02004982 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02004983 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004984 {
4985 failed = TRUE;
4986 break;
4987 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004988 if (has_watchexpr())
4989 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004990
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004991 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004992 if (handle_subscript(&arg, &rettv,
4993 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004994 {
4995 failed = TRUE;
4996 break;
4997 }
4998
4999 clear_tv(&rettv);
5000 if (doesrange || eap->skip)
5001 break;
5002
Bram Moolenaare38eab22019-12-05 21:50:01 +01005003 // Stop when immediately aborting on error, or when an interrupt
5004 // occurred or an exception was thrown but not caught.
5005 // get_func_tv() returned OK, so that the check for trailing
5006 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005007 if (aborting())
5008 break;
5009 }
5010 if (eap->skip)
5011 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005012 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005013
Bram Moolenaare51bb172020-02-16 19:42:23 +01005014 // When inside :try we need to check for following "| catch".
5015 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005017 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005018 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005019 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005021 if (!failed)
5022 {
5023 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005024 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005025 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026 }
5027 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005028 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005029 }
5030
5031end:
5032 dict_unref(fudi.fd_dict);
5033 vim_free(tofree);
5034}
5035
5036/*
5037 * Return from a function. Possibly makes the return pending. Also called
5038 * for a pending return at the ":endtry" or after returning from an extra
5039 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5040 * when called due to a ":return" command. "rettv" may point to a typval_T
5041 * with the return rettv. Returns TRUE when the return can be carried out,
5042 * FALSE when the return gets pending.
5043 */
5044 int
5045do_return(
5046 exarg_T *eap,
5047 int reanimate,
5048 int is_cmd,
5049 void *rettv)
5050{
5051 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005052 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005053
5054 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005055 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005056 current_funccal->returned = FALSE;
5057
5058 /*
5059 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5060 * not in its finally clause (which then is to be executed next) is found.
5061 * In this case, make the ":return" pending for execution at the ":endtry".
5062 * Otherwise, return normally.
5063 */
5064 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5065 if (idx >= 0)
5066 {
5067 cstack->cs_pending[idx] = CSTP_RETURN;
5068
5069 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005070 // A pending return again gets pending. "rettv" points to an
5071 // allocated variable with the rettv of the original ":return"'s
5072 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005073 cstack->cs_rettv[idx] = rettv;
5074 else
5075 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005076 // When undoing a return in order to make it pending, get the stored
5077 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005078 if (reanimate)
5079 rettv = current_funccal->rettv;
5080
5081 if (rettv != NULL)
5082 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005083 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005084 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5085 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5086 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005087 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005088 }
5089 else
5090 cstack->cs_rettv[idx] = NULL;
5091
5092 if (reanimate)
5093 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005094 // The pending return value could be overwritten by a ":return"
5095 // without argument in a finally clause; reset the default
5096 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097 current_funccal->rettv->v_type = VAR_NUMBER;
5098 current_funccal->rettv->vval.v_number = 0;
5099 }
5100 }
5101 report_make_pending(CSTP_RETURN, rettv);
5102 }
5103 else
5104 {
5105 current_funccal->returned = TRUE;
5106
Bram Moolenaare38eab22019-12-05 21:50:01 +01005107 // If the return is carried out now, store the return value. For
5108 // a return immediately after reanimation, the value is already
5109 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110 if (!reanimate && rettv != NULL)
5111 {
5112 clear_tv(current_funccal->rettv);
5113 *current_funccal->rettv = *(typval_T *)rettv;
5114 if (!is_cmd)
5115 vim_free(rettv);
5116 }
5117 }
5118
5119 return idx < 0;
5120}
5121
5122/*
5123 * Free the variable with a pending return value.
5124 */
5125 void
5126discard_pending_return(void *rettv)
5127{
5128 free_tv((typval_T *)rettv);
5129}
5130
5131/*
5132 * Generate a return command for producing the value of "rettv". The result
5133 * is an allocated string. Used by report_pending() for verbose messages.
5134 */
5135 char_u *
5136get_return_cmd(void *rettv)
5137{
5138 char_u *s = NULL;
5139 char_u *tofree = NULL;
5140 char_u numbuf[NUMBUFLEN];
5141
5142 if (rettv != NULL)
5143 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5144 if (s == NULL)
5145 s = (char_u *)"";
5146
5147 STRCPY(IObuff, ":return ");
5148 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5149 if (STRLEN(s) + 8 >= IOSIZE)
5150 STRCPY(IObuff + IOSIZE - 4, "...");
5151 vim_free(tofree);
5152 return vim_strsave(IObuff);
5153}
5154
5155/*
5156 * Get next function line.
5157 * Called by do_cmdline() to get the next line.
5158 * Returns allocated string, or NULL for end of function.
5159 */
5160 char_u *
5161get_func_line(
5162 int c UNUSED,
5163 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005164 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005165 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166{
5167 funccall_T *fcp = (funccall_T *)cookie;
5168 ufunc_T *fp = fcp->func;
5169 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005170 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171
Bram Moolenaare38eab22019-12-05 21:50:01 +01005172 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005173 if (fcp->dbg_tick != debug_tick)
5174 {
5175 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005176 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 fcp->dbg_tick = debug_tick;
5178 }
5179#ifdef FEAT_PROFILE
5180 if (do_profiling == PROF_YES)
5181 func_line_end(cookie);
5182#endif
5183
5184 gap = &fp->uf_lines;
5185 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5186 || fcp->returned)
5187 retval = NULL;
5188 else
5189 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005190 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005191 while (fcp->linenr < gap->ga_len
5192 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5193 ++fcp->linenr;
5194 if (fcp->linenr >= gap->ga_len)
5195 retval = NULL;
5196 else
5197 {
5198 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005199 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200#ifdef FEAT_PROFILE
5201 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005202 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203#endif
5204 }
5205 }
5206
Bram Moolenaare38eab22019-12-05 21:50:01 +01005207 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005208 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005210 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005211 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005213 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005214 fcp->dbg_tick = debug_tick;
5215 }
5216
5217 return retval;
5218}
5219
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005220/*
5221 * Return TRUE if the currently active function should be ended, because a
5222 * return was encountered or an error occurred. Used inside a ":while".
5223 */
5224 int
5225func_has_ended(void *cookie)
5226{
5227 funccall_T *fcp = (funccall_T *)cookie;
5228
Bram Moolenaare38eab22019-12-05 21:50:01 +01005229 // Ignore the "abort" flag if the abortion behavior has been changed due to
5230 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5232 || fcp->returned);
5233}
5234
5235/*
5236 * return TRUE if cookie indicates a function which "abort"s on errors.
5237 */
5238 int
5239func_has_abort(
5240 void *cookie)
5241{
5242 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5243}
5244
5245
5246/*
5247 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5248 * Don't do this when "Func" is already a partial that was bound
5249 * explicitly (pt_auto is FALSE).
5250 * Changes "rettv" in-place.
5251 * Returns the updated "selfdict_in".
5252 */
5253 dict_T *
5254make_partial(dict_T *selfdict_in, typval_T *rettv)
5255{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005256 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257 char_u *tofree = NULL;
5258 ufunc_T *fp;
5259 char_u fname_buf[FLEN_FIXED + 1];
5260 int error;
5261 dict_T *selfdict = selfdict_in;
5262
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005263 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5264 fp = rettv->vval.v_partial->pt_func;
5265 else
5266 {
5267 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5268 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005269 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005270 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005271 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005272 vim_free(tofree);
5273 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005274
5275 if (fp != NULL && (fp->uf_flags & FC_DICT))
5276 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005277 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005278
5279 if (pt != NULL)
5280 {
5281 pt->pt_refcount = 1;
5282 pt->pt_dict = selfdict;
5283 pt->pt_auto = TRUE;
5284 selfdict = NULL;
5285 if (rettv->v_type == VAR_FUNC)
5286 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005287 // Just a function: Take over the function name and use
5288 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005289 pt->pt_name = rettv->vval.v_string;
5290 }
5291 else
5292 {
5293 partial_T *ret_pt = rettv->vval.v_partial;
5294 int i;
5295
Bram Moolenaare38eab22019-12-05 21:50:01 +01005296 // Partial: copy the function name, use selfdict and copy
5297 // args. Can't take over name or args, the partial might
5298 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005299 if (ret_pt->pt_name != NULL)
5300 {
5301 pt->pt_name = vim_strsave(ret_pt->pt_name);
5302 func_ref(pt->pt_name);
5303 }
5304 else
5305 {
5306 pt->pt_func = ret_pt->pt_func;
5307 func_ptr_ref(pt->pt_func);
5308 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005309 if (ret_pt->pt_argc > 0)
5310 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005311 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005313 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 pt->pt_argc = 0;
5315 else
5316 {
5317 pt->pt_argc = ret_pt->pt_argc;
5318 for (i = 0; i < pt->pt_argc; i++)
5319 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5320 }
5321 }
5322 partial_unref(ret_pt);
5323 }
5324 rettv->v_type = VAR_PARTIAL;
5325 rettv->vval.v_partial = pt;
5326 }
5327 }
5328 return selfdict;
5329}
5330
5331/*
5332 * Return the name of the executed function.
5333 */
5334 char_u *
5335func_name(void *cookie)
5336{
5337 return ((funccall_T *)cookie)->func->uf_name;
5338}
5339
5340/*
5341 * Return the address holding the next breakpoint line for a funccall cookie.
5342 */
5343 linenr_T *
5344func_breakpoint(void *cookie)
5345{
5346 return &((funccall_T *)cookie)->breakpoint;
5347}
5348
5349/*
5350 * Return the address holding the debug tick for a funccall cookie.
5351 */
5352 int *
5353func_dbg_tick(void *cookie)
5354{
5355 return &((funccall_T *)cookie)->dbg_tick;
5356}
5357
5358/*
5359 * Return the nesting level for a funccall cookie.
5360 */
5361 int
5362func_level(void *cookie)
5363{
5364 return ((funccall_T *)cookie)->level;
5365}
5366
5367/*
5368 * Return TRUE when a function was ended by a ":return" command.
5369 */
5370 int
5371current_func_returned(void)
5372{
5373 return current_funccal->returned;
5374}
5375
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 int
5377free_unref_funccal(int copyID, int testing)
5378{
5379 int did_free = FALSE;
5380 int did_free_funccal = FALSE;
5381 funccall_T *fc, **pfc;
5382
5383 for (pfc = &previous_funccal; *pfc != NULL; )
5384 {
5385 if (can_free_funccal(*pfc, copyID))
5386 {
5387 fc = *pfc;
5388 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005389 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005390 did_free = TRUE;
5391 did_free_funccal = TRUE;
5392 }
5393 else
5394 pfc = &(*pfc)->caller;
5395 }
5396 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005397 // When a funccal was freed some more items might be garbage
5398 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399 (void)garbage_collect(testing);
5400
5401 return did_free;
5402}
5403
5404/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005405 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005406 */
5407 static funccall_T *
5408get_funccal(void)
5409{
5410 int i;
5411 funccall_T *funccal;
5412 funccall_T *temp_funccal;
5413
5414 funccal = current_funccal;
5415 if (debug_backtrace_level > 0)
5416 {
5417 for (i = 0; i < debug_backtrace_level; i++)
5418 {
5419 temp_funccal = funccal->caller;
5420 if (temp_funccal)
5421 funccal = temp_funccal;
5422 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005423 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005424 debug_backtrace_level = i;
5425 }
5426 }
5427 return funccal;
5428}
5429
5430/*
5431 * Return the hashtable used for local variables in the current funccal.
5432 * Return NULL if there is no current funccal.
5433 */
5434 hashtab_T *
5435get_funccal_local_ht()
5436{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005437 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005438 return NULL;
5439 return &get_funccal()->l_vars.dv_hashtab;
5440}
5441
5442/*
5443 * Return the l: scope variable.
5444 * Return NULL if there is no current funccal.
5445 */
5446 dictitem_T *
5447get_funccal_local_var()
5448{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005449 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005450 return NULL;
5451 return &get_funccal()->l_vars_var;
5452}
5453
5454/*
5455 * Return the hashtable used for argument in the current funccal.
5456 * Return NULL if there is no current funccal.
5457 */
5458 hashtab_T *
5459get_funccal_args_ht()
5460{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005461 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005462 return NULL;
5463 return &get_funccal()->l_avars.dv_hashtab;
5464}
5465
5466/*
5467 * Return the a: scope variable.
5468 * Return NULL if there is no current funccal.
5469 */
5470 dictitem_T *
5471get_funccal_args_var()
5472{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005473 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005474 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005475 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476}
5477
5478/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005479 * List function variables, if there is a function.
5480 */
5481 void
5482list_func_vars(int *first)
5483{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005484 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005485 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005486 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487}
5488
5489/*
5490 * If "ht" is the hashtable for local variables in the current funccal, return
5491 * the dict that contains it.
5492 * Otherwise return NULL.
5493 */
5494 dict_T *
5495get_current_funccal_dict(hashtab_T *ht)
5496{
5497 if (current_funccal != NULL
5498 && ht == &current_funccal->l_vars.dv_hashtab)
5499 return &current_funccal->l_vars;
5500 return NULL;
5501}
5502
5503/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005504 * Search hashitem in parent scope.
5505 */
5506 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005507find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005508{
5509 funccall_T *old_current_funccal = current_funccal;
5510 hashtab_T *ht;
5511 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005512 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005513
5514 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5515 return NULL;
5516
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005517 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005518 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005519 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005520 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005521 ht = find_var_ht(name, &varname);
5522 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005523 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005524 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005525 if (!HASHITEM_EMPTY(hi))
5526 {
5527 *pht = ht;
5528 break;
5529 }
5530 }
5531 if (current_funccal == current_funccal->func->uf_scoped)
5532 break;
5533 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005534 }
5535 current_funccal = old_current_funccal;
5536
5537 return hi;
5538}
5539
5540/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005541 * Search variable in parent scope.
5542 */
5543 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005544find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005545{
5546 dictitem_T *v = NULL;
5547 funccall_T *old_current_funccal = current_funccal;
5548 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005549 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005550
5551 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5552 return NULL;
5553
Bram Moolenaare38eab22019-12-05 21:50:01 +01005554 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005555 current_funccal = current_funccal->func->uf_scoped;
5556 while (current_funccal)
5557 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005558 ht = find_var_ht(name, &varname);
5559 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005560 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005561 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005562 if (v != NULL)
5563 break;
5564 }
5565 if (current_funccal == current_funccal->func->uf_scoped)
5566 break;
5567 current_funccal = current_funccal->func->uf_scoped;
5568 }
5569 current_funccal = old_current_funccal;
5570
5571 return v;
5572}
5573
5574/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005575 * Set "copyID + 1" in previous_funccal and callers.
5576 */
5577 int
5578set_ref_in_previous_funccal(int copyID)
5579{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005580 funccall_T *fc;
5581
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005582 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005583 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005584 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005585 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5586 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5587 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5588 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005589 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005590 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005591}
5592
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005593 static int
5594set_ref_in_funccal(funccall_T *fc, int copyID)
5595{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005596 if (fc->fc_copyID != copyID)
5597 {
5598 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005599 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5600 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5601 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5602 || set_ref_in_func(NULL, fc->func, copyID))
5603 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005604 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005605 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005606}
5607
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005608/*
5609 * Set "copyID" in all local vars and arguments in the call stack.
5610 */
5611 int
5612set_ref_in_call_stack(int copyID)
5613{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005614 funccall_T *fc;
5615 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005616
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005617 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5618 if (set_ref_in_funccal(fc, copyID))
5619 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005620
5621 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005622 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5623 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5624 if (set_ref_in_funccal(fc, copyID))
5625 return TRUE;
5626 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005627}
5628
5629/*
5630 * Set "copyID" in all functions available by name.
5631 */
5632 int
5633set_ref_in_functions(int copyID)
5634{
5635 int todo;
5636 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005637 ufunc_T *fp;
5638
5639 todo = (int)func_hashtab.ht_used;
5640 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005641 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005642 if (!HASHITEM_EMPTY(hi))
5643 {
5644 --todo;
5645 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005646 if (!func_name_refcount(fp->uf_name)
5647 && set_ref_in_func(NULL, fp, copyID))
5648 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005649 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005650 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005651 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005652}
5653
5654/*
5655 * Set "copyID" in all function arguments.
5656 */
5657 int
5658set_ref_in_func_args(int copyID)
5659{
5660 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005661
5662 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005663 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5664 copyID, NULL, NULL))
5665 return TRUE;
5666 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005667}
5668
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005669/*
5670 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005671 * Returns TRUE if setting references failed somehow.
5672 */
5673 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005674set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005675{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005676 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005677 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005678 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005679 char_u fname_buf[FLEN_FIXED + 1];
5680 char_u *tofree = NULL;
5681 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005682 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005683
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005684 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005685 return FALSE;
5686
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005687 if (fp_in == NULL)
5688 {
5689 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005690 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005691 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005692 if (fp != NULL)
5693 {
5694 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005695 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005696 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005697
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005698 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005699 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005700}
5701
Bram Moolenaare38eab22019-12-05 21:50:01 +01005702#endif // FEAT_EVAL