blob: 52bacce35e6d30f70b0c0b0b0fa162321345d578 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000526 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
622function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623{
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643}
644
645/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200647 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
652get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657{
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664#define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200666 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100675 char_u *heredoc_trimmed = NULL;
676
Bram Moolenaar20677332021-06-06 17:02:53 +0200677 ga_init2(&heredoc_ga, 1, 500);
678
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
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 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001180 garray_T *tfgap = &evalarg->eval_tofree_ga;
1181
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001182 // Something comes after the "}".
1183 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001184
1185 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001186 if (ga_grow(tfgap, 1) == OK)
1187 {
1188 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1189 evalarg->eval_using_cmdline = TRUE;
1190 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001191 }
1192 else
1193 *arg = (char_u *)"";
1194
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001195 if (!evaluate)
1196 {
1197 ret = OK;
1198 goto erret;
1199 }
1200
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001201 name = get_lambda_name();
1202 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1203 if (ufunc == NULL)
1204 goto erret;
1205 set_ufunc_name(ufunc, name);
1206 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001207 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001208 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 ufunc->uf_refcount = 1;
1210 ufunc->uf_args = *newargs;
1211 newargs->ga_data = NULL;
1212 ufunc->uf_def_args = *default_args;
1213 default_args->ga_data = NULL;
1214 ufunc->uf_func_type = &t_func_any;
1215
1216 // error messages are for the first function line
1217 lnum_save = SOURCING_LNUM;
1218 SOURCING_LNUM = sourcing_lnum_top;
1219
1220 // parse argument types
1221 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1222 {
1223 SOURCING_LNUM = lnum_save;
1224 goto erret;
1225 }
1226
1227 // parse the return type, if any
1228 if (parse_return_type(ufunc, ret_type) == FAIL)
1229 goto erret;
1230
1231 pt = ALLOC_CLEAR_ONE(partial_T);
1232 if (pt == NULL)
1233 goto erret;
1234 pt->pt_func = ufunc;
1235 pt->pt_refcount = 1;
1236
1237 ufunc->uf_lines = newlines;
1238 newlines.ga_data = NULL;
1239 if (sandbox)
1240 ufunc->uf_flags |= FC_SANDBOX;
1241 if (!ASCII_ISUPPER(*ufunc->uf_name))
1242 ufunc->uf_flags |= FC_VIM9;
1243 ufunc->uf_script_ctx = current_sctx;
1244 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1245 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1246 set_function_type(ufunc);
1247
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001248 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1249
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001250 rettv->vval.v_partial = pt;
1251 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001252 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001253 ret = OK;
1254
1255erret:
1256 if (lnum_save >= 0)
1257 SOURCING_LNUM = lnum_save;
1258 vim_free(line_to_free);
1259 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001260 if (newargs != NULL)
1261 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001263 if (ufunc != NULL)
1264 {
1265 func_clear(ufunc, TRUE);
1266 func_free(ufunc, TRUE);
1267 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001268 return ret;
1269}
1270
1271/*
1272 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001273 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001274 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001275 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1276 */
1277 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001278get_lambda_tv(
1279 char_u **arg,
1280 typval_T *rettv,
1281 int types_optional,
1282 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001284 int evaluate = evalarg != NULL
1285 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286 garray_T newargs;
1287 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001288 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001289 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001290 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001292 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001294 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001296 char_u *s;
1297 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001298 int *old_eval_lavars = eval_lavars_used;
1299 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001300 char_u *tofree1 = NULL;
1301 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001302 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001303 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001304 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001305
1306 if (equal_arrow && !in_vim9script())
1307 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001308
1309 ga_init(&newargs);
1310 ga_init(&newlines);
1311
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001312 // First, check if this is really a lambda expression. "->" or "=>" must
1313 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001314 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001315 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001316 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001317 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001318 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001319 {
1320 if (types_optional)
1321 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001322 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001323 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001325 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001326 if (evaluate)
1327 pnewargs = &newargs;
1328 else
1329 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001330 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001331 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001332 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001333 &varargs, &default_args,
1334 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001336 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001337 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001338 {
1339 if (types_optional)
1340 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001341 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001342 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001343 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001344 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001345
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001346 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1347 if (ret_type != NULL)
1348 {
1349 ret_type = vim_strsave(ret_type);
1350 tofree2 = ret_type;
1351 }
1352
Bram Moolenaare38eab22019-12-05 21:50:01 +01001353 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001354 if (evaluate)
1355 eval_lavars_used = &eval_lavars;
1356
Bram Moolenaar65c44152020-12-24 15:14:01 +01001357 *arg = skipwhite_and_linebreak(*arg, evalarg);
1358
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001359 // Recognize "{" as the start of a function body.
1360 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001361 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001362 if (evalarg == NULL)
1363 // cannot happen?
1364 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001365 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1366 types_optional ? &argtypes : NULL, varargs,
1367 &default_args, ret_type) == FAIL)
1368 goto errret;
1369 goto theend;
1370 }
1371 if (default_args.ga_len > 0)
1372 {
1373 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001374 goto errret;
1375 }
1376
Bram Moolenaare38eab22019-12-05 21:50:01 +01001377 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001378 start = *arg;
1379 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380 if (ret == FAIL)
1381 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001382 if (evalarg != NULL)
1383 {
1384 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001385 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001386 evalarg->eval_tofree = NULL;
1387 }
1388
Bram Moolenaar65c44152020-12-24 15:14:01 +01001389 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001390 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001391 *arg = skipwhite_and_linebreak(*arg, evalarg);
1392 if (**arg != '}')
1393 {
1394 semsg(_("E451: Expected }: %s"), *arg);
1395 goto errret;
1396 }
1397 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399
1400 if (evaluate)
1401 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001402 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001403 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001404 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001405 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001406 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001407
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001408 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409 if (fp == NULL)
1410 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001411 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001412 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001413 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001414 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1417 if (ga_grow(&newlines, 1) == FAIL)
1418 goto errret;
1419
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001420 // If there are line breaks, we need to split up the string.
1421 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001422 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001423 line_end = end;
1424
1425 // Add "return " before the expression (or the first line).
1426 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001427 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001428 if (p == NULL)
1429 goto errret;
1430 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1431 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001432 vim_strncpy(p + 7, start, line_end - start);
1433
1434 if (line_end != end)
1435 {
1436 // Add more lines, split by line breaks. Thus is used when a
1437 // lambda with { cmds } is encountered.
1438 while (*line_end == '\n')
1439 {
1440 if (ga_grow(&newlines, 1) == FAIL)
1441 goto errret;
1442 start = line_end + 1;
1443 line_end = vim_strchr(start, '\n');
1444 if (line_end == NULL)
1445 line_end = end;
1446 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1447 vim_strnsave(start, line_end - start);
1448 }
1449 }
1450
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001451 if (strstr((char *)p + 7, "a:") == NULL)
1452 // No a: variables are used for sure.
1453 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454
1455 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001456 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001458 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001459 if (types_optional)
1460 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001461 if (parse_argument_types(fp, &argtypes,
1462 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001463 goto errret;
1464 if (ret_type != NULL)
1465 {
1466 fp->uf_ret_type = parse_type(&ret_type,
1467 &fp->uf_type_list, TRUE);
1468 if (fp->uf_ret_type == NULL)
1469 goto errret;
1470 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001471 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001472 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001473 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001474
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001476 if (current_funccal != NULL && eval_lavars)
1477 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001478 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001479 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001480 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001481 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482
1483#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484 if (prof_def_func())
1485 func_do_profile(fp);
1486#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001487 if (sandbox)
1488 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001489 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001490 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1491 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001492 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001493 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001494 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001495 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001497 function_using_block_scopes(fp, evalarg->eval_cstack);
1498
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001499 pt->pt_func = fp;
1500 pt->pt_refcount = 1;
1501 rettv->vval.v_partial = pt;
1502 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001503
1504 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001507theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001508 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001509 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001510 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001511 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001512 vim_free(tofree1);
1513 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001514 if (types_optional)
1515 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001516
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 return OK;
1518
1519errret:
1520 ga_clear_strings(&newargs);
1521 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001522 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001523 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001524 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001525 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001526 if (fp != NULL)
1527 vim_free(fp->uf_arg_types);
1528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001530 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001531 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001532 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001533 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001534 vim_free(tofree1);
1535 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001536 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 return FAIL;
1538}
1539
1540/*
1541 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1542 * name it contains, otherwise return "name".
1543 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1544 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001545 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1546 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001547 */
1548 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001549deref_func_name(
1550 char_u *name,
1551 int *lenp,
1552 partial_T **partialp,
1553 type_T **type,
1554 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555{
1556 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001557 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001558 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001559 char_u *s = NULL;
1560 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001561 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562
1563 if (partialp != NULL)
1564 *partialp = NULL;
1565
1566 cc = name[*lenp];
1567 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001568
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001569 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001571 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001573 tv = &v->di_tv;
1574 }
1575 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1576 {
1577 imported_T *import;
1578 char_u *p = name;
1579 int len = *lenp;
1580
1581 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001583 p = name + 2;
1584 len -= 2;
1585 }
1586 import = find_imported(p, len, NULL);
1587
1588 // imported variable from another script
1589 if (import != NULL)
1590 {
1591 if (import->imp_funcname != NULL)
1592 {
1593 s = import->imp_funcname;
1594 *lenp = (int)STRLEN(s);
1595 return s;
1596 }
1597 // TODO: what if (import->imp_flags & IMP_FLAGS_STAR)
1598 {
1599 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1600 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1601 + import->imp_var_vals_idx;
1602 tv = sv->sv_tv;
1603 if (type != NULL)
1604 *type = sv->sv_type;
1605 did_type = TRUE;
1606 }
1607 }
1608 }
1609
1610 if (tv != NULL)
1611 {
1612 if (tv->v_type == VAR_FUNC)
1613 {
1614 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001615 {
1616 *lenp = 0;
1617 return (char_u *)""; // just in case
1618 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001619 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001620 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001623 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001625 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001626
1627 if (pt == NULL)
1628 {
1629 *lenp = 0;
1630 return (char_u *)""; // just in case
1631 }
1632 if (partialp != NULL)
1633 *partialp = pt;
1634 s = partial_name(pt);
1635 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001637
1638 if (s != NULL)
1639 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001640 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001641 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001642 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001643
1644 if (sv != NULL)
1645 *type = sv->sv_type;
1646 }
1647 return s;
1648 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 }
1650
1651 return name;
1652}
1653
1654/*
1655 * Give an error message with a function name. Handle <SNR> things.
1656 * "ermsg" is to be passed without translation, use N_() instead of _().
1657 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001658 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001659emsg_funcname(char *ermsg, char_u *name)
1660{
1661 char_u *p;
1662
1663 if (*name == K_SPECIAL)
1664 p = concat_str((char_u *)"<SNR>", name + 3);
1665 else
1666 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001667 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001668 if (p != name)
1669 vim_free(p);
1670}
1671
1672/*
1673 * Allocate a variable for the result of a function.
1674 * Return OK or FAIL.
1675 */
1676 int
1677get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001678 char_u *name, // name of the function
1679 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001681 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001682 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001683 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684{
1685 char_u *argp;
1686 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001687 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1688 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001689 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690
1691 /*
1692 * Get the arguments.
1693 */
1694 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001695 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1696 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001698 // skip the '(' or ',' and possibly line breaks
1699 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1700
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 if (*argp == ')' || *argp == ',' || *argp == NUL)
1702 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001703 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001704 {
1705 ret = FAIL;
1706 break;
1707 }
1708 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001709 // The comma should come right after the argument, but this wasn't
1710 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001711 if (vim9script)
1712 {
1713 if (*argp != ',' && *skipwhite(argp) == ',')
1714 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001715 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001716 ret = FAIL;
1717 break;
1718 }
1719 }
1720 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001721 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 if (*argp != ',')
1723 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001724 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1725 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001726 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001727 ret = FAIL;
1728 break;
1729 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001731 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 if (*argp == ')')
1733 ++argp;
1734 else
1735 ret = FAIL;
1736
1737 if (ret == OK)
1738 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001739 int i = 0;
1740 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741
1742 if (get_vim_var_nr(VV_TESTING))
1743 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001744 // Prepare for calling test_garbagecollect_now(), need to know
1745 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001746 if (funcargs.ga_itemsize == 0)
1747 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1748 for (i = 0; i < argcount; ++i)
1749 if (ga_grow(&funcargs, 1) == OK)
1750 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1751 &argvars[i];
1752 }
1753
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001754 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001755 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001756 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001757 // An error in a builtin function does not return FAIL, but we do
1758 // want to abort further processing if an error was given.
1759 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001760 clear_tv(rettv);
1761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762
1763 funcargs.ga_len -= i;
1764 }
1765 else if (!aborting())
1766 {
1767 if (argcount == MAX_FUNC_ARGS)
1768 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1769 else
1770 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1771 }
1772
1773 while (--argcount >= 0)
1774 clear_tv(&argvars[argcount]);
1775
Bram Moolenaar8294d492020-08-10 22:40:56 +02001776 if (in_vim9script())
1777 *arg = argp;
1778 else
1779 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780 return ret;
1781}
1782
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783/*
1784 * Return TRUE if "p" starts with "<SID>" or "s:".
1785 * Only works if eval_fname_script() returned non-zero for "p"!
1786 */
1787 static int
1788eval_fname_sid(char_u *p)
1789{
1790 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1791}
1792
1793/*
1794 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1795 * Change <SNR>123_name() to K_SNR 123_name().
1796 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1797 * (slow).
1798 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001799 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1801{
1802 int llen;
1803 char_u *fname;
1804 int i;
1805
1806 llen = eval_fname_script(name);
1807 if (llen > 0)
1808 {
1809 fname_buf[0] = K_SPECIAL;
1810 fname_buf[1] = KS_EXTRA;
1811 fname_buf[2] = (int)KE_SNR;
1812 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001813 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001815 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001816 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001817 else
1818 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001819 sprintf((char *)fname_buf + 3, "%ld_",
1820 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821 i = (int)STRLEN(fname_buf);
1822 }
1823 }
1824 if (i + STRLEN(name + llen) < FLEN_FIXED)
1825 {
1826 STRCPY(fname_buf + i, name + llen);
1827 fname = fname_buf;
1828 }
1829 else
1830 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001831 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001832 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001833 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 else
1835 {
1836 *tofree = fname;
1837 mch_memmove(fname, fname_buf, (size_t)i);
1838 STRCPY(fname + i, name + llen);
1839 }
1840 }
1841 }
1842 else
1843 fname = name;
1844 return fname;
1845}
1846
1847/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001848 * Find a function "name" in script "sid".
1849 */
1850 static ufunc_T *
1851find_func_with_sid(char_u *name, int sid)
1852{
1853 hashitem_T *hi;
1854 char_u buffer[200];
1855
1856 buffer[0] = K_SPECIAL;
1857 buffer[1] = KS_EXTRA;
1858 buffer[2] = (int)KE_SNR;
1859 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1860 (long)sid, name);
1861 hi = hash_find(&func_hashtab, buffer);
1862 if (!HASHITEM_EMPTY(hi))
1863 return HI2UF(hi);
1864
1865 return NULL;
1866}
1867
1868/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001869 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001870 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001871 * Return NULL for unknown function.
1872 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001873 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001874find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875{
1876 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001877 ufunc_T *func;
1878 imported_T *imported;
1879
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001880 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001882 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001883 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001884 int find_script_local = in_vim9script()
1885 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001886
Bram Moolenaar95006e32020-08-29 17:47:08 +02001887 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001889 // Find script-local function before global one.
1890 func = find_func_with_sid(name, current_sctx.sc_sid);
1891 if (func != NULL)
1892 return func;
1893 }
1894
Bram Moolenaarefa94442020-08-08 22:16:00 +02001895 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001896 && name[1] == KS_EXTRA
1897 && name[2] == KE_SNR)
1898 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001899 // Caller changes s: to <SNR>99_name.
1900
1901 after_script = name + 3;
1902 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001903 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001904 ++after_script;
1905 else
1906 after_script = NULL;
1907 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001908 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001909 {
1910 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001911 if (after_script != NULL && sid != current_sctx.sc_sid)
1912 imported = find_imported_in_script(after_script, 0, sid);
1913 else
1914 imported = find_imported(after_script == NULL
1915 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001916 if (imported != NULL && imported->imp_funcname != NULL)
1917 {
1918 hi = hash_find(&func_hashtab, imported->imp_funcname);
1919 if (!HASHITEM_EMPTY(hi))
1920 return HI2UF(hi);
1921 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001922 }
1923 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001924
Bram Moolenaara26b9702020-04-18 19:53:28 +02001925 hi = hash_find(&func_hashtab,
1926 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 if (!HASHITEM_EMPTY(hi))
1928 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001929
1930 return NULL;
1931}
1932
1933/*
1934 * Find a function by name, return pointer to it in ufuncs.
1935 * "cctx" is passed in a :def function to find imported functions.
1936 * Return NULL for unknown or dead function.
1937 */
1938 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001939find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001940{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001941 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942
1943 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1944 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945 return NULL;
1946}
1947
1948/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001949 * Return TRUE if "ufunc" is a global function.
1950 */
1951 int
1952func_is_global(ufunc_T *ufunc)
1953{
1954 return ufunc->uf_name[0] != K_SPECIAL;
1955}
1956
1957/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958 * Copy the function name of "fp" to buffer "buf".
1959 * "buf" must be able to hold the function name plus three bytes.
1960 * Takes care of script-local function names.
1961 */
1962 static void
1963cat_func_name(char_u *buf, ufunc_T *fp)
1964{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001965 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001966 {
1967 STRCPY(buf, "<SNR>");
1968 STRCAT(buf, fp->uf_name + 3);
1969 }
1970 else
1971 STRCPY(buf, fp->uf_name);
1972}
1973
1974/*
1975 * Add a number variable "name" to dict "dp" with value "nr".
1976 */
1977 static void
1978add_nr_var(
1979 dict_T *dp,
1980 dictitem_T *v,
1981 char *name,
1982 varnumber_T nr)
1983{
1984 STRCPY(v->di_key, name);
1985 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1986 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1987 v->di_tv.v_type = VAR_NUMBER;
1988 v->di_tv.v_lock = VAR_FIXED;
1989 v->di_tv.vval.v_number = nr;
1990}
1991
1992/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001993 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001994 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001995 static void
1996free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001998 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001999
2000 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2001 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002002 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002003
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002004 // When garbage collecting a funccall_T may be freed before the
2005 // function that references it, clear its uf_scoped field.
2006 // The function may have been redefined and point to another
2007 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002008 if (fp != NULL && fp->uf_scoped == fc)
2009 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002010 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002011 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002012
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002013 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 vim_free(fc);
2015}
2016
2017/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002018 * Free "fc" and what it contains.
2019 * Can be called only when "fc" is kept beyond the period of it called,
2020 * i.e. after cleanup_function_call(fc).
2021 */
2022 static void
2023free_funccal_contents(funccall_T *fc)
2024{
2025 listitem_T *li;
2026
2027 // Free all l: variables.
2028 vars_clear(&fc->l_vars.dv_hashtab);
2029
2030 // Free all a: variables.
2031 vars_clear(&fc->l_avars.dv_hashtab);
2032
2033 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002034 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002035 clear_tv(&li->li_tv);
2036
2037 free_funccal(fc);
2038}
2039
2040/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002041 * Handle the last part of returning from a function: free the local hashtable.
2042 * Unless it is still in use by a closure.
2043 */
2044 static void
2045cleanup_function_call(funccall_T *fc)
2046{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002047 int may_free_fc = fc->fc_refcount <= 0;
2048 int free_fc = TRUE;
2049
Bram Moolenaar6914c642017-04-01 21:21:30 +02002050 current_funccal = fc->caller;
2051
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002052 // Free all l: variables if not referred.
2053 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2054 vars_clear(&fc->l_vars.dv_hashtab);
2055 else
2056 free_fc = FALSE;
2057
2058 // If the a:000 list and the l: and a: dicts are not referenced and
2059 // there is no closure using it, we can free the funccall_T and what's
2060 // in it.
2061 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2062 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002063 else
2064 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002065 int todo;
2066 hashitem_T *hi;
2067 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002068
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002069 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002070
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002071 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002072 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2073 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2074 {
2075 if (!HASHITEM_EMPTY(hi))
2076 {
2077 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002078 di = HI2DI(hi);
2079 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002080 }
2081 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002082 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002083
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002084 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2085 fc->l_varlist.lv_first = NULL;
2086 else
2087 {
2088 listitem_T *li;
2089
2090 free_fc = FALSE;
2091
2092 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002093 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002094 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002095 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002096
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002097 if (free_fc)
2098 free_funccal(fc);
2099 else
2100 {
2101 static int made_copy = 0;
2102
2103 // "fc" is still in use. This can happen when returning "a:000",
2104 // assigning "l:" to a global variable or defining a closure.
2105 // Link "fc" in the list for garbage collection later.
2106 fc->caller = previous_funccal;
2107 previous_funccal = fc;
2108
2109 if (want_garbage_collect)
2110 // If garbage collector is ready, clear count.
2111 made_copy = 0;
2112 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002113 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002114 // We have made a lot of copies, worth 4 Mbyte. This can happen
2115 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002116 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002117 // too much memory.
2118 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002119 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002120 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002121 }
2122}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002123
2124/*
2125 * There are two kinds of function names:
2126 * 1. ordinary names, function defined with :function or :def
2127 * 2. numbered functions and lambdas
2128 * For the first we only count the name stored in func_hashtab as a reference,
2129 * using function() does not count as a reference, because the function is
2130 * looked up by name.
2131 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002132 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002133func_name_refcount(char_u *name)
2134{
2135 return isdigit(*name) || *name == '<';
2136}
2137
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002138/*
2139 * Unreference "fc": decrement the reference count and free it when it
2140 * becomes zero. "fp" is detached from "fc".
2141 * When "force" is TRUE we are exiting.
2142 */
2143 static void
2144funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2145{
2146 funccall_T **pfc;
2147 int i;
2148
2149 if (fc == NULL)
2150 return;
2151
2152 if (--fc->fc_refcount <= 0 && (force || (
2153 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2154 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2155 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2156 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2157 {
2158 if (fc == *pfc)
2159 {
2160 *pfc = fc->caller;
2161 free_funccal_contents(fc);
2162 return;
2163 }
2164 }
2165 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2166 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2167 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2168}
2169
2170/*
2171 * Remove the function from the function hashtable. If the function was
2172 * deleted while it still has references this was already done.
2173 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2174 */
2175 static int
2176func_remove(ufunc_T *fp)
2177{
2178 hashitem_T *hi;
2179
2180 // Return if it was already virtually deleted.
2181 if (fp->uf_flags & FC_DEAD)
2182 return FALSE;
2183
2184 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2185 if (!HASHITEM_EMPTY(hi))
2186 {
2187 // When there is a def-function index do not actually remove the
2188 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002189 // Do remove it when it's a copy.
2190 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002191 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002192 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002193 return FALSE;
2194 }
2195 hash_remove(&func_hashtab, hi);
2196 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002197 return TRUE;
2198 }
2199 return FALSE;
2200}
2201
2202 static void
2203func_clear_items(ufunc_T *fp)
2204{
2205 ga_clear_strings(&(fp->uf_args));
2206 ga_clear_strings(&(fp->uf_def_args));
2207 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002208 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002209 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002210 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002211 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002212
2213 // Increment the refcount of this function to avoid it being freed
2214 // recursively when the partial is freed.
2215 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002216 partial_unref(fp->uf_partial);
2217 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002218 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002219
2220#ifdef FEAT_LUA
2221 if (fp->uf_cb_free != NULL)
2222 {
2223 fp->uf_cb_free(fp->uf_cb_state);
2224 fp->uf_cb_free = NULL;
2225 }
2226
2227 fp->uf_cb_state = NULL;
2228 fp->uf_cb = NULL;
2229#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002230#ifdef FEAT_PROFILE
2231 VIM_CLEAR(fp->uf_tml_count);
2232 VIM_CLEAR(fp->uf_tml_total);
2233 VIM_CLEAR(fp->uf_tml_self);
2234#endif
2235}
2236
2237/*
2238 * Free all things that a function contains. Does not free the function
2239 * itself, use func_free() for that.
2240 * When "force" is TRUE we are exiting.
2241 */
2242 static void
2243func_clear(ufunc_T *fp, int force)
2244{
2245 if (fp->uf_cleared)
2246 return;
2247 fp->uf_cleared = TRUE;
2248
2249 // clear this function
2250 func_clear_items(fp);
2251 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002252 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002253}
2254
2255/*
2256 * Free a function and remove it from the list of functions. Does not free
2257 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002258 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002259 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002260 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002261 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002262func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002263{
2264 // Only remove it when not done already, otherwise we would remove a newer
2265 // version of the function with the same name.
2266 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2267 func_remove(fp);
2268
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002269 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002270 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002271 if (fp->uf_dfunc_idx > 0)
2272 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002273 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002275 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002276 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002277 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002278}
2279
2280/*
2281 * Free all things that a function contains and free the function itself.
2282 * When "force" is TRUE we are exiting.
2283 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002284 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002285func_clear_free(ufunc_T *fp, int force)
2286{
2287 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002288 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2289 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002290 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002291 else
2292 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293}
2294
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002295/*
2296 * Copy already defined function "lambda" to a new function with name "global".
2297 * This is for when a compiled function defines a global function.
2298 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002299 int
2300copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002301{
2302 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002303 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002304
2305 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002306 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002307 semsg(_(e_lambda_function_not_found_str), lambda);
2308 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002309 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002310
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002311 fp = find_func(global, TRUE, NULL);
2312 if (fp != NULL)
2313 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002314 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002315 semsg(_(e_funcexts), global);
2316 return FAIL;
2317 }
2318
2319 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2320 if (fp == NULL)
2321 return FAIL;
2322
2323 fp->uf_varargs = ufunc->uf_varargs;
2324 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2325 fp->uf_def_status = ufunc->uf_def_status;
2326 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2327 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2328 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2329 == FAIL
2330 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2331 goto failed;
2332
2333 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2334 : vim_strsave(ufunc->uf_name_exp);
2335 if (ufunc->uf_arg_types != NULL)
2336 {
2337 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2338 if (fp->uf_arg_types == NULL)
2339 goto failed;
2340 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2341 sizeof(type_T *) * fp->uf_args.ga_len);
2342 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002343 if (ufunc->uf_va_name != NULL)
2344 {
2345 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2346 if (fp->uf_va_name == NULL)
2347 goto failed;
2348 }
2349 fp->uf_ret_type = ufunc->uf_ret_type;
2350
2351 fp->uf_refcount = 1;
2352 STRCPY(fp->uf_name, global);
2353 hash_add(&func_hashtab, UF2HIKEY(fp));
2354
2355 // the referenced dfunc_T is now used one more time
2356 link_def_function(fp);
2357
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002358 // Create a partial to store the context of the function where it was
2359 // instantiated. Only needs to be done once. Do this on the original
2360 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002361 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2362 {
2363 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2364
2365 if (pt == NULL)
2366 goto failed;
2367 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002368 {
2369 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002370 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002371 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002372 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002373 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002374 }
2375
2376 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002377
2378failed:
2379 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002380 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002381}
2382
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002383static int funcdepth = 0;
2384
2385/*
2386 * Increment the function call depth count.
2387 * Return FAIL when going over 'maxfuncdepth'.
2388 * Otherwise return OK, must call funcdepth_decrement() later!
2389 */
2390 int
2391funcdepth_increment(void)
2392{
2393 if (funcdepth >= p_mfd)
2394 {
2395 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2396 return FAIL;
2397 }
2398 ++funcdepth;
2399 return OK;
2400}
2401
2402 void
2403funcdepth_decrement(void)
2404{
2405 --funcdepth;
2406}
2407
2408/*
2409 * Get the current function call depth.
2410 */
2411 int
2412funcdepth_get(void)
2413{
2414 return funcdepth;
2415}
2416
2417/*
2418 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002419 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002420 * times as funcdepth_increment().
2421 */
2422 void
2423funcdepth_restore(int depth)
2424{
2425 funcdepth = depth;
2426}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002427
2428/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 * Call a user function.
2430 */
2431 static void
2432call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002433 ufunc_T *fp, // pointer to function
2434 int argcount, // nr of args
2435 typval_T *argvars, // arguments
2436 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002437 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002438 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002440 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002441 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 funccall_T *fc;
2443 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002444 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002446 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 int i;
2448 int ai;
2449 int islambda = FALSE;
2450 char_u numbuf[NUMBUFLEN];
2451 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002452 typval_T *tv_to_free[MAX_FUNC_ARGS];
2453 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002455 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002456#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002457 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458
Bram Moolenaarb2049902021-01-24 12:53:53 +01002459#ifdef FEAT_PROFILE
2460 CLEAR_FIELD(profile_info);
2461#endif
2462
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002463 // If depth of calling is getting too high, don't execute the function.
2464 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002465 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 rettv->v_type = VAR_NUMBER;
2467 rettv->vval.v_number = -1;
2468 return;
2469 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470
Bram Moolenaare38eab22019-12-05 21:50:01 +01002471 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002473 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002474 if (fc == NULL)
2475 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 fc->caller = current_funccal;
2477 current_funccal = fc;
2478 fc->func = fp;
2479 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002481 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2483 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002484 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002485 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002486 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002488 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002489 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002490#ifdef FEAT_PROFILE
2491 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2492#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002493 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002494#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002495 if (do_profiling == PROF_YES)
2496 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002497#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002498 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002499 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002500#ifdef FEAT_PROFILE
2501 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002502 || (caller != NULL && caller->uf_profiling)))
2503 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002504#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002505 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002506 free_funccal(fc);
2507 return;
2508 }
2509
Bram Moolenaar38453522021-11-28 22:00:12 +00002510 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511
2512 /*
2513 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2514 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2515 * each argument variable and saves a lot of time.
2516 */
2517 /*
2518 * Init l: variables.
2519 */
2520 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2521 if (selfdict != NULL)
2522 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002523 // Set l:self to "selfdict". Use "name" to avoid a warning from
2524 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 v = &fc->fixvar[fixvar_idx++].var;
2526 name = v->di_key;
2527 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002528 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2530 v->di_tv.v_type = VAR_DICT;
2531 v->di_tv.v_lock = 0;
2532 v->di_tv.vval.v_dict = selfdict;
2533 ++selfdict->dv_refcount;
2534 }
2535
2536 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002537 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002538 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 * Set a:000 to a list with room for the "..." arguments.
2540 */
2541 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002542 if ((fp->uf_flags & FC_NOARGS) == 0)
2543 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002544 (varnumber_T)(argcount >= fp->uf_args.ga_len
2545 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002546 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002547 if ((fp->uf_flags & FC_NOARGS) == 0)
2548 {
2549 // Use "name" to avoid a warning from some compiler that checks the
2550 // destination size.
2551 v = &fc->fixvar[fixvar_idx++].var;
2552 name = v->di_key;
2553 STRCPY(name, "000");
2554 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2555 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2556 v->di_tv.v_type = VAR_LIST;
2557 v->di_tv.v_lock = VAR_FIXED;
2558 v->di_tv.vval.v_list = &fc->l_varlist;
2559 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002560 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2562 fc->l_varlist.lv_lock = VAR_FIXED;
2563
2564 /*
2565 * Set a:firstline to "firstline" and a:lastline to "lastline".
2566 * Set a:name to named arguments.
2567 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002568 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002570 if ((fp->uf_flags & FC_NOARGS) == 0)
2571 {
2572 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002573 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002574 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002575 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002576 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002577 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 {
2579 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002580 typval_T def_rettv;
2581 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582
2583 ai = i - fp->uf_args.ga_len;
2584 if (ai < 0)
2585 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002586 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 name = FUNCARG(fp, i);
2588 if (islambda)
2589 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002590
2591 // evaluate named argument default expression
2592 isdefault = ai + fp->uf_def_args.ga_len >= 0
2593 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2594 && argvars[i].vval.v_number == VVAL_NONE));
2595 if (isdefault)
2596 {
2597 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002598
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002599 def_rettv.v_type = VAR_NUMBER;
2600 def_rettv.vval.v_number = -1;
2601
2602 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2603 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002604 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002605 {
2606 default_arg_err = 1;
2607 break;
2608 }
2609 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 }
2611 else
2612 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002613 if ((fp->uf_flags & FC_NOARGS) != 0)
2614 // Bail out if no a: arguments used (in lambda).
2615 break;
2616
Bram Moolenaare38eab22019-12-05 21:50:01 +01002617 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 sprintf((char *)numbuf, "%d", ai + 1);
2619 name = numbuf;
2620 }
2621 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2622 {
2623 v = &fc->fixvar[fixvar_idx++].var;
2624 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002625 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 }
2627 else
2628 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002629 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 if (v == NULL)
2631 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002632 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002635 // Note: the values are copied directly to avoid alloc/free.
2636 // "argvars" must have VAR_FIXED for v_lock.
2637 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 v->di_tv.v_lock = VAR_FIXED;
2639
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002640 if (isdefault)
2641 // Need to free this later, no matter where it's stored.
2642 tv_to_free[tv_to_free_len++] = &v->di_tv;
2643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 if (addlocal)
2645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // Named arguments should be accessed without the "a:" prefix in
2647 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002648 copy_tv(&v->di_tv, &v->di_tv);
2649 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002651 else
2652 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653
2654 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2655 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002656 listitem_T *li = &fc->l_listitems[ai];
2657
2658 li->li_tv = argvars[i];
2659 li->li_tv.v_lock = VAR_FIXED;
2660 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 }
2662 }
2663
Bram Moolenaare38eab22019-12-05 21:50:01 +01002664 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002666
2667 if (fp->uf_flags & FC_SANDBOX)
2668 {
2669 using_sandbox = TRUE;
2670 ++sandbox;
2671 }
2672
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002673 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002674 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002675 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002677 ++no_wait_return;
2678 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002680 smsg(_("calling %s"), SOURCING_NAME);
2681 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002683 char_u buf[MSG_BUF_LEN];
2684 char_u numbuf2[NUMBUFLEN];
2685 char_u *tofree;
2686 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002688 msg_puts("(");
2689 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002691 if (i > 0)
2692 msg_puts(", ");
2693 if (argvars[i].v_type == VAR_NUMBER)
2694 msg_outnum((long)argvars[i].vval.v_number);
2695 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002697 // Do not want errors such as E724 here.
2698 ++emsg_off;
2699 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2700 --emsg_off;
2701 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002703 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002705 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2706 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002708 msg_puts((char *)s);
2709 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 }
2711 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002713 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002715 msg_puts("\n"); // don't overwrite this either
2716
2717 verbose_leave_scroll();
2718 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 }
2720#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002721 if (do_profiling == PROF_YES)
2722 profile_may_start_func(&profile_info, fp,
2723 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724#endif
2725
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002726 save_current_sctx = current_sctx;
2727 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 save_did_emsg = did_emsg;
2729 did_emsg = FALSE;
2730
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002731 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2732 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002733 else if (islambda)
2734 {
2735 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2736
2737 // A Lambda always has the command "return {expr}". It is much faster
2738 // to evaluate {expr} directly.
2739 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002740 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002741 --ex_nesting_level;
2742 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002743 else
2744 // call do_cmdline() to execute the lines
2745 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2747
2748 --RedrawingDisabled;
2749
Bram Moolenaare38eab22019-12-05 21:50:01 +01002750 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2752 {
2753 clear_tv(rettv);
2754 rettv->v_type = VAR_NUMBER;
2755 rettv->vval.v_number = -1;
2756 }
2757
2758#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002759 if (do_profiling == PROF_YES)
2760 {
2761 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2762
2763 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2764 profile_may_end_func(&profile_info, fp, caller);
2765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766#endif
2767
Bram Moolenaare38eab22019-12-05 21:50:01 +01002768 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 if (p_verbose >= 12)
2770 {
2771 ++no_wait_return;
2772 verbose_enter_scroll();
2773
2774 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002775 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002777 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 (long)fc->rettv->vval.v_number);
2779 else
2780 {
2781 char_u buf[MSG_BUF_LEN];
2782 char_u numbuf2[NUMBUFLEN];
2783 char_u *tofree;
2784 char_u *s;
2785
Bram Moolenaare38eab22019-12-05 21:50:01 +01002786 // The value may be very long. Skip the middle part, so that we
2787 // have some idea how it starts and ends. smsg() would always
2788 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789 ++emsg_off;
2790 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2791 --emsg_off;
2792 if (s != NULL)
2793 {
2794 if (vim_strsize(s) > MSG_BUF_CLEN)
2795 {
2796 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2797 s = buf;
2798 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002799 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 vim_free(tofree);
2801 }
2802 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002803 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804
2805 verbose_leave_scroll();
2806 --no_wait_return;
2807 }
2808
Bram Moolenaare31ee862020-01-07 20:59:34 +01002809 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002810 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002811 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812#ifdef FEAT_PROFILE
2813 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002814 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002816 if (using_sandbox)
2817 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002819 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 {
2821 ++no_wait_return;
2822 verbose_enter_scroll();
2823
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002825 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826
2827 verbose_leave_scroll();
2828 --no_wait_return;
2829 }
2830
2831 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002832 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002833 for (i = 0; i < tv_to_free_len; ++i)
2834 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002835 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836}
2837
2838/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002839 * Check the argument count for user function "fp".
2840 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2841 */
2842 int
2843check_user_func_argcount(ufunc_T *fp, int argcount)
2844{
2845 int regular_args = fp->uf_args.ga_len;
2846
2847 if (argcount < regular_args - fp->uf_def_args.ga_len)
2848 return FCERR_TOOFEW;
2849 else if (!has_varargs(fp) && argcount > regular_args)
2850 return FCERR_TOOMANY;
2851 return FCERR_UNKNOWN;
2852}
2853
2854/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002856 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 int
2858call_user_func_check(
2859 ufunc_T *fp,
2860 int argcount,
2861 typval_T *argvars,
2862 typval_T *rettv,
2863 funcexe_T *funcexe,
2864 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002865{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002866 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002867
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002868 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2869 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002870 error = check_user_func_argcount(fp, argcount);
2871 if (error != FCERR_UNKNOWN)
2872 return error;
2873 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002874 error = FCERR_DICT;
2875 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002876 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002877 int did_save_redo = FALSE;
2878 save_redo_T save_redo;
2879
2880 /*
2881 * Call the user function.
2882 * Save and restore search patterns, script variables and
2883 * redo buffer.
2884 */
2885 save_search_patterns();
2886 if (!ins_compl_active())
2887 {
2888 saveRedobuff(&save_redo);
2889 did_save_redo = TRUE;
2890 }
2891 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002892 call_user_func(fp, argcount, argvars, rettv, funcexe,
2893 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002894 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2895 // Function was unreferenced while being used, free it now.
2896 func_clear_free(fp, FALSE);
2897 if (did_save_redo)
2898 restoreRedobuff(&save_redo);
2899 restore_search_patterns();
2900 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002901 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002903}
2904
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002905static funccal_entry_T *funccal_stack = NULL;
2906
2907/*
2908 * Save the current function call pointer, and set it to NULL.
2909 * Used when executing autocommands and for ":source".
2910 */
2911 void
2912save_funccal(funccal_entry_T *entry)
2913{
2914 entry->top_funccal = current_funccal;
2915 entry->next = funccal_stack;
2916 funccal_stack = entry;
2917 current_funccal = NULL;
2918}
2919
2920 void
2921restore_funccal(void)
2922{
2923 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002924 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002925 else
2926 {
2927 current_funccal = funccal_stack->top_funccal;
2928 funccal_stack = funccal_stack->next;
2929 }
2930}
2931
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002932 funccall_T *
2933get_current_funccal(void)
2934{
2935 return current_funccal;
2936}
2937
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002938/*
2939 * Mark all functions of script "sid" as deleted.
2940 */
2941 void
2942delete_script_functions(int sid)
2943{
2944 hashitem_T *hi;
2945 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002946 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002947 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002948 size_t len;
2949
2950 buf[0] = K_SPECIAL;
2951 buf[1] = KS_EXTRA;
2952 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002953 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002954 len = STRLEN(buf);
2955
Bram Moolenaarce658352020-07-31 23:47:12 +02002956 while (todo > 0)
2957 {
2958 todo = func_hashtab.ht_used;
2959 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2960 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002961 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002962 fp = HI2UF(hi);
2963 if (STRNCMP(fp->uf_name, buf, len) == 0)
2964 {
2965 int changed = func_hashtab.ht_changed;
2966
2967 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002968
2969 if (fp->uf_calls > 0)
2970 {
2971 // Function is executing, don't free it but do remove
2972 // it from the hashtable.
2973 if (func_remove(fp))
2974 fp->uf_refcount--;
2975 }
2976 else
2977 {
2978 func_clear(fp, TRUE);
2979 // When clearing a function another function can be
2980 // cleared as a side effect. When that happens start
2981 // over.
2982 if (changed != func_hashtab.ht_changed)
2983 break;
2984 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002985 }
2986 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002987 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002988 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002989}
2990
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991#if defined(EXITFREE) || defined(PROTO)
2992 void
2993free_all_functions(void)
2994{
2995 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002996 ufunc_T *fp;
2997 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002998 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002999 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000
Bram Moolenaare38eab22019-12-05 21:50:01 +01003001 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003002 while (current_funccal != NULL)
3003 {
3004 clear_tv(current_funccal->rettv);
3005 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003006 if (current_funccal == NULL && funccal_stack != NULL)
3007 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003008 }
3009
Bram Moolenaare38eab22019-12-05 21:50:01 +01003010 // First clear what the functions contain. Since this may lower the
3011 // reference count of a function, it may also free a function and change
3012 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003013 while (todo > 0)
3014 {
3015 todo = func_hashtab.ht_used;
3016 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3017 if (!HASHITEM_EMPTY(hi))
3018 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003019 // clear the def function index now
3020 fp = HI2UF(hi);
3021 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003022 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023
Bram Moolenaare38eab22019-12-05 21:50:01 +01003024 // Only free functions that are not refcounted, those are
3025 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003026 if (func_name_refcount(fp->uf_name))
3027 ++skipped;
3028 else
3029 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003030 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003031 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003032 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003033 {
3034 skipped = 0;
3035 break;
3036 }
3037 }
3038 --todo;
3039 }
3040 }
3041
Bram Moolenaare38eab22019-12-05 21:50:01 +01003042 // Now actually free the functions. Need to start all over every time,
3043 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003044 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003045 while (func_hashtab.ht_used > skipped)
3046 {
3047 todo = func_hashtab.ht_used;
3048 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 if (!HASHITEM_EMPTY(hi))
3050 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003051 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003052 // Only free functions that are not refcounted, those are
3053 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003054 fp = HI2UF(hi);
3055 if (func_name_refcount(fp->uf_name))
3056 ++skipped;
3057 else
3058 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003059 if (func_free(fp, FALSE) == OK)
3060 {
3061 skipped = 0;
3062 break;
3063 }
3064 // did not actually free it
3065 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003066 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003067 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003068 }
3069 if (skipped == 0)
3070 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071
3072 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073}
3074#endif
3075
3076/*
3077 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003078 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079 * "len" is the length of "name", or -1 for NUL terminated.
3080 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003081 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082builtin_function(char_u *name, int len)
3083{
3084 char_u *p;
3085
Bram Moolenaara26b9702020-04-18 19:53:28 +02003086 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 return FALSE;
3088 p = vim_strchr(name, AUTOLOAD_CHAR);
3089 return p == NULL || (len > 0 && p > name + len);
3090}
3091
3092 int
3093func_call(
3094 char_u *name,
3095 typval_T *args,
3096 partial_T *partial,
3097 dict_T *selfdict,
3098 typval_T *rettv)
3099{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003100 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 listitem_T *item;
3102 typval_T argv[MAX_FUNC_ARGS + 1];
3103 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003104 int r = 0;
3105
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003106 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003107 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 {
3109 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3110 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003111 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 break;
3113 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003114 // Make a copy of each argument. This is needed to be able to set
3115 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 copy_tv(&item->li_tv, &argv[argc++]);
3117 }
3118
3119 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003120 {
3121 funcexe_T funcexe;
3122
Bram Moolenaara80faa82020-04-12 19:37:17 +02003123 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003124 funcexe.firstline = curwin->w_cursor.lnum;
3125 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003126 funcexe.evaluate = TRUE;
3127 funcexe.partial = partial;
3128 funcexe.selfdict = selfdict;
3129 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3130 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131
Bram Moolenaare38eab22019-12-05 21:50:01 +01003132 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133 while (argc > 0)
3134 clear_tv(&argv[--argc]);
3135
3136 return r;
3137}
3138
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003139static int callback_depth = 0;
3140
3141 int
3142get_callback_depth(void)
3143{
3144 return callback_depth;
3145}
3146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003148 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003149 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003150 */
3151 int
3152call_callback(
3153 callback_T *callback,
3154 int len, // length of "name" or -1 to use strlen()
3155 typval_T *rettv, // return value goes here
3156 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003157 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003158 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003159{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003160 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003161 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003162
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003163 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3164 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003165 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003166 funcexe.evaluate = TRUE;
3167 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003168 ++callback_depth;
3169 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3170 --callback_depth;
3171 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003172}
3173
3174/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003175 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003176 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003177 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3178 */
3179 varnumber_T
3180call_callback_retnr(
3181 callback_T *callback,
3182 int argcount, // number of "argvars"
3183 typval_T *argvars) // vars for arguments, must have "argcount"
3184 // PLUS ONE elements!
3185{
3186 typval_T rettv;
3187 varnumber_T retval;
3188
3189 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003190 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003191
3192 retval = tv_get_number_chk(&rettv, NULL);
3193 clear_tv(&rettv);
3194 return retval;
3195}
3196
3197/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003198 * Give an error message for the result of a function.
3199 * Nothing if "error" is FCERR_NONE.
3200 */
3201 void
3202user_func_error(int error, char_u *name)
3203{
3204 switch (error)
3205 {
3206 case FCERR_UNKNOWN:
3207 emsg_funcname(e_unknownfunc, name);
3208 break;
3209 case FCERR_NOTMETHOD:
3210 emsg_funcname(
3211 N_("E276: Cannot use function as a method: %s"), name);
3212 break;
3213 case FCERR_DELETED:
3214 emsg_funcname(N_(e_func_deleted), name);
3215 break;
3216 case FCERR_TOOMANY:
3217 emsg_funcname((char *)e_toomanyarg, name);
3218 break;
3219 case FCERR_TOOFEW:
3220 emsg_funcname((char *)e_toofewarg, name);
3221 break;
3222 case FCERR_SCRIPT:
3223 emsg_funcname(
3224 N_("E120: Using <SID> not in a script context: %s"), name);
3225 break;
3226 case FCERR_DICT:
3227 emsg_funcname(
3228 N_("E725: Calling dict function without Dictionary: %s"),
3229 name);
3230 break;
3231 }
3232}
3233
3234/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003236 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237 * Return FAIL when the function can't be called, OK otherwise.
3238 * Also returns OK when an error was encountered while executing the function.
3239 */
3240 int
3241call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003242 char_u *funcname, // name of the function
3243 int len, // length of "name" or -1 to use strlen()
3244 typval_T *rettv, // return value goes here
3245 int argcount_in, // number of "argvars"
3246 typval_T *argvars_in, // vars for arguments, must have "argcount"
3247 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003248 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249{
3250 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003251 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003253 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254 char_u fname_buf[FLEN_FIXED + 1];
3255 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003256 char_u *fname = NULL;
3257 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258 int argcount = argcount_in;
3259 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003260 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003261 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3262 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003264 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003265 partial_T *partial = funcexe->partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003266 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003268 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3269 // even when call_func() returns FAIL.
3270 rettv->v_type = VAR_UNKNOWN;
3271
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003272 if (partial != NULL)
3273 fp = partial->pt_func;
3274 if (fp == NULL)
3275 {
3276 // Make a copy of the name, if it comes from a funcref variable it
3277 // could be changed or deleted in the called function.
3278 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3279 if (name == NULL)
3280 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003282 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3283 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003285 if (funcexe->doesrange != NULL)
3286 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287
3288 if (partial != NULL)
3289 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003290 // When the function has a partial with a dict and there is a dict
3291 // argument, use the dict argument. That is backwards compatible.
3292 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003293 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003295 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 {
3297 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003298 {
3299 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3300 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003301 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003302 goto theend;
3303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003305 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 for (i = 0; i < argcount_in; ++i)
3307 argv[i + argv_clear] = argvars_in[i];
3308 argvars = argv;
3309 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003310
Bram Moolenaar22f85d02021-07-04 23:29:30 +02003311 if (funcexe->check_type != NULL
3312 && funcexe->check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003313 {
3314 // Now funcexe->check_type is missing the added arguments, make
3315 // a copy of the type with the correction.
3316 check_type = *funcexe->check_type;
3317 funcexe->check_type = &check_type;
3318 check_type.tt_argcount += partial->pt_argc;
3319 check_type.tt_min_argcount += partial->pt_argc;
3320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321 }
3322 }
3323
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003324 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3325 {
3326 // Check that the argument types are OK for the types of the funcref.
3327 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003328 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003329 error = FCERR_OTHER;
3330 }
3331
Bram Moolenaaref140542019-12-31 21:27:13 +01003332 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333 {
3334 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003335 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336
Bram Moolenaar333894b2020-08-01 18:53:07 +02003337 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003338 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003339 {
3340 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003342 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343
Bram Moolenaare38eab22019-12-05 21:50:01 +01003344 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003346 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003348 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 {
3350 /*
3351 * User defined function.
3352 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003353 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003354 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355
Bram Moolenaare38eab22019-12-05 21:50:01 +01003356 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 if (fp == NULL
3358 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003359 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 && !aborting())
3361 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003362 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003363 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003365 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3367 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003368 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003369 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003371 if (fp == NULL)
3372 {
3373 char_u *p = untrans_function_name(rfname);
3374
3375 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003376 // Don't do this if the name starts with "s:".
3377 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003378 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003379 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003381 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003382 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003383#ifdef FEAT_LUA
3384 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3385 {
3386 cfunc_T cb = fp->uf_cb;
3387
3388 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3389 }
3390#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003391 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003393 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003394 // postponed filling in the arguments, do it now
3395 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003396 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003397
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003398 if (funcexe->basetv != NULL)
3399 {
3400 // Method call: base->Method()
3401 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3402 argv[0] = *funcexe->basetv;
3403 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003404 argvars = argv;
3405 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003406 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003407
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408 error = call_user_func_check(fp, argcount, argvars, rettv,
3409 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 }
3411 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003412 else if (funcexe->basetv != NULL)
3413 {
3414 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003415 * expr->method(): Find the method name in the table, call its
3416 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003417 */
3418 error = call_internal_method(fname, argcount, argvars, rettv,
3419 funcexe->basetv);
3420 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 else
3422 {
3423 /*
3424 * Find the function name in the table, call its implementation.
3425 */
3426 error = call_internal_func(fname, argcount, argvars, rettv);
3427 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003428
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 /*
3430 * The function call (or "FuncUndefined" autocommand sequence) might
3431 * have been aborted by an error, an interrupt, or an explicitly thrown
3432 * exception that has not been caught so far. This situation can be
3433 * tested for by calling aborting(). For an error in an internal
3434 * function or for the "E132" error in call_user_func(), however, the
3435 * throw point at which the "force_abort" flag (temporarily reset by
3436 * emsg()) is normally updated has not been reached yet. We need to
3437 * update that flag first to make aborting() reliable.
3438 */
3439 update_force_abort();
3440 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003441 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 ret = OK;
3443
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003444theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 /*
3446 * Report an error unless the argument evaluation or function call has been
3447 * cancelled due to an aborting error, an interrupt, or an exception.
3448 */
3449 if (!aborting())
3450 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003451 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 }
3453
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003454 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003456 clear_tv(&argv[--argv_clear + argv_base]);
3457
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 vim_free(tofree);
3459 vim_free(name);
3460
3461 return ret;
3462}
3463
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003464 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003465printable_func_name(ufunc_T *fp)
3466{
3467 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3468}
3469
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003471 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 */
3473 static void
3474list_func_head(ufunc_T *fp, int indent)
3475{
3476 int j;
3477
3478 msg_start();
3479 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003480 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003481 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003482 msg_puts("def ");
3483 else
3484 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003485 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 msg_putchar('(');
3487 for (j = 0; j < fp->uf_args.ga_len; ++j)
3488 {
3489 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003490 msg_puts(", ");
3491 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003492 if (fp->uf_arg_types != NULL)
3493 {
3494 char *tofree;
3495
3496 msg_puts(": ");
3497 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3498 vim_free(tofree);
3499 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003500 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3501 {
3502 msg_puts(" = ");
3503 msg_puts(((char **)(fp->uf_def_args.ga_data))
3504 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003506 }
3507 if (fp->uf_varargs)
3508 {
3509 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003510 msg_puts(", ");
3511 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 if (fp->uf_va_name != NULL)
3514 {
3515 if (j)
3516 msg_puts(", ");
3517 msg_puts("...");
3518 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003519 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003520 {
3521 char *tofree;
3522
3523 msg_puts(": ");
3524 msg_puts(type_name(fp->uf_va_type, &tofree));
3525 vim_free(tofree);
3526 }
3527 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003528 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003529
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003530 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003531 {
3532 if (fp->uf_ret_type != &t_void)
3533 {
3534 char *tofree;
3535
3536 msg_puts(": ");
3537 msg_puts(type_name(fp->uf_ret_type, &tofree));
3538 vim_free(tofree);
3539 }
3540 }
3541 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003542 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003544 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003546 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003547 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003548 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 msg_clr_eos();
3550 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003551 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552}
3553
3554/*
3555 * Get a function name, translating "<SID>" and "<SNR>".
3556 * Also handles a Funcref in a List or Dictionary.
3557 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003558 * Set "*is_global" to TRUE when the function must be global, unless
3559 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 * flags:
3561 * TFN_INT: internal function name OK
3562 * TFN_QUIET: be quiet
3563 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003564 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565 * Advances "pp" to just after the function name (if no error).
3566 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003567 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568trans_function_name(
3569 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003570 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003571 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003573 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003574 partial_T **partial, // return: partial of a FuncRef
3575 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576{
3577 char_u *name = NULL;
3578 char_u *start;
3579 char_u *end;
3580 int lead;
3581 char_u sid_buf[20];
3582 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003583 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003585 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003586 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587
3588 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003589 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 start = *pp;
3591
Bram Moolenaare38eab22019-12-05 21:50:01 +01003592 // Check for hard coded <SNR>: already translated function ID (from a user
3593 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3595 && (*pp)[2] == (int)KE_SNR)
3596 {
3597 *pp += 3;
3598 len = get_id_len(pp) + 3;
3599 return vim_strnsave(start, len);
3600 }
3601
Bram Moolenaare38eab22019-12-05 21:50:01 +01003602 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3603 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 lead = eval_fname_script(start);
3605 if (lead > 2)
3606 start += lead;
3607
Bram Moolenaare38eab22019-12-05 21:50:01 +01003608 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003609 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003610 lead > 2 ? 0 : FNE_CHECK_START);
3611 if (end == start)
3612 {
3613 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003614 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003615 goto theend;
3616 }
3617 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3618 {
3619 /*
3620 * Report an invalid expression in braces, unless the expression
3621 * evaluation has been cancelled due to an aborting error, an
3622 * interrupt, or an exception.
3623 */
3624 if (!aborting())
3625 {
3626 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003627 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 }
3629 else
3630 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3631 goto theend;
3632 }
3633
3634 if (lv.ll_tv != NULL)
3635 {
3636 if (fdp != NULL)
3637 {
3638 fdp->fd_dict = lv.ll_dict;
3639 fdp->fd_newkey = lv.ll_newkey;
3640 lv.ll_newkey = NULL;
3641 fdp->fd_di = lv.ll_di;
3642 }
3643 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3644 {
3645 name = vim_strsave(lv.ll_tv->vval.v_string);
3646 *pp = end;
3647 }
3648 else if (lv.ll_tv->v_type == VAR_PARTIAL
3649 && lv.ll_tv->vval.v_partial != NULL)
3650 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003651 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 *pp = end;
3653 if (partial != NULL)
3654 *partial = lv.ll_tv->vval.v_partial;
3655 }
3656 else
3657 {
3658 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3659 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003660 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 else
3662 *pp = end;
3663 name = NULL;
3664 }
3665 goto theend;
3666 }
3667
3668 if (lv.ll_name == NULL)
3669 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003670 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 *pp = end;
3672 goto theend;
3673 }
3674
Bram Moolenaare38eab22019-12-05 21:50:01 +01003675 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 if (lv.ll_exp_name != NULL)
3677 {
3678 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003679 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680 flags & TFN_NO_AUTOLOAD);
3681 if (name == lv.ll_exp_name)
3682 name = NULL;
3683 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003684 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 {
3686 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003687 name = deref_func_name(*pp, &len, partial, type,
3688 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 if (name == *pp)
3690 name = NULL;
3691 }
3692 if (name != NULL)
3693 {
3694 name = vim_strsave(name);
3695 *pp = end;
3696 if (STRNCMP(name, "<SNR>", 5) == 0)
3697 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003698 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 name[0] = K_SPECIAL;
3700 name[1] = KS_EXTRA;
3701 name[2] = (int)KE_SNR;
3702 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3703 }
3704 goto theend;
3705 }
3706
3707 if (lv.ll_exp_name != NULL)
3708 {
3709 len = (int)STRLEN(lv.ll_exp_name);
3710 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3711 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3712 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003713 // When there was "s:" already or the name expanded to get a
3714 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 lv.ll_name += 2;
3716 len -= 2;
3717 lead = 2;
3718 }
3719 }
3720 else
3721 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003722 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003724 {
3725 if (is_global != NULL && lv.ll_name[0] == 'g')
3726 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003728 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 len = (int)(end - lv.ll_name);
3730 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003731 if (len <= 0)
3732 {
3733 if (!skip)
3734 emsg(_(e_function_name));
3735 goto theend;
3736 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003738 // In Vim9 script a user function is script-local by default, unless it
3739 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003740 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003741 if (vim9script)
3742 {
3743 char_u *p;
3744
3745 // SomeScript#func() is a global function.
3746 for (p = start; *p != NUL && *p != '('; ++p)
3747 if (*p == AUTOLOAD_CHAR)
3748 vim9script = FALSE;
3749 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003750
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 /*
3752 * Copy the function name to allocated memory.
3753 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3754 * Accept <SNR>123_name() outside a script.
3755 */
3756 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003757 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003758 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003760 if (!vim9script)
3761 lead = 3;
3762 if (vim9script || (lv.ll_exp_name != NULL
3763 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 || eval_fname_sid(*pp))
3765 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003766 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003767 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003769 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003770 goto theend;
3771 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003772 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003773 if (vim9script)
3774 extra = 3 + (int)STRLEN(sid_buf);
3775 else
3776 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 }
3778 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003779 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3780 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003782 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 start);
3784 goto theend;
3785 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003786 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 {
3788 char_u *cp = vim_strchr(lv.ll_name, ':');
3789
3790 if (cp != NULL && cp < end)
3791 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003792 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 goto theend;
3794 }
3795 }
3796
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003797 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 if (name != NULL)
3799 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003800 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 {
3802 name[0] = K_SPECIAL;
3803 name[1] = KS_EXTRA;
3804 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003805 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 STRCPY(name + 3, sid_buf);
3807 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003808 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3809 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 }
3811 *pp = end;
3812
3813theend:
3814 clear_lval(&lv);
3815 return name;
3816}
3817
3818/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003819 * Assuming "name" is the result of trans_function_name() and it was prefixed
3820 * to use the script-local name, return the unmodified name (points into
3821 * "name"). Otherwise return NULL.
3822 * This can be used to first search for a script-local function and fall back
3823 * to the global function if not found.
3824 */
3825 char_u *
3826untrans_function_name(char_u *name)
3827{
3828 char_u *p;
3829
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003830 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003831 {
3832 p = vim_strchr(name, '_');
3833 if (p != NULL)
3834 return p + 1;
3835 }
3836 return NULL;
3837}
3838
3839/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003840 * Call trans_function_name(), except that a lambda is returned as-is.
3841 * Returns the name in allocated memory.
3842 */
3843 char_u *
3844save_function_name(
3845 char_u **name,
3846 int *is_global,
3847 int skip,
3848 int flags,
3849 funcdict_T *fudi)
3850{
3851 char_u *p = *name;
3852 char_u *saved;
3853
3854 if (STRNCMP(p, "<lambda>", 8) == 0)
3855 {
3856 p += 8;
3857 (void)getdigits(&p);
3858 saved = vim_strnsave(*name, p - *name);
3859 if (fudi != NULL)
3860 CLEAR_POINTER(fudi);
3861 }
3862 else
3863 saved = trans_function_name(&p, is_global, skip,
3864 flags, fudi, NULL, NULL);
3865 *name = p;
3866 return saved;
3867}
3868
3869/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003870 * List functions. When "regmatch" is NULL all of then.
3871 * Otherwise functions matching "regmatch".
3872 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003873 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003874list_functions(regmatch_T *regmatch)
3875{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003876 int changed = func_hashtab.ht_changed;
3877 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003878 hashitem_T *hi;
3879
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003880 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003881 {
3882 if (!HASHITEM_EMPTY(hi))
3883 {
3884 ufunc_T *fp = HI2UF(hi);
3885
3886 --todo;
3887 if ((fp->uf_flags & FC_DEAD) == 0
3888 && (regmatch == NULL
3889 ? !message_filtered(fp->uf_name)
3890 && !func_name_refcount(fp->uf_name)
3891 : !isdigit(*fp->uf_name)
3892 && vim_regexec(regmatch, fp->uf_name, 0)))
3893 {
3894 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003895 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003896 {
3897 emsg(_("E454: function list was modified"));
3898 return;
3899 }
3900 }
3901 }
3902 }
3903}
3904
3905/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003906 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003907 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3908 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003909 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003911 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003912define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003914 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 int j;
3916 int c;
3917 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003918 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003919 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 char_u *p;
3921 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003922 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003923 char_u *line_arg = NULL;
3924 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003925 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003926 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 garray_T newlines;
3928 int varargs = FALSE;
3929 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003930 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003931 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003932 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 dictitem_T *v;
3934 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003935 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003938 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003939 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003940 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941
3942 /*
3943 * ":function" without argument: list functions.
3944 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003945 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 {
3947 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003948 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003949 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003950 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951 }
3952
3953 /*
3954 * ":function /pat": list functions matching pattern.
3955 */
3956 if (*eap->arg == '/')
3957 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003958 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959 if (!eap->skip)
3960 {
3961 regmatch_T regmatch;
3962
3963 c = *p;
3964 *p = NUL;
3965 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3966 *p = c;
3967 if (regmatch.regprog != NULL)
3968 {
3969 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003970 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 vim_regfree(regmatch.regprog);
3972 }
3973 }
3974 if (*p == '/')
3975 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02003976 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003977 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 }
3979
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003980 ga_init(&newargs);
3981 ga_init(&argtypes);
3982 ga_init(&default_args);
3983
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 /*
3985 * Get the function name. There are these situations:
3986 * func normal function name
3987 * "name" == func, "fudi.fd_dict" == NULL
3988 * dict.func new dictionary entry
3989 * "name" == NULL, "fudi.fd_dict" set,
3990 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3991 * dict.func existing dict entry with a Funcref
3992 * "name" == func, "fudi.fd_dict" set,
3993 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3994 * dict.func existing dict entry that's not a Funcref
3995 * "name" == NULL, "fudi.fd_dict" set,
3996 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3997 * s:func script-local function name
3998 * g:func global function name, same as "func"
3999 */
4000 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004001 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004003 // nested function, argument is (args).
4004 paren = TRUE;
4005 CLEAR_FIELD(fudi);
4006 }
4007 else
4008 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004009 name = save_function_name(&p, &is_global, eap->skip,
4010 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004011 paren = (vim_strchr(p, '(') != NULL);
4012 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004013 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004014 /*
4015 * Return on an invalid expression in braces, unless the expression
4016 * evaluation has been cancelled due to an aborting error, an
4017 * interrupt, or an exception.
4018 */
4019 if (!aborting())
4020 {
4021 if (!eap->skip && fudi.fd_newkey != NULL)
4022 semsg(_(e_dictkey), fudi.fd_newkey);
4023 vim_free(fudi.fd_newkey);
4024 return NULL;
4025 }
4026 else
4027 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 }
4030
Bram Moolenaare38eab22019-12-05 21:50:01 +01004031 // An error in a function call during evaluation of an expression in magic
4032 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 saved_did_emsg = did_emsg;
4034 did_emsg = FALSE;
4035
4036 /*
4037 * ":function func" with only function name: list function.
4038 */
4039 if (!paren)
4040 {
4041 if (!ends_excmd(*skipwhite(p)))
4042 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004043 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 goto ret_free;
4045 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004046 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 if (eap->nextcmd != NULL)
4048 *p = NUL;
4049 if (!eap->skip && !got_int)
4050 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004051 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004052 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4053 {
4054 char_u *up = untrans_function_name(name);
4055
4056 // With Vim9 script the name was made script-local, if not
4057 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004058 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004059 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004060 }
4061
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 if (fp != NULL)
4063 {
4064 list_func_head(fp, TRUE);
4065 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4066 {
4067 if (FUNCLINE(fp, j) == NULL)
4068 continue;
4069 msg_putchar('\n');
4070 msg_outnum((long)(j + 1));
4071 if (j < 9)
4072 msg_putchar(' ');
4073 if (j < 99)
4074 msg_putchar(' ');
4075 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004076 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 ui_breakcheck();
4078 }
4079 if (!got_int)
4080 {
4081 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004082 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004083 msg_puts(" enddef");
4084 else
4085 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 }
4087 }
4088 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004089 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090 }
4091 goto ret_free;
4092 }
4093
4094 /*
4095 * ":function name(arg1, arg2)" Define function.
4096 */
4097 p = skipwhite(p);
4098 if (*p != '(')
4099 {
4100 if (!eap->skip)
4101 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004102 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 goto ret_free;
4104 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004105 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 if (vim_strchr(p, '(') != NULL)
4107 p = vim_strchr(p, '(');
4108 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004109
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004110 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4111 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004112 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004113 goto ret_free;
4114 }
4115
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004116 // In Vim9 script only global functions can be redefined.
4117 if (vim9script && eap->forceit && !is_global)
4118 {
4119 emsg(_(e_nobang));
4120 goto ret_free;
4121 }
4122
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004123 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124
Bram Moolenaar04b12692020-05-04 23:24:44 +02004125 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004126 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004127 // Check the name of the function. Unless it's a dictionary function
4128 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 if (name != NULL)
4130 arg = name;
4131 else
4132 arg = fudi.fd_newkey;
4133 if (arg != NULL && (fudi.fd_di == NULL
4134 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4135 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4136 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004137 char_u *name_base = arg;
4138 int i;
4139
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004141 {
4142 name_base = vim_strchr(arg, '_');
4143 if (name_base == NULL)
4144 name_base = arg + 3;
4145 else
4146 ++name_base;
4147 }
4148 for (i = 0; name_base[i] != NUL && (i == 0
4149 ? eval_isnamec1(name_base[i])
4150 : eval_isnamec(name_base[i])); ++i)
4151 ;
4152 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004153 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004154
4155 // In Vim9 script a function cannot have the same name as a
4156 // variable.
4157 if (vim9script && *arg == K_SPECIAL
4158 && eval_variable(name_base, STRLEN(name_base), NULL, NULL,
4159 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4160 + EVAL_VAR_NO_FUNC) == OK)
4161 {
4162 semsg(_(e_redefining_script_item_str), name_base);
4163 goto ret_free;
4164 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004166 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004168 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004169 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004170 goto ret_free;
4171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 }
4173
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004174 // This may get more lines and make the pointers into the first line
4175 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004176 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004177 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004178 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004179 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004180 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004182 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004184 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004186 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004187 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004189 if (*p != ':')
4190 {
4191 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4192 p = skipwhite(p);
4193 }
4194 else if (!IS_WHITE_OR_NUL(p[1]))
4195 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004196 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004197 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004198 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004199 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004200 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004201 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004202 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004203 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004204 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004205 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004206 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004207 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004208 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004210 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004212 else
4213 // find extra arguments "range", "dict", "abort" and "closure"
4214 for (;;)
4215 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004216 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004217 p = skipwhite(p);
4218 if (STRNCMP(p, "range", 5) == 0)
4219 {
4220 flags |= FC_RANGE;
4221 p += 5;
4222 }
4223 else if (STRNCMP(p, "dict", 4) == 0)
4224 {
4225 flags |= FC_DICT;
4226 p += 4;
4227 }
4228 else if (STRNCMP(p, "abort", 5) == 0)
4229 {
4230 flags |= FC_ABORT;
4231 p += 5;
4232 }
4233 else if (STRNCMP(p, "closure", 7) == 0)
4234 {
4235 flags |= FC_CLOSURE;
4236 p += 7;
4237 if (current_funccal == NULL)
4238 {
4239 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4240 name == NULL ? (char_u *)"" : name);
4241 goto erret;
4242 }
4243 }
4244 else
4245 break;
4246 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247
Bram Moolenaare38eab22019-12-05 21:50:01 +01004248 // When there is a line break use what follows for the function body.
4249 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 if (*p == '\n')
4251 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004252 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004253 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4254 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004255 && !(VIM_ISWHITE(*whitep) && *p == '#'
4256 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004257 && !eap->skip
4258 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004259 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260
4261 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004262 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4263 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 */
4265 if (KeyTyped)
4266 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004267 // Check if the function already exists, don't let the user type the
4268 // whole function before telling him it doesn't work! For a script we
4269 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 if (!eap->skip && !eap->forceit)
4271 {
4272 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004273 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004274 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 emsg_funcname(e_funcexts, name);
4276 }
4277
4278 if (!eap->skip && did_emsg)
4279 goto erret;
4280
Bram Moolenaare38eab22019-12-05 21:50:01 +01004281 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 cmdline_row = msg_row;
4283 }
4284
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004285 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004286 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004287
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004288 // Do not define the function when getting the body fails and when
4289 // skipping.
4290 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4291 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 goto erret;
4293
4294 /*
4295 * If there are no errors, add the function
4296 */
4297 if (fudi.fd_dict == NULL)
4298 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004299 hashtab_T *ht;
4300
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004301 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004302 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4303 {
4304 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4305 name);
4306 goto erret;
4307 }
4308
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004309 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004310 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004312 char_u *uname = untrans_function_name(name);
4313
4314 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4315 }
4316
4317 if (fp != NULL || import != NULL)
4318 {
4319 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004320
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004321 // Function can be replaced with "function!" and when sourcing the
4322 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004323 // A name that is used by an import can not be overruled.
4324 if (import != NULL
4325 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004326 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004327 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004329 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004330 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004331 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004332 else
4333 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004334 goto erret;
4335 }
4336 if (fp->uf_calls > 0)
4337 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004338 emsg_funcname(
4339 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 name);
4341 goto erret;
4342 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004343 if (fp->uf_refcount > 1)
4344 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004345 // This function is referenced somewhere, don't redefine it but
4346 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004347 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004348 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004349 fp = NULL;
4350 overwrite = TRUE;
4351 }
4352 else
4353 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004354 char_u *exp_name = fp->uf_name_exp;
4355
4356 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004357 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004358 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004359 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004360 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004361 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004362#ifdef FEAT_PROFILE
4363 fp->uf_profiling = FALSE;
4364 fp->uf_prof_initialized = FALSE;
4365#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004366 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004367 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 }
4369 }
4370 else
4371 {
4372 char numbuf[20];
4373
4374 fp = NULL;
4375 if (fudi.fd_newkey == NULL && !eap->forceit)
4376 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004377 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378 goto erret;
4379 }
4380 if (fudi.fd_di == NULL)
4381 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004382 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004383 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 goto erret;
4385 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004386 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004387 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004388 goto erret;
4389
Bram Moolenaare38eab22019-12-05 21:50:01 +01004390 // Give the function a sequential number. Can only be used with a
4391 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392 vim_free(name);
4393 sprintf(numbuf, "%d", ++func_nr);
4394 name = vim_strsave((char_u *)numbuf);
4395 if (name == NULL)
4396 goto erret;
4397 }
4398
4399 if (fp == NULL)
4400 {
4401 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4402 {
4403 int slen, plen;
4404 char_u *scriptname;
4405
Bram Moolenaare38eab22019-12-05 21:50:01 +01004406 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004408 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004409 {
4410 scriptname = autoload_name(name);
4411 if (scriptname != NULL)
4412 {
4413 p = vim_strchr(scriptname, '/');
4414 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004415 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004417 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 j = OK;
4419 vim_free(scriptname);
4420 }
4421 }
4422 if (j == FAIL)
4423 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004424 linenr_T save_lnum = SOURCING_LNUM;
4425
4426 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004427 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004428 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 goto erret;
4430 }
4431 }
4432
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004433 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 if (fp == NULL)
4435 goto erret;
4436
4437 if (fudi.fd_dict != NULL)
4438 {
4439 if (fudi.fd_di == NULL)
4440 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004441 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4443 if (fudi.fd_di == NULL)
4444 {
4445 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004446 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 goto erret;
4448 }
4449 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4450 {
4451 vim_free(fudi.fd_di);
4452 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004453 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004454 goto erret;
4455 }
4456 }
4457 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004458 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 clear_tv(&fudi.fd_di->di_tv);
4460 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462
Bram Moolenaare38eab22019-12-05 21:50:01 +01004463 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 flags |= FC_DICT;
4465 }
4466
Bram Moolenaare38eab22019-12-05 21:50:01 +01004467 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004468 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004469 if (overwrite)
4470 {
4471 hi = hash_find(&func_hashtab, name);
4472 hi->hi_key = UF2HIKEY(fp);
4473 }
4474 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004475 {
4476 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004477 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 goto erret;
4479 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004480 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 }
4482 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004483 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004484 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004485 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004486
4487 if (eap->cmdidx == CMD_def)
4488 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004489 int lnum_save = SOURCING_LNUM;
4490 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004491
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004492 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004493
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004494 // error messages are for the first function line
4495 SOURCING_LNUM = sourcing_lnum_top;
4496
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004497 // The function may use script variables from the context.
4498 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004499
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004500 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004501 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004502 SOURCING_LNUM = lnum_save;
4503 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004504 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004505 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004506
4507 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004508 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004509 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004510 SOURCING_LNUM = lnum_save;
4511 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004512 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004513 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004514 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004515 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004516 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004517
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004518 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004519 if ((flags & FC_CLOSURE) != 0)
4520 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004521 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004522 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004523 }
4524 else
4525 fp->uf_scoped = NULL;
4526
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004527#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528 if (prof_def_func())
4529 func_do_profile(fp);
4530#endif
4531 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004532 if (sandbox)
4533 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004534 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004535 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 fp->uf_flags = flags;
4537 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004538 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004539 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004540 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004541 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004542 if (is_export)
4543 {
4544 fp->uf_flags |= FC_EXPORT;
4545 // let ex_export() know the export worked.
4546 is_export = FALSE;
4547 }
4548
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004549 if (eap->cmdidx == CMD_def)
4550 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004551 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4552 // :func does not use Vim9 script syntax, even in a Vim9 script file
4553 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004554
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 goto ret_free;
4556
4557erret:
4558 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004559 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004560 if (fp != NULL)
4561 {
4562 ga_init(&fp->uf_args);
4563 ga_init(&fp->uf_def_args);
4564 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565errret_2:
4566 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004567 if (fp != NULL)
4568 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004570 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004571 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004573 if (name != name_arg)
4574 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004575 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004577
4578 return fp;
4579}
4580
4581/*
4582 * ":function"
4583 */
4584 void
4585ex_function(exarg_T *eap)
4586{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004587 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004588}
4589
4590/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004591 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004592 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004593 */
4594 void
4595ex_defcompile(exarg_T *eap UNUSED)
4596{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004597 long todo = (long)func_hashtab.ht_used;
4598 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004599 hashitem_T *hi;
4600 ufunc_T *ufunc;
4601
4602 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4603 {
4604 if (!HASHITEM_EMPTY(hi))
4605 {
4606 --todo;
4607 ufunc = HI2UF(hi);
4608 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004609 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4610 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004611 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004612 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004613
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004614 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004615 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004616 // a function has been added or removed, need to start over
4617 todo = (long)func_hashtab.ht_used;
4618 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004619 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004620 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004621 }
4622 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004623 }
4624 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625}
4626
4627/*
4628 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4629 * Return 2 if "p" starts with "s:".
4630 * Return 0 otherwise.
4631 */
4632 int
4633eval_fname_script(char_u *p)
4634{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004635 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4636 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4638 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4639 return 5;
4640 if (p[0] == 's' && p[1] == ':')
4641 return 2;
4642 return 0;
4643}
4644
4645 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004646translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004647{
4648 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004649 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004650 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004651}
4652
4653/*
4654 * Return TRUE when "ufunc" has old-style "..." varargs
4655 * or named varargs "...name: type".
4656 */
4657 int
4658has_varargs(ufunc_T *ufunc)
4659{
4660 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661}
4662
4663/*
4664 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004665 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004666 */
4667 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004668function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669{
4670 char_u *nm = name;
4671 char_u *p;
4672 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004673 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004674 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004676 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4677 if (no_deref)
4678 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004679 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 nm = skipwhite(nm);
4681
Bram Moolenaare38eab22019-12-05 21:50:01 +01004682 // Only accept "funcname", "funcname ", "funcname (..." and
4683 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004685 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 vim_free(p);
4687 return n;
4688}
4689
Bram Moolenaar113e1072019-01-20 15:30:40 +01004690#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691 char_u *
4692get_expanded_name(char_u *name, int check)
4693{
4694 char_u *nm = name;
4695 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004696 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004698 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004699 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004700
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004701 if (p != NULL && *nm == NUL
4702 && (!check || translated_function_exists(p, is_global)))
4703 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004704
4705 vim_free(p);
4706 return NULL;
4707}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004708#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710/*
4711 * Function given to ExpandGeneric() to obtain the list of user defined
4712 * function names.
4713 */
4714 char_u *
4715get_user_func_name(expand_T *xp, int idx)
4716{
4717 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004718 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 static hashitem_T *hi;
4720 ufunc_T *fp;
4721
4722 if (idx == 0)
4723 {
4724 done = 0;
4725 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004726 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004728 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729 {
4730 if (done++ > 0)
4731 ++hi;
4732 while (HASHITEM_EMPTY(hi))
4733 ++hi;
4734 fp = HI2UF(hi);
4735
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004736 // don't show dead, dict and lambda functions
4737 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004738 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004739 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004740
4741 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004742 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743
4744 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004745 if (xp->xp_context != EXPAND_USER_FUNC
4746 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747 {
4748 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004749 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 STRCAT(IObuff, ")");
4751 }
4752 return IObuff;
4753 }
4754 return NULL;
4755}
4756
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757/*
4758 * ":delfunction {name}"
4759 */
4760 void
4761ex_delfunction(exarg_T *eap)
4762{
4763 ufunc_T *fp = NULL;
4764 char_u *p;
4765 char_u *name;
4766 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004767 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768
4769 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004770 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4771 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772 vim_free(fudi.fd_newkey);
4773 if (name == NULL)
4774 {
4775 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004776 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 return;
4778 }
4779 if (!ends_excmd(*skipwhite(p)))
4780 {
4781 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004782 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 return;
4784 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004785 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 if (eap->nextcmd != NULL)
4787 *p = NUL;
4788
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004789 if (isdigit(*name) && fudi.fd_dict == NULL)
4790 {
4791 if (!eap->skip)
4792 semsg(_(e_invarg2), eap->arg);
4793 vim_free(name);
4794 return;
4795 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004796 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004797 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798 vim_free(name);
4799
4800 if (!eap->skip)
4801 {
4802 if (fp == NULL)
4803 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004804 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004805 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 return;
4807 }
4808 if (fp->uf_calls > 0)
4809 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004810 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 return;
4812 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004813 if (fp->uf_flags & FC_VIM9)
4814 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004815 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004816 return;
4817 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818
4819 if (fudi.fd_dict != NULL)
4820 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004821 // Delete the dict item that refers to the function, it will
4822 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4824 }
4825 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004826 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004827 // A normal function (not a numbered function or lambda) has a
4828 // refcount of 1 for the entry in the hashtable. When deleting
4829 // it and the refcount is more than one, it should be kept.
4830 // A numbered function and lambda should be kept if the refcount is
4831 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004832 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004833 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004834 // Function is still referenced somewhere. Don't free it but
4835 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004836 if (func_remove(fp))
4837 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004838 }
4839 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004840 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004841 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004842 }
4843}
4844
4845/*
4846 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004847 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 */
4849 void
4850func_unref(char_u *name)
4851{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004852 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004853
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004854 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004856 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004857 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004858 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004860 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004861#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004862 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004864 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004865}
4866
4867/*
4868 * Unreference a Function: decrement the reference count and free it when it
4869 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004870 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004871 */
4872 void
4873func_ptr_unref(ufunc_T *fp)
4874{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004875 if (fp != NULL && (--fp->uf_refcount <= 0
4876 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4877 && fp->uf_partial->pt_refcount <= 1
4878 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004879 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004880 // Only delete it when it's not being used. Otherwise it's done
4881 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004882 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004883 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004884 }
4885}
4886
4887/*
4888 * Count a reference to a Function.
4889 */
4890 void
4891func_ref(char_u *name)
4892{
4893 ufunc_T *fp;
4894
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004895 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004896 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004897 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004898 if (fp != NULL)
4899 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004900 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004901 // Only give an error for a numbered function.
4902 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004903 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004904}
4905
4906/*
4907 * Count a reference to a Function.
4908 */
4909 void
4910func_ptr_ref(ufunc_T *fp)
4911{
4912 if (fp != NULL)
4913 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914}
4915
4916/*
4917 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4918 * referenced from anywhere that is in use.
4919 */
4920 static int
4921can_free_funccal(funccall_T *fc, int copyID)
4922{
4923 return (fc->l_varlist.lv_copyID != copyID
4924 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004925 && fc->l_avars.dv_copyID != copyID
4926 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927}
4928
4929/*
4930 * ":return [expr]"
4931 */
4932 void
4933ex_return(exarg_T *eap)
4934{
4935 char_u *arg = eap->arg;
4936 typval_T rettv;
4937 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004938 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939
4940 if (current_funccal == NULL)
4941 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004942 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 return;
4944 }
4945
Bram Moolenaar844fb642021-10-23 13:32:30 +01004946 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004947 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4948
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949 if (eap->skip)
4950 ++emsg_skip;
4951
4952 eap->nextcmd = NULL;
4953 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004954 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 {
4956 if (!eap->skip)
4957 returning = do_return(eap, FALSE, TRUE, &rettv);
4958 else
4959 clear_tv(&rettv);
4960 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004961 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962 else if (!eap->skip)
4963 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004964 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004965 update_force_abort();
4966
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967 /*
4968 * Return unless the expression evaluation has been cancelled due to an
4969 * aborting error, an interrupt, or an exception.
4970 */
4971 if (!aborting())
4972 returning = do_return(eap, FALSE, TRUE, NULL);
4973 }
4974
Bram Moolenaare38eab22019-12-05 21:50:01 +01004975 // When skipping or the return gets pending, advance to the next command
4976 // in this line (!returning). Otherwise, ignore the rest of the line.
4977 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978 if (returning)
4979 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004980 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02004981 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982
4983 if (eap->skip)
4984 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004985 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004986}
4987
4988/*
4989 * ":1,25call func(arg1, arg2)" function call.
4990 */
4991 void
4992ex_call(exarg_T *eap)
4993{
4994 char_u *arg = eap->arg;
4995 char_u *startarg;
4996 char_u *name;
4997 char_u *tofree;
4998 int len;
4999 typval_T rettv;
5000 linenr_T lnum;
5001 int doesrange;
5002 int failed = FALSE;
5003 funcdict_T fudi;
5004 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005005 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005006 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005007
Bram Moolenaare6b53242020-07-01 17:28:33 +02005008 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009 if (eap->skip)
5010 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005011 // trans_function_name() doesn't work well when skipping, use eval0()
5012 // instead to skip to any following command, e.g. for:
5013 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005014 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005015 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016 clear_tv(&rettv);
5017 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005018 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005019 return;
5020 }
5021
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005022 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5023 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024 if (fudi.fd_newkey != NULL)
5025 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005026 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005027 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 vim_free(fudi.fd_newkey);
5029 }
5030 if (tofree == NULL)
5031 return;
5032
Bram Moolenaare38eab22019-12-05 21:50:01 +01005033 // Increase refcount on dictionary, it could get deleted when evaluating
5034 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035 if (fudi.fd_dict != NULL)
5036 ++fudi.fd_dict->dv_refcount;
5037
Bram Moolenaare38eab22019-12-05 21:50:01 +01005038 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5039 // contents. For VAR_PARTIAL get its partial, unless we already have one
5040 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005042 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
5043 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005044
Bram Moolenaare38eab22019-12-05 21:50:01 +01005045 // Skip white space to allow ":call func ()". Not good, but required for
5046 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048 if (*startarg != '(')
5049 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005050 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005051 goto end;
5052 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005053 if (in_vim9script() && startarg > arg)
5054 {
5055 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5056 goto end;
5057 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058
5059 /*
5060 * When skipping, evaluate the function once, to find the end of the
5061 * arguments.
5062 * When the function takes a range, this is discovered after the first
5063 * call, and the loop is broken.
5064 */
5065 if (eap->skip)
5066 {
5067 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005068 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005069 }
5070 else
5071 lnum = eap->line1;
5072 for ( ; lnum <= eap->line2; ++lnum)
5073 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005074 funcexe_T funcexe;
5075
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076 if (!eap->skip && eap->addr_count > 0)
5077 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005078 if (lnum > curbuf->b_ml.ml_line_count)
5079 {
5080 // If the function deleted lines or switched to another buffer
5081 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005082 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005083 break;
5084 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 curwin->w_cursor.lnum = lnum;
5086 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005087 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005088 }
5089 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005090
Bram Moolenaara80faa82020-04-12 19:37:17 +02005091 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005092 funcexe.firstline = eap->line1;
5093 funcexe.lastline = eap->line2;
5094 funcexe.doesrange = &doesrange;
5095 funcexe.evaluate = !eap->skip;
5096 funcexe.partial = partial;
5097 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005098 funcexe.check_type = type;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005099 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005100 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005101 {
5102 failed = TRUE;
5103 break;
5104 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005105 if (has_watchexpr())
5106 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005107
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005108 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005109 if (handle_subscript(&arg, &rettv,
5110 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111 {
5112 failed = TRUE;
5113 break;
5114 }
5115
5116 clear_tv(&rettv);
5117 if (doesrange || eap->skip)
5118 break;
5119
Bram Moolenaare38eab22019-12-05 21:50:01 +01005120 // Stop when immediately aborting on error, or when an interrupt
5121 // occurred or an exception was thrown but not caught.
5122 // get_func_tv() returned OK, so that the check for trailing
5123 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124 if (aborting())
5125 break;
5126 }
5127 if (eap->skip)
5128 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005129 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130
Bram Moolenaar1d341892021-09-18 15:25:52 +02005131 // When inside :try we need to check for following "| catch" or "| endtry".
5132 // Not when there was an error, but do check if an exception was thrown.
5133 if ((!aborting() || did_throw)
5134 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005135 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005136 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005137 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005138 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005139 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005140 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005141 {
5142 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005143 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005144 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145 }
5146 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005147 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005148 }
5149
5150end:
5151 dict_unref(fudi.fd_dict);
5152 vim_free(tofree);
5153}
5154
5155/*
5156 * Return from a function. Possibly makes the return pending. Also called
5157 * for a pending return at the ":endtry" or after returning from an extra
5158 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5159 * when called due to a ":return" command. "rettv" may point to a typval_T
5160 * with the return rettv. Returns TRUE when the return can be carried out,
5161 * FALSE when the return gets pending.
5162 */
5163 int
5164do_return(
5165 exarg_T *eap,
5166 int reanimate,
5167 int is_cmd,
5168 void *rettv)
5169{
5170 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005171 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172
5173 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005174 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175 current_funccal->returned = FALSE;
5176
5177 /*
5178 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5179 * not in its finally clause (which then is to be executed next) is found.
5180 * In this case, make the ":return" pending for execution at the ":endtry".
5181 * Otherwise, return normally.
5182 */
5183 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5184 if (idx >= 0)
5185 {
5186 cstack->cs_pending[idx] = CSTP_RETURN;
5187
5188 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005189 // A pending return again gets pending. "rettv" points to an
5190 // allocated variable with the rettv of the original ":return"'s
5191 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192 cstack->cs_rettv[idx] = rettv;
5193 else
5194 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005195 // When undoing a return in order to make it pending, get the stored
5196 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005197 if (reanimate)
5198 rettv = current_funccal->rettv;
5199
5200 if (rettv != NULL)
5201 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005202 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5204 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5205 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005206 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207 }
5208 else
5209 cstack->cs_rettv[idx] = NULL;
5210
5211 if (reanimate)
5212 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005213 // The pending return value could be overwritten by a ":return"
5214 // without argument in a finally clause; reset the default
5215 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 current_funccal->rettv->v_type = VAR_NUMBER;
5217 current_funccal->rettv->vval.v_number = 0;
5218 }
5219 }
5220 report_make_pending(CSTP_RETURN, rettv);
5221 }
5222 else
5223 {
5224 current_funccal->returned = TRUE;
5225
Bram Moolenaare38eab22019-12-05 21:50:01 +01005226 // If the return is carried out now, store the return value. For
5227 // a return immediately after reanimation, the value is already
5228 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005229 if (!reanimate && rettv != NULL)
5230 {
5231 clear_tv(current_funccal->rettv);
5232 *current_funccal->rettv = *(typval_T *)rettv;
5233 if (!is_cmd)
5234 vim_free(rettv);
5235 }
5236 }
5237
5238 return idx < 0;
5239}
5240
5241/*
5242 * Free the variable with a pending return value.
5243 */
5244 void
5245discard_pending_return(void *rettv)
5246{
5247 free_tv((typval_T *)rettv);
5248}
5249
5250/*
5251 * Generate a return command for producing the value of "rettv". The result
5252 * is an allocated string. Used by report_pending() for verbose messages.
5253 */
5254 char_u *
5255get_return_cmd(void *rettv)
5256{
5257 char_u *s = NULL;
5258 char_u *tofree = NULL;
5259 char_u numbuf[NUMBUFLEN];
5260
5261 if (rettv != NULL)
5262 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5263 if (s == NULL)
5264 s = (char_u *)"";
5265
5266 STRCPY(IObuff, ":return ");
5267 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5268 if (STRLEN(s) + 8 >= IOSIZE)
5269 STRCPY(IObuff + IOSIZE - 4, "...");
5270 vim_free(tofree);
5271 return vim_strsave(IObuff);
5272}
5273
5274/*
5275 * Get next function line.
5276 * Called by do_cmdline() to get the next line.
5277 * Returns allocated string, or NULL for end of function.
5278 */
5279 char_u *
5280get_func_line(
5281 int c UNUSED,
5282 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005283 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005284 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005285{
5286 funccall_T *fcp = (funccall_T *)cookie;
5287 ufunc_T *fp = fcp->func;
5288 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005289 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290
Bram Moolenaare38eab22019-12-05 21:50:01 +01005291 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005292 if (fcp->dbg_tick != debug_tick)
5293 {
5294 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005295 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005296 fcp->dbg_tick = debug_tick;
5297 }
5298#ifdef FEAT_PROFILE
5299 if (do_profiling == PROF_YES)
5300 func_line_end(cookie);
5301#endif
5302
5303 gap = &fp->uf_lines;
5304 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5305 || fcp->returned)
5306 retval = NULL;
5307 else
5308 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005309 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005310 while (fcp->linenr < gap->ga_len
5311 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5312 ++fcp->linenr;
5313 if (fcp->linenr >= gap->ga_len)
5314 retval = NULL;
5315 else
5316 {
5317 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005318 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319#ifdef FEAT_PROFILE
5320 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005321 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005322#endif
5323 }
5324 }
5325
Bram Moolenaare38eab22019-12-05 21:50:01 +01005326 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005327 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005328 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005329 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005330 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005331 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005332 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005333 fcp->dbg_tick = debug_tick;
5334 }
5335
5336 return retval;
5337}
5338
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339/*
5340 * Return TRUE if the currently active function should be ended, because a
5341 * return was encountered or an error occurred. Used inside a ":while".
5342 */
5343 int
5344func_has_ended(void *cookie)
5345{
5346 funccall_T *fcp = (funccall_T *)cookie;
5347
Bram Moolenaare38eab22019-12-05 21:50:01 +01005348 // Ignore the "abort" flag if the abortion behavior has been changed due to
5349 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5351 || fcp->returned);
5352}
5353
5354/*
5355 * return TRUE if cookie indicates a function which "abort"s on errors.
5356 */
5357 int
5358func_has_abort(
5359 void *cookie)
5360{
5361 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5362}
5363
5364
5365/*
5366 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5367 * Don't do this when "Func" is already a partial that was bound
5368 * explicitly (pt_auto is FALSE).
5369 * Changes "rettv" in-place.
5370 * Returns the updated "selfdict_in".
5371 */
5372 dict_T *
5373make_partial(dict_T *selfdict_in, typval_T *rettv)
5374{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005375 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 char_u *tofree = NULL;
5377 ufunc_T *fp;
5378 char_u fname_buf[FLEN_FIXED + 1];
5379 int error;
5380 dict_T *selfdict = selfdict_in;
5381
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005382 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5383 fp = rettv->vval.v_partial->pt_func;
5384 else
5385 {
5386 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5387 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005388 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005389 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005390 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005391 vim_free(tofree);
5392 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005393
5394 if (fp != NULL && (fp->uf_flags & FC_DICT))
5395 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005396 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005397
5398 if (pt != NULL)
5399 {
5400 pt->pt_refcount = 1;
5401 pt->pt_dict = selfdict;
5402 pt->pt_auto = TRUE;
5403 selfdict = NULL;
5404 if (rettv->v_type == VAR_FUNC)
5405 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005406 // Just a function: Take over the function name and use
5407 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005408 pt->pt_name = rettv->vval.v_string;
5409 }
5410 else
5411 {
5412 partial_T *ret_pt = rettv->vval.v_partial;
5413 int i;
5414
Bram Moolenaare38eab22019-12-05 21:50:01 +01005415 // Partial: copy the function name, use selfdict and copy
5416 // args. Can't take over name or args, the partial might
5417 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005418 if (ret_pt->pt_name != NULL)
5419 {
5420 pt->pt_name = vim_strsave(ret_pt->pt_name);
5421 func_ref(pt->pt_name);
5422 }
5423 else
5424 {
5425 pt->pt_func = ret_pt->pt_func;
5426 func_ptr_ref(pt->pt_func);
5427 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005428 if (ret_pt->pt_argc > 0)
5429 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005430 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005431 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005432 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005433 pt->pt_argc = 0;
5434 else
5435 {
5436 pt->pt_argc = ret_pt->pt_argc;
5437 for (i = 0; i < pt->pt_argc; i++)
5438 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5439 }
5440 }
5441 partial_unref(ret_pt);
5442 }
5443 rettv->v_type = VAR_PARTIAL;
5444 rettv->vval.v_partial = pt;
5445 }
5446 }
5447 return selfdict;
5448}
5449
5450/*
5451 * Return the name of the executed function.
5452 */
5453 char_u *
5454func_name(void *cookie)
5455{
5456 return ((funccall_T *)cookie)->func->uf_name;
5457}
5458
5459/*
5460 * Return the address holding the next breakpoint line for a funccall cookie.
5461 */
5462 linenr_T *
5463func_breakpoint(void *cookie)
5464{
5465 return &((funccall_T *)cookie)->breakpoint;
5466}
5467
5468/*
5469 * Return the address holding the debug tick for a funccall cookie.
5470 */
5471 int *
5472func_dbg_tick(void *cookie)
5473{
5474 return &((funccall_T *)cookie)->dbg_tick;
5475}
5476
5477/*
5478 * Return the nesting level for a funccall cookie.
5479 */
5480 int
5481func_level(void *cookie)
5482{
5483 return ((funccall_T *)cookie)->level;
5484}
5485
5486/*
5487 * Return TRUE when a function was ended by a ":return" command.
5488 */
5489 int
5490current_func_returned(void)
5491{
5492 return current_funccal->returned;
5493}
5494
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005495 int
5496free_unref_funccal(int copyID, int testing)
5497{
5498 int did_free = FALSE;
5499 int did_free_funccal = FALSE;
5500 funccall_T *fc, **pfc;
5501
5502 for (pfc = &previous_funccal; *pfc != NULL; )
5503 {
5504 if (can_free_funccal(*pfc, copyID))
5505 {
5506 fc = *pfc;
5507 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005508 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005509 did_free = TRUE;
5510 did_free_funccal = TRUE;
5511 }
5512 else
5513 pfc = &(*pfc)->caller;
5514 }
5515 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005516 // When a funccal was freed some more items might be garbage
5517 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005518 (void)garbage_collect(testing);
5519
5520 return did_free;
5521}
5522
5523/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005524 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525 */
5526 static funccall_T *
5527get_funccal(void)
5528{
5529 int i;
5530 funccall_T *funccal;
5531 funccall_T *temp_funccal;
5532
5533 funccal = current_funccal;
5534 if (debug_backtrace_level > 0)
5535 {
5536 for (i = 0; i < debug_backtrace_level; i++)
5537 {
5538 temp_funccal = funccal->caller;
5539 if (temp_funccal)
5540 funccal = temp_funccal;
5541 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005542 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005543 debug_backtrace_level = i;
5544 }
5545 }
5546 return funccal;
5547}
5548
5549/*
5550 * Return the hashtable used for local variables in the current funccal.
5551 * Return NULL if there is no current funccal.
5552 */
5553 hashtab_T *
5554get_funccal_local_ht()
5555{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005556 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005557 return NULL;
5558 return &get_funccal()->l_vars.dv_hashtab;
5559}
5560
5561/*
5562 * Return the l: scope variable.
5563 * Return NULL if there is no current funccal.
5564 */
5565 dictitem_T *
5566get_funccal_local_var()
5567{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005568 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005569 return NULL;
5570 return &get_funccal()->l_vars_var;
5571}
5572
5573/*
5574 * Return the hashtable used for argument in the current funccal.
5575 * Return NULL if there is no current funccal.
5576 */
5577 hashtab_T *
5578get_funccal_args_ht()
5579{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005580 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005581 return NULL;
5582 return &get_funccal()->l_avars.dv_hashtab;
5583}
5584
5585/*
5586 * Return the a: scope variable.
5587 * Return NULL if there is no current funccal.
5588 */
5589 dictitem_T *
5590get_funccal_args_var()
5591{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005592 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005593 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005594 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005595}
5596
5597/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005598 * List function variables, if there is a function.
5599 */
5600 void
5601list_func_vars(int *first)
5602{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005603 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005604 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005605 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005606}
5607
5608/*
5609 * If "ht" is the hashtable for local variables in the current funccal, return
5610 * the dict that contains it.
5611 * Otherwise return NULL.
5612 */
5613 dict_T *
5614get_current_funccal_dict(hashtab_T *ht)
5615{
5616 if (current_funccal != NULL
5617 && ht == &current_funccal->l_vars.dv_hashtab)
5618 return &current_funccal->l_vars;
5619 return NULL;
5620}
5621
5622/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005623 * Search hashitem in parent scope.
5624 */
5625 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005626find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005627{
5628 funccall_T *old_current_funccal = current_funccal;
5629 hashtab_T *ht;
5630 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005631 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005632
5633 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5634 return NULL;
5635
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005636 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005637 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005638 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005639 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005640 ht = find_var_ht(name, &varname);
5641 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005642 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005643 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005644 if (!HASHITEM_EMPTY(hi))
5645 {
5646 *pht = ht;
5647 break;
5648 }
5649 }
5650 if (current_funccal == current_funccal->func->uf_scoped)
5651 break;
5652 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005653 }
5654 current_funccal = old_current_funccal;
5655
5656 return hi;
5657}
5658
5659/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005660 * Search variable in parent scope.
5661 */
5662 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005663find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005664{
5665 dictitem_T *v = NULL;
5666 funccall_T *old_current_funccal = current_funccal;
5667 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005668 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005669
5670 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5671 return NULL;
5672
Bram Moolenaare38eab22019-12-05 21:50:01 +01005673 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005674 current_funccal = current_funccal->func->uf_scoped;
5675 while (current_funccal)
5676 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005677 ht = find_var_ht(name, &varname);
5678 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005679 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005680 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005681 if (v != NULL)
5682 break;
5683 }
5684 if (current_funccal == current_funccal->func->uf_scoped)
5685 break;
5686 current_funccal = current_funccal->func->uf_scoped;
5687 }
5688 current_funccal = old_current_funccal;
5689
5690 return v;
5691}
5692
5693/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005694 * Set "copyID + 1" in previous_funccal and callers.
5695 */
5696 int
5697set_ref_in_previous_funccal(int copyID)
5698{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005699 funccall_T *fc;
5700
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005701 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005702 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005703 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005704 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5705 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5706 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5707 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005708 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005709 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005710}
5711
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005712 static int
5713set_ref_in_funccal(funccall_T *fc, int copyID)
5714{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005715 if (fc->fc_copyID != copyID)
5716 {
5717 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005718 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5719 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5720 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5721 || set_ref_in_func(NULL, fc->func, copyID))
5722 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005723 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005724 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005725}
5726
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005727/*
5728 * Set "copyID" in all local vars and arguments in the call stack.
5729 */
5730 int
5731set_ref_in_call_stack(int copyID)
5732{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005733 funccall_T *fc;
5734 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005735
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005736 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5737 if (set_ref_in_funccal(fc, copyID))
5738 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005739
5740 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005741 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5742 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5743 if (set_ref_in_funccal(fc, copyID))
5744 return TRUE;
5745 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005746}
5747
5748/*
5749 * Set "copyID" in all functions available by name.
5750 */
5751 int
5752set_ref_in_functions(int copyID)
5753{
5754 int todo;
5755 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005756 ufunc_T *fp;
5757
5758 todo = (int)func_hashtab.ht_used;
5759 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005760 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005761 if (!HASHITEM_EMPTY(hi))
5762 {
5763 --todo;
5764 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005765 if (!func_name_refcount(fp->uf_name)
5766 && set_ref_in_func(NULL, fp, copyID))
5767 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005769 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005770 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005771}
5772
5773/*
5774 * Set "copyID" in all function arguments.
5775 */
5776 int
5777set_ref_in_func_args(int copyID)
5778{
5779 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005780
5781 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005782 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5783 copyID, NULL, NULL))
5784 return TRUE;
5785 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005786}
5787
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005788/*
5789 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005790 * Returns TRUE if setting references failed somehow.
5791 */
5792 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005793set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005794{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005795 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005796 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005797 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005798 char_u fname_buf[FLEN_FIXED + 1];
5799 char_u *tofree = NULL;
5800 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005801 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005802
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005803 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005804 return FALSE;
5805
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005806 if (fp_in == NULL)
5807 {
5808 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005809 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005810 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005811 if (fp != NULL)
5812 {
5813 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005814 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005815 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005816
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005817 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005818 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005819}
5820
Bram Moolenaare38eab22019-12-05 21:50:01 +01005821#endif // FEAT_EVAL