blob: 5f2ede753be8873395d250f44accfb88180fd863 [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 Moolenaar2ef91562021-12-11 16:14:07 +00001547 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 */
1549 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001550deref_func_name(
1551 char_u *name,
1552 int *lenp,
1553 partial_T **partialp,
1554 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001555 int no_autoload,
1556 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001557{
1558 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001559 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001561 char_u *s = NULL;
1562 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001563 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564
1565 if (partialp != NULL)
1566 *partialp = NULL;
1567
1568 cc = name[*lenp];
1569 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001570
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001571 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001573 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001575 tv = &v->di_tv;
1576 }
1577 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1578 {
1579 imported_T *import;
1580 char_u *p = name;
1581 int len = *lenp;
1582
1583 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001585 p = name + 2;
1586 len -= 2;
1587 }
1588 import = find_imported(p, len, NULL);
1589
1590 // imported variable from another script
1591 if (import != NULL)
1592 {
1593 if (import->imp_funcname != NULL)
1594 {
1595 s = import->imp_funcname;
1596 *lenp = (int)STRLEN(s);
1597 return s;
1598 }
Bram Moolenaarf8a79fc2021-12-14 12:06:16 +00001599 if (import->imp_flags & IMP_FLAGS_STAR)
1600 {
1601 name[len] = NUL;
1602 semsg(_(e_cannot_use_str_itself_it_is_imported_with_star),
1603 name);
1604 name[len] = cc;
1605 *lenp = 0;
1606 return (char_u *)""; // just in case
1607 }
1608 else
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001609 {
1610 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1611 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1612 + import->imp_var_vals_idx;
1613 tv = sv->sv_tv;
1614 if (type != NULL)
1615 *type = sv->sv_type;
1616 did_type = TRUE;
1617 }
1618 }
1619 }
1620
1621 if (tv != NULL)
1622 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001623 if (found_var != NULL)
1624 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001625 if (tv->v_type == VAR_FUNC)
1626 {
1627 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001628 {
1629 *lenp = 0;
1630 return (char_u *)""; // just in case
1631 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001632 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001633 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001636 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001638 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001639
1640 if (pt == NULL)
1641 {
1642 *lenp = 0;
1643 return (char_u *)""; // just in case
1644 }
1645 if (partialp != NULL)
1646 *partialp = pt;
1647 s = partial_name(pt);
1648 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001650
1651 if (s != NULL)
1652 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001653 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001654 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001655 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001656
1657 if (sv != NULL)
1658 *type = sv->sv_type;
1659 }
1660 return s;
1661 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001662 }
1663
1664 return name;
1665}
1666
1667/*
1668 * Give an error message with a function name. Handle <SNR> things.
1669 * "ermsg" is to be passed without translation, use N_() instead of _().
1670 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001671 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672emsg_funcname(char *ermsg, char_u *name)
1673{
1674 char_u *p;
1675
1676 if (*name == K_SPECIAL)
1677 p = concat_str((char_u *)"<SNR>", name + 3);
1678 else
1679 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001680 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 if (p != name)
1682 vim_free(p);
1683}
1684
1685/*
1686 * Allocate a variable for the result of a function.
1687 * Return OK or FAIL.
1688 */
1689 int
1690get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001691 char_u *name, // name of the function
1692 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001694 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001695 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001696 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697{
1698 char_u *argp;
1699 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001700 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1701 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001702 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703
1704 /*
1705 * Get the arguments.
1706 */
1707 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001708 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1709 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001711 // skip the '(' or ',' and possibly line breaks
1712 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1713
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 if (*argp == ')' || *argp == ',' || *argp == NUL)
1715 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001716 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 {
1718 ret = FAIL;
1719 break;
1720 }
1721 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001722 // The comma should come right after the argument, but this wasn't
1723 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001724 if (vim9script)
1725 {
1726 if (*argp != ',' && *skipwhite(argp) == ',')
1727 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001728 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001729 ret = FAIL;
1730 break;
1731 }
1732 }
1733 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001734 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735 if (*argp != ',')
1736 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001737 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1738 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001739 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001740 ret = FAIL;
1741 break;
1742 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001744 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 if (*argp == ')')
1746 ++argp;
1747 else
1748 ret = FAIL;
1749
1750 if (ret == OK)
1751 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001752 int i = 0;
1753 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754
1755 if (get_vim_var_nr(VV_TESTING))
1756 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001757 // Prepare for calling test_garbagecollect_now(), need to know
1758 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 if (funcargs.ga_itemsize == 0)
1760 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1761 for (i = 0; i < argcount; ++i)
1762 if (ga_grow(&funcargs, 1) == OK)
1763 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1764 &argvars[i];
1765 }
1766
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001767 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001768 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001769 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001770 // An error in a builtin function does not return FAIL, but we do
1771 // want to abort further processing if an error was given.
1772 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001773 clear_tv(rettv);
1774 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775
1776 funcargs.ga_len -= i;
1777 }
1778 else if (!aborting())
1779 {
1780 if (argcount == MAX_FUNC_ARGS)
1781 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1782 else
1783 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1784 }
1785
1786 while (--argcount >= 0)
1787 clear_tv(&argvars[argcount]);
1788
Bram Moolenaar8294d492020-08-10 22:40:56 +02001789 if (in_vim9script())
1790 *arg = argp;
1791 else
1792 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 return ret;
1794}
1795
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796/*
1797 * Return TRUE if "p" starts with "<SID>" or "s:".
1798 * Only works if eval_fname_script() returned non-zero for "p"!
1799 */
1800 static int
1801eval_fname_sid(char_u *p)
1802{
1803 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1804}
1805
1806/*
1807 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1808 * Change <SNR>123_name() to K_SNR 123_name().
1809 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1810 * (slow).
1811 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001812 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1814{
1815 int llen;
1816 char_u *fname;
1817 int i;
1818
1819 llen = eval_fname_script(name);
1820 if (llen > 0)
1821 {
1822 fname_buf[0] = K_SPECIAL;
1823 fname_buf[1] = KS_EXTRA;
1824 fname_buf[2] = (int)KE_SNR;
1825 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001826 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001828 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001829 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 else
1831 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001832 sprintf((char *)fname_buf + 3, "%ld_",
1833 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 i = (int)STRLEN(fname_buf);
1835 }
1836 }
1837 if (i + STRLEN(name + llen) < FLEN_FIXED)
1838 {
1839 STRCPY(fname_buf + i, name + llen);
1840 fname = fname_buf;
1841 }
1842 else
1843 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001844 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001846 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001847 else
1848 {
1849 *tofree = fname;
1850 mch_memmove(fname, fname_buf, (size_t)i);
1851 STRCPY(fname + i, name + llen);
1852 }
1853 }
1854 }
1855 else
1856 fname = name;
1857 return fname;
1858}
1859
1860/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001861 * Find a function "name" in script "sid".
1862 */
1863 static ufunc_T *
1864find_func_with_sid(char_u *name, int sid)
1865{
1866 hashitem_T *hi;
1867 char_u buffer[200];
1868
1869 buffer[0] = K_SPECIAL;
1870 buffer[1] = KS_EXTRA;
1871 buffer[2] = (int)KE_SNR;
1872 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1873 (long)sid, name);
1874 hi = hash_find(&func_hashtab, buffer);
1875 if (!HASHITEM_EMPTY(hi))
1876 return HI2UF(hi);
1877
1878 return NULL;
1879}
1880
1881/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001882 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001883 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884 * Return NULL for unknown function.
1885 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001886 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001887find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001888{
1889 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001890 ufunc_T *func;
1891 imported_T *imported;
1892
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001893 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001894 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001895 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001896 long sid = 0;
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001897 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1898 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001899
Bram Moolenaar95006e32020-08-29 17:47:08 +02001900 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001901 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001902 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001903 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1904 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001905 if (func != NULL)
1906 return func;
1907 }
1908
Bram Moolenaarefa94442020-08-08 22:16:00 +02001909 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001910 && name[1] == KS_EXTRA
1911 && name[2] == KE_SNR)
1912 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001913 // Caller changes s: to <SNR>99_name.
1914
1915 after_script = name + 3;
1916 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001917 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001918 ++after_script;
1919 else
1920 after_script = NULL;
1921 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001922 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001923 {
1924 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001925 if (after_script != NULL && sid != current_sctx.sc_sid)
1926 imported = find_imported_in_script(after_script, 0, sid);
1927 else
1928 imported = find_imported(after_script == NULL
1929 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001930 if (imported != NULL && imported->imp_funcname != NULL)
1931 {
1932 hi = hash_find(&func_hashtab, imported->imp_funcname);
1933 if (!HASHITEM_EMPTY(hi))
1934 return HI2UF(hi);
1935 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001936 }
1937 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938
Bram Moolenaara26b9702020-04-18 19:53:28 +02001939 hi = hash_find(&func_hashtab,
1940 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001941 if (!HASHITEM_EMPTY(hi))
1942 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001943
1944 return NULL;
1945}
1946
1947/*
1948 * Find a function by name, return pointer to it in ufuncs.
1949 * "cctx" is passed in a :def function to find imported functions.
1950 * Return NULL for unknown or dead function.
1951 */
1952 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001953find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001955 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956
1957 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1958 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001959 return NULL;
1960}
1961
1962/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001963 * Return TRUE if "ufunc" is a global function.
1964 */
1965 int
1966func_is_global(ufunc_T *ufunc)
1967{
1968 return ufunc->uf_name[0] != K_SPECIAL;
1969}
1970
1971/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001972 * Copy the function name of "fp" to buffer "buf".
1973 * "buf" must be able to hold the function name plus three bytes.
1974 * Takes care of script-local function names.
1975 */
1976 static void
1977cat_func_name(char_u *buf, ufunc_T *fp)
1978{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001979 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001980 {
1981 STRCPY(buf, "<SNR>");
1982 STRCAT(buf, fp->uf_name + 3);
1983 }
1984 else
1985 STRCPY(buf, fp->uf_name);
1986}
1987
1988/*
1989 * Add a number variable "name" to dict "dp" with value "nr".
1990 */
1991 static void
1992add_nr_var(
1993 dict_T *dp,
1994 dictitem_T *v,
1995 char *name,
1996 varnumber_T nr)
1997{
1998 STRCPY(v->di_key, name);
1999 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2000 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2001 v->di_tv.v_type = VAR_NUMBER;
2002 v->di_tv.v_lock = VAR_FIXED;
2003 v->di_tv.vval.v_number = nr;
2004}
2005
2006/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002007 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002008 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002009 static void
2010free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002011{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002012 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002013
2014 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2015 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002016 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002017
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002018 // When garbage collecting a funccall_T may be freed before the
2019 // function that references it, clear its uf_scoped field.
2020 // The function may have been redefined and point to another
2021 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002022 if (fp != NULL && fp->uf_scoped == fc)
2023 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002024 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002025 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002026
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002027 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 vim_free(fc);
2029}
2030
2031/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002032 * Free "fc" and what it contains.
2033 * Can be called only when "fc" is kept beyond the period of it called,
2034 * i.e. after cleanup_function_call(fc).
2035 */
2036 static void
2037free_funccal_contents(funccall_T *fc)
2038{
2039 listitem_T *li;
2040
2041 // Free all l: variables.
2042 vars_clear(&fc->l_vars.dv_hashtab);
2043
2044 // Free all a: variables.
2045 vars_clear(&fc->l_avars.dv_hashtab);
2046
2047 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002048 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002049 clear_tv(&li->li_tv);
2050
2051 free_funccal(fc);
2052}
2053
2054/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002055 * Handle the last part of returning from a function: free the local hashtable.
2056 * Unless it is still in use by a closure.
2057 */
2058 static void
2059cleanup_function_call(funccall_T *fc)
2060{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002061 int may_free_fc = fc->fc_refcount <= 0;
2062 int free_fc = TRUE;
2063
Bram Moolenaar6914c642017-04-01 21:21:30 +02002064 current_funccal = fc->caller;
2065
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002066 // Free all l: variables if not referred.
2067 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2068 vars_clear(&fc->l_vars.dv_hashtab);
2069 else
2070 free_fc = FALSE;
2071
2072 // If the a:000 list and the l: and a: dicts are not referenced and
2073 // there is no closure using it, we can free the funccall_T and what's
2074 // in it.
2075 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2076 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002077 else
2078 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002079 int todo;
2080 hashitem_T *hi;
2081 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002082
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002083 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002084
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002085 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002086 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2087 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2088 {
2089 if (!HASHITEM_EMPTY(hi))
2090 {
2091 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002092 di = HI2DI(hi);
2093 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002094 }
2095 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002096 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002097
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002098 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2099 fc->l_varlist.lv_first = NULL;
2100 else
2101 {
2102 listitem_T *li;
2103
2104 free_fc = FALSE;
2105
2106 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002107 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002108 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002109 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002110
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002111 if (free_fc)
2112 free_funccal(fc);
2113 else
2114 {
2115 static int made_copy = 0;
2116
2117 // "fc" is still in use. This can happen when returning "a:000",
2118 // assigning "l:" to a global variable or defining a closure.
2119 // Link "fc" in the list for garbage collection later.
2120 fc->caller = previous_funccal;
2121 previous_funccal = fc;
2122
2123 if (want_garbage_collect)
2124 // If garbage collector is ready, clear count.
2125 made_copy = 0;
2126 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002127 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002128 // We have made a lot of copies, worth 4 Mbyte. This can happen
2129 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002130 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002131 // too much memory.
2132 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002133 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002134 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002135 }
2136}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002137
2138/*
2139 * There are two kinds of function names:
2140 * 1. ordinary names, function defined with :function or :def
2141 * 2. numbered functions and lambdas
2142 * For the first we only count the name stored in func_hashtab as a reference,
2143 * using function() does not count as a reference, because the function is
2144 * looked up by name.
2145 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002146 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002147func_name_refcount(char_u *name)
2148{
2149 return isdigit(*name) || *name == '<';
2150}
2151
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002152/*
2153 * Unreference "fc": decrement the reference count and free it when it
2154 * becomes zero. "fp" is detached from "fc".
2155 * When "force" is TRUE we are exiting.
2156 */
2157 static void
2158funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2159{
2160 funccall_T **pfc;
2161 int i;
2162
2163 if (fc == NULL)
2164 return;
2165
2166 if (--fc->fc_refcount <= 0 && (force || (
2167 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2168 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2169 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2170 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2171 {
2172 if (fc == *pfc)
2173 {
2174 *pfc = fc->caller;
2175 free_funccal_contents(fc);
2176 return;
2177 }
2178 }
2179 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2180 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2181 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2182}
2183
2184/*
2185 * Remove the function from the function hashtable. If the function was
2186 * deleted while it still has references this was already done.
2187 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2188 */
2189 static int
2190func_remove(ufunc_T *fp)
2191{
2192 hashitem_T *hi;
2193
2194 // Return if it was already virtually deleted.
2195 if (fp->uf_flags & FC_DEAD)
2196 return FALSE;
2197
2198 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2199 if (!HASHITEM_EMPTY(hi))
2200 {
2201 // When there is a def-function index do not actually remove the
2202 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002203 // Do remove it when it's a copy.
2204 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002205 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002206 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002207 return FALSE;
2208 }
2209 hash_remove(&func_hashtab, hi);
2210 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002211 return TRUE;
2212 }
2213 return FALSE;
2214}
2215
2216 static void
2217func_clear_items(ufunc_T *fp)
2218{
2219 ga_clear_strings(&(fp->uf_args));
2220 ga_clear_strings(&(fp->uf_def_args));
2221 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002222 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002223 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002224 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002225 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002226
2227 // Increment the refcount of this function to avoid it being freed
2228 // recursively when the partial is freed.
2229 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002230 partial_unref(fp->uf_partial);
2231 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002232 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002233
2234#ifdef FEAT_LUA
2235 if (fp->uf_cb_free != NULL)
2236 {
2237 fp->uf_cb_free(fp->uf_cb_state);
2238 fp->uf_cb_free = NULL;
2239 }
2240
2241 fp->uf_cb_state = NULL;
2242 fp->uf_cb = NULL;
2243#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002244#ifdef FEAT_PROFILE
2245 VIM_CLEAR(fp->uf_tml_count);
2246 VIM_CLEAR(fp->uf_tml_total);
2247 VIM_CLEAR(fp->uf_tml_self);
2248#endif
2249}
2250
2251/*
2252 * Free all things that a function contains. Does not free the function
2253 * itself, use func_free() for that.
2254 * When "force" is TRUE we are exiting.
2255 */
2256 static void
2257func_clear(ufunc_T *fp, int force)
2258{
2259 if (fp->uf_cleared)
2260 return;
2261 fp->uf_cleared = TRUE;
2262
2263 // clear this function
2264 func_clear_items(fp);
2265 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002266 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002267}
2268
2269/*
2270 * Free a function and remove it from the list of functions. Does not free
2271 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002272 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002273 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002275 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002276func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002277{
2278 // Only remove it when not done already, otherwise we would remove a newer
2279 // version of the function with the same name.
2280 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2281 func_remove(fp);
2282
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002283 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002284 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002285 if (fp->uf_dfunc_idx > 0)
2286 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002287 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002288 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002289 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002290 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002291 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002292}
2293
2294/*
2295 * Free all things that a function contains and free the function itself.
2296 * When "force" is TRUE we are exiting.
2297 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002298 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002299func_clear_free(ufunc_T *fp, int force)
2300{
2301 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002302 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2303 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002304 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002305 else
2306 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002307}
2308
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002309/*
2310 * Copy already defined function "lambda" to a new function with name "global".
2311 * This is for when a compiled function defines a global function.
2312 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002313 int
2314copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002315{
2316 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002317 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002318
2319 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002320 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002321 semsg(_(e_lambda_function_not_found_str), lambda);
2322 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002323 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002324
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002325 fp = find_func(global, TRUE, NULL);
2326 if (fp != NULL)
2327 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002328 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002329 semsg(_(e_funcexts), global);
2330 return FAIL;
2331 }
2332
2333 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2334 if (fp == NULL)
2335 return FAIL;
2336
2337 fp->uf_varargs = ufunc->uf_varargs;
2338 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2339 fp->uf_def_status = ufunc->uf_def_status;
2340 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2341 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2342 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2343 == FAIL
2344 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2345 goto failed;
2346
2347 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2348 : vim_strsave(ufunc->uf_name_exp);
2349 if (ufunc->uf_arg_types != NULL)
2350 {
2351 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2352 if (fp->uf_arg_types == NULL)
2353 goto failed;
2354 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2355 sizeof(type_T *) * fp->uf_args.ga_len);
2356 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002357 if (ufunc->uf_va_name != NULL)
2358 {
2359 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2360 if (fp->uf_va_name == NULL)
2361 goto failed;
2362 }
2363 fp->uf_ret_type = ufunc->uf_ret_type;
2364
2365 fp->uf_refcount = 1;
2366 STRCPY(fp->uf_name, global);
2367 hash_add(&func_hashtab, UF2HIKEY(fp));
2368
2369 // the referenced dfunc_T is now used one more time
2370 link_def_function(fp);
2371
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002372 // Create a partial to store the context of the function where it was
2373 // instantiated. Only needs to be done once. Do this on the original
2374 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002375 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2376 {
2377 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2378
2379 if (pt == NULL)
2380 goto failed;
2381 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002382 {
2383 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002384 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002385 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002386 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002387 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002388 }
2389
2390 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002391
2392failed:
2393 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002394 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002395}
2396
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002397static int funcdepth = 0;
2398
2399/*
2400 * Increment the function call depth count.
2401 * Return FAIL when going over 'maxfuncdepth'.
2402 * Otherwise return OK, must call funcdepth_decrement() later!
2403 */
2404 int
2405funcdepth_increment(void)
2406{
2407 if (funcdepth >= p_mfd)
2408 {
2409 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2410 return FAIL;
2411 }
2412 ++funcdepth;
2413 return OK;
2414}
2415
2416 void
2417funcdepth_decrement(void)
2418{
2419 --funcdepth;
2420}
2421
2422/*
2423 * Get the current function call depth.
2424 */
2425 int
2426funcdepth_get(void)
2427{
2428 return funcdepth;
2429}
2430
2431/*
2432 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002433 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002434 * times as funcdepth_increment().
2435 */
2436 void
2437funcdepth_restore(int depth)
2438{
2439 funcdepth = depth;
2440}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002441
2442/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443 * Call a user function.
2444 */
2445 static void
2446call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002447 ufunc_T *fp, // pointer to function
2448 int argcount, // nr of args
2449 typval_T *argvars, // arguments
2450 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002451 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002452 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002454 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002455 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002456 funccall_T *fc;
2457 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002458 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002459 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002460 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 int i;
2462 int ai;
2463 int islambda = FALSE;
2464 char_u numbuf[NUMBUFLEN];
2465 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002466 typval_T *tv_to_free[MAX_FUNC_ARGS];
2467 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002469 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002471 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472
Bram Moolenaarb2049902021-01-24 12:53:53 +01002473#ifdef FEAT_PROFILE
2474 CLEAR_FIELD(profile_info);
2475#endif
2476
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002477 // If depth of calling is getting too high, don't execute the function.
2478 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 rettv->v_type = VAR_NUMBER;
2481 rettv->vval.v_number = -1;
2482 return;
2483 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484
Bram Moolenaare38eab22019-12-05 21:50:01 +01002485 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002487 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002488 if (fc == NULL)
2489 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 fc->caller = current_funccal;
2491 current_funccal = fc;
2492 fc->func = fp;
2493 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002495 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2497 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002498 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002499 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002500 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002502 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002503 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002504#ifdef FEAT_PROFILE
2505 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2506#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002507 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002508#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002509 if (do_profiling == PROF_YES)
2510 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002511#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002512 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002513 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002514#ifdef FEAT_PROFILE
2515 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002516 || (caller != NULL && caller->uf_profiling)))
2517 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002518#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002519 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002520 free_funccal(fc);
2521 return;
2522 }
2523
Bram Moolenaar38453522021-11-28 22:00:12 +00002524 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525
2526 /*
2527 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2528 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2529 * each argument variable and saves a lot of time.
2530 */
2531 /*
2532 * Init l: variables.
2533 */
2534 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2535 if (selfdict != NULL)
2536 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002537 // Set l:self to "selfdict". Use "name" to avoid a warning from
2538 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 v = &fc->fixvar[fixvar_idx++].var;
2540 name = v->di_key;
2541 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002542 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2544 v->di_tv.v_type = VAR_DICT;
2545 v->di_tv.v_lock = 0;
2546 v->di_tv.vval.v_dict = selfdict;
2547 ++selfdict->dv_refcount;
2548 }
2549
2550 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002551 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002552 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 * Set a:000 to a list with room for the "..." arguments.
2554 */
2555 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002556 if ((fp->uf_flags & FC_NOARGS) == 0)
2557 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002558 (varnumber_T)(argcount >= fp->uf_args.ga_len
2559 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002560 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002561 if ((fp->uf_flags & FC_NOARGS) == 0)
2562 {
2563 // Use "name" to avoid a warning from some compiler that checks the
2564 // destination size.
2565 v = &fc->fixvar[fixvar_idx++].var;
2566 name = v->di_key;
2567 STRCPY(name, "000");
2568 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2569 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2570 v->di_tv.v_type = VAR_LIST;
2571 v->di_tv.v_lock = VAR_FIXED;
2572 v->di_tv.vval.v_list = &fc->l_varlist;
2573 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002574 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2576 fc->l_varlist.lv_lock = VAR_FIXED;
2577
2578 /*
2579 * Set a:firstline to "firstline" and a:lastline to "lastline".
2580 * Set a:name to named arguments.
2581 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002582 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002583 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002584 if ((fp->uf_flags & FC_NOARGS) == 0)
2585 {
2586 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002587 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002588 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002589 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002590 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002591 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592 {
2593 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002594 typval_T def_rettv;
2595 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002596
2597 ai = i - fp->uf_args.ga_len;
2598 if (ai < 0)
2599 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002600 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 name = FUNCARG(fp, i);
2602 if (islambda)
2603 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002604
2605 // evaluate named argument default expression
2606 isdefault = ai + fp->uf_def_args.ga_len >= 0
2607 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2608 && argvars[i].vval.v_number == VVAL_NONE));
2609 if (isdefault)
2610 {
2611 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002612
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002613 def_rettv.v_type = VAR_NUMBER;
2614 def_rettv.vval.v_number = -1;
2615
2616 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2617 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002618 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002619 {
2620 default_arg_err = 1;
2621 break;
2622 }
2623 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624 }
2625 else
2626 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002627 if ((fp->uf_flags & FC_NOARGS) != 0)
2628 // Bail out if no a: arguments used (in lambda).
2629 break;
2630
Bram Moolenaare38eab22019-12-05 21:50:01 +01002631 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 sprintf((char *)numbuf, "%d", ai + 1);
2633 name = numbuf;
2634 }
2635 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2636 {
2637 v = &fc->fixvar[fixvar_idx++].var;
2638 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002639 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 }
2641 else
2642 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002643 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 if (v == NULL)
2645 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002646 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002649 // Note: the values are copied directly to avoid alloc/free.
2650 // "argvars" must have VAR_FIXED for v_lock.
2651 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 v->di_tv.v_lock = VAR_FIXED;
2653
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002654 if (isdefault)
2655 // Need to free this later, no matter where it's stored.
2656 tv_to_free[tv_to_free_len++] = &v->di_tv;
2657
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658 if (addlocal)
2659 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 // Named arguments should be accessed without the "a:" prefix in
2661 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002662 copy_tv(&v->di_tv, &v->di_tv);
2663 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002665 else
2666 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667
2668 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2669 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002670 listitem_T *li = &fc->l_listitems[ai];
2671
2672 li->li_tv = argvars[i];
2673 li->li_tv.v_lock = VAR_FIXED;
2674 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 }
2676 }
2677
Bram Moolenaare38eab22019-12-05 21:50:01 +01002678 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002680
2681 if (fp->uf_flags & FC_SANDBOX)
2682 {
2683 using_sandbox = TRUE;
2684 ++sandbox;
2685 }
2686
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002687 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002688 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002689 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002691 ++no_wait_return;
2692 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002694 smsg(_("calling %s"), SOURCING_NAME);
2695 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002697 char_u buf[MSG_BUF_LEN];
2698 char_u numbuf2[NUMBUFLEN];
2699 char_u *tofree;
2700 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002702 msg_puts("(");
2703 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002705 if (i > 0)
2706 msg_puts(", ");
2707 if (argvars[i].v_type == VAR_NUMBER)
2708 msg_outnum((long)argvars[i].vval.v_number);
2709 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002711 // Do not want errors such as E724 here.
2712 ++emsg_off;
2713 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2714 --emsg_off;
2715 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002717 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002719 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2720 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002722 msg_puts((char *)s);
2723 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 }
2725 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002726 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002727 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002729 msg_puts("\n"); // don't overwrite this either
2730
2731 verbose_leave_scroll();
2732 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 }
2734#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002735 if (do_profiling == PROF_YES)
2736 profile_may_start_func(&profile_info, fp,
2737 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002738#endif
2739
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002740 save_current_sctx = current_sctx;
2741 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 save_did_emsg = did_emsg;
2743 did_emsg = FALSE;
2744
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002745 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2746 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002747 else if (islambda)
2748 {
2749 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2750
2751 // A Lambda always has the command "return {expr}". It is much faster
2752 // to evaluate {expr} directly.
2753 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002754 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002755 --ex_nesting_level;
2756 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002757 else
2758 // call do_cmdline() to execute the lines
2759 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2761
2762 --RedrawingDisabled;
2763
Bram Moolenaare38eab22019-12-05 21:50:01 +01002764 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2766 {
2767 clear_tv(rettv);
2768 rettv->v_type = VAR_NUMBER;
2769 rettv->vval.v_number = -1;
2770 }
2771
2772#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002773 if (do_profiling == PROF_YES)
2774 {
2775 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2776
2777 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2778 profile_may_end_func(&profile_info, fp, caller);
2779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780#endif
2781
Bram Moolenaare38eab22019-12-05 21:50:01 +01002782 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 if (p_verbose >= 12)
2784 {
2785 ++no_wait_return;
2786 verbose_enter_scroll();
2787
2788 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002789 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002791 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 (long)fc->rettv->vval.v_number);
2793 else
2794 {
2795 char_u buf[MSG_BUF_LEN];
2796 char_u numbuf2[NUMBUFLEN];
2797 char_u *tofree;
2798 char_u *s;
2799
Bram Moolenaare38eab22019-12-05 21:50:01 +01002800 // The value may be very long. Skip the middle part, so that we
2801 // have some idea how it starts and ends. smsg() would always
2802 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 ++emsg_off;
2804 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2805 --emsg_off;
2806 if (s != NULL)
2807 {
2808 if (vim_strsize(s) > MSG_BUF_CLEN)
2809 {
2810 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2811 s = buf;
2812 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002813 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 vim_free(tofree);
2815 }
2816 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002817 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818
2819 verbose_leave_scroll();
2820 --no_wait_return;
2821 }
2822
Bram Moolenaare31ee862020-01-07 20:59:34 +01002823 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002825 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826#ifdef FEAT_PROFILE
2827 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002828 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002830 if (using_sandbox)
2831 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002833 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 {
2835 ++no_wait_return;
2836 verbose_enter_scroll();
2837
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002838 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002839 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840
2841 verbose_leave_scroll();
2842 --no_wait_return;
2843 }
2844
2845 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002846 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002847 for (i = 0; i < tv_to_free_len; ++i)
2848 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002849 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850}
2851
2852/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002853 * Check the argument count for user function "fp".
2854 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2855 */
2856 int
2857check_user_func_argcount(ufunc_T *fp, int argcount)
2858{
2859 int regular_args = fp->uf_args.ga_len;
2860
2861 if (argcount < regular_args - fp->uf_def_args.ga_len)
2862 return FCERR_TOOFEW;
2863 else if (!has_varargs(fp) && argcount > regular_args)
2864 return FCERR_TOOMANY;
2865 return FCERR_UNKNOWN;
2866}
2867
2868/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002869 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002870 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002871 int
2872call_user_func_check(
2873 ufunc_T *fp,
2874 int argcount,
2875 typval_T *argvars,
2876 typval_T *rettv,
2877 funcexe_T *funcexe,
2878 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002879{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002880 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002881
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002882 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2883 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002884 error = check_user_func_argcount(fp, argcount);
2885 if (error != FCERR_UNKNOWN)
2886 return error;
2887 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002888 error = FCERR_DICT;
2889 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002890 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002891 int did_save_redo = FALSE;
2892 save_redo_T save_redo;
2893
2894 /*
2895 * Call the user function.
2896 * Save and restore search patterns, script variables and
2897 * redo buffer.
2898 */
2899 save_search_patterns();
2900 if (!ins_compl_active())
2901 {
2902 saveRedobuff(&save_redo);
2903 did_save_redo = TRUE;
2904 }
2905 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002906 call_user_func(fp, argcount, argvars, rettv, funcexe,
2907 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002908 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2909 // Function was unreferenced while being used, free it now.
2910 func_clear_free(fp, FALSE);
2911 if (did_save_redo)
2912 restoreRedobuff(&save_redo);
2913 restore_search_patterns();
2914 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002915 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002916 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002917}
2918
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002919static funccal_entry_T *funccal_stack = NULL;
2920
2921/*
2922 * Save the current function call pointer, and set it to NULL.
2923 * Used when executing autocommands and for ":source".
2924 */
2925 void
2926save_funccal(funccal_entry_T *entry)
2927{
2928 entry->top_funccal = current_funccal;
2929 entry->next = funccal_stack;
2930 funccal_stack = entry;
2931 current_funccal = NULL;
2932}
2933
2934 void
2935restore_funccal(void)
2936{
2937 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002938 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002939 else
2940 {
2941 current_funccal = funccal_stack->top_funccal;
2942 funccal_stack = funccal_stack->next;
2943 }
2944}
2945
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002946 funccall_T *
2947get_current_funccal(void)
2948{
2949 return current_funccal;
2950}
2951
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002952/*
2953 * Mark all functions of script "sid" as deleted.
2954 */
2955 void
2956delete_script_functions(int sid)
2957{
2958 hashitem_T *hi;
2959 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002960 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002961 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002962 size_t len;
2963
2964 buf[0] = K_SPECIAL;
2965 buf[1] = KS_EXTRA;
2966 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002967 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002968 len = STRLEN(buf);
2969
Bram Moolenaarce658352020-07-31 23:47:12 +02002970 while (todo > 0)
2971 {
2972 todo = func_hashtab.ht_used;
2973 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2974 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002975 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002976 fp = HI2UF(hi);
2977 if (STRNCMP(fp->uf_name, buf, len) == 0)
2978 {
2979 int changed = func_hashtab.ht_changed;
2980
2981 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002982
2983 if (fp->uf_calls > 0)
2984 {
2985 // Function is executing, don't free it but do remove
2986 // it from the hashtable.
2987 if (func_remove(fp))
2988 fp->uf_refcount--;
2989 }
2990 else
2991 {
2992 func_clear(fp, TRUE);
2993 // When clearing a function another function can be
2994 // cleared as a side effect. When that happens start
2995 // over.
2996 if (changed != func_hashtab.ht_changed)
2997 break;
2998 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002999 }
3000 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003001 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003002 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003003}
3004
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005#if defined(EXITFREE) || defined(PROTO)
3006 void
3007free_all_functions(void)
3008{
3009 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003010 ufunc_T *fp;
3011 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003012 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003013 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014
Bram Moolenaare38eab22019-12-05 21:50:01 +01003015 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003016 while (current_funccal != NULL)
3017 {
3018 clear_tv(current_funccal->rettv);
3019 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003020 if (current_funccal == NULL && funccal_stack != NULL)
3021 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003022 }
3023
Bram Moolenaare38eab22019-12-05 21:50:01 +01003024 // First clear what the functions contain. Since this may lower the
3025 // reference count of a function, it may also free a function and change
3026 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003027 while (todo > 0)
3028 {
3029 todo = func_hashtab.ht_used;
3030 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3031 if (!HASHITEM_EMPTY(hi))
3032 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033 // clear the def function index now
3034 fp = HI2UF(hi);
3035 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003036 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003037
Bram Moolenaare38eab22019-12-05 21:50:01 +01003038 // Only free functions that are not refcounted, those are
3039 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003040 if (func_name_refcount(fp->uf_name))
3041 ++skipped;
3042 else
3043 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003044 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003045 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003046 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003047 {
3048 skipped = 0;
3049 break;
3050 }
3051 }
3052 --todo;
3053 }
3054 }
3055
Bram Moolenaare38eab22019-12-05 21:50:01 +01003056 // Now actually free the functions. Need to start all over every time,
3057 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003058 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003059 while (func_hashtab.ht_used > skipped)
3060 {
3061 todo = func_hashtab.ht_used;
3062 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003063 if (!HASHITEM_EMPTY(hi))
3064 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003065 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003066 // Only free functions that are not refcounted, those are
3067 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003068 fp = HI2UF(hi);
3069 if (func_name_refcount(fp->uf_name))
3070 ++skipped;
3071 else
3072 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003073 if (func_free(fp, FALSE) == OK)
3074 {
3075 skipped = 0;
3076 break;
3077 }
3078 // did not actually free it
3079 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003080 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003081 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003082 }
3083 if (skipped == 0)
3084 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003085
3086 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087}
3088#endif
3089
3090/*
3091 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003092 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003093 * "len" is the length of "name", or -1 for NUL terminated.
3094 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003095 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096builtin_function(char_u *name, int len)
3097{
3098 char_u *p;
3099
Bram Moolenaara26b9702020-04-18 19:53:28 +02003100 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 return FALSE;
3102 p = vim_strchr(name, AUTOLOAD_CHAR);
3103 return p == NULL || (len > 0 && p > name + len);
3104}
3105
3106 int
3107func_call(
3108 char_u *name,
3109 typval_T *args,
3110 partial_T *partial,
3111 dict_T *selfdict,
3112 typval_T *rettv)
3113{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003114 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 listitem_T *item;
3116 typval_T argv[MAX_FUNC_ARGS + 1];
3117 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118 int r = 0;
3119
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003120 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003121 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122 {
3123 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3124 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003125 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126 break;
3127 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003128 // Make a copy of each argument. This is needed to be able to set
3129 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 copy_tv(&item->li_tv, &argv[argc++]);
3131 }
3132
3133 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003134 {
3135 funcexe_T funcexe;
3136
Bram Moolenaara80faa82020-04-12 19:37:17 +02003137 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003138 funcexe.fe_firstline = curwin->w_cursor.lnum;
3139 funcexe.fe_lastline = curwin->w_cursor.lnum;
3140 funcexe.fe_evaluate = TRUE;
3141 funcexe.fe_partial = partial;
3142 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003143 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3144 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145
Bram Moolenaare38eab22019-12-05 21:50:01 +01003146 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147 while (argc > 0)
3148 clear_tv(&argv[--argc]);
3149
3150 return r;
3151}
3152
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003153static int callback_depth = 0;
3154
3155 int
3156get_callback_depth(void)
3157{
3158 return callback_depth;
3159}
3160
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003162 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003163 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003164 */
3165 int
3166call_callback(
3167 callback_T *callback,
3168 int len, // length of "name" or -1 to use strlen()
3169 typval_T *rettv, // return value goes here
3170 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003171 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003172 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003173{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003174 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003175 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003176
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003177 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3178 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003179 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003180 funcexe.fe_evaluate = TRUE;
3181 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003182 ++callback_depth;
3183 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3184 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003185
3186 // When a :def function was called that uses :try an error would be turned
3187 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003188 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003189 {
3190 need_rethrow = FALSE;
3191 handle_did_throw();
3192 }
3193
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003194 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003195}
3196
3197/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003198 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003199 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003200 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3201 */
3202 varnumber_T
3203call_callback_retnr(
3204 callback_T *callback,
3205 int argcount, // number of "argvars"
3206 typval_T *argvars) // vars for arguments, must have "argcount"
3207 // PLUS ONE elements!
3208{
3209 typval_T rettv;
3210 varnumber_T retval;
3211
3212 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003213 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003214
3215 retval = tv_get_number_chk(&rettv, NULL);
3216 clear_tv(&rettv);
3217 return retval;
3218}
3219
3220/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003221 * Give an error message for the result of a function.
3222 * Nothing if "error" is FCERR_NONE.
3223 */
3224 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003225user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003226{
3227 switch (error)
3228 {
3229 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003230 if (funcexe->fe_found_var)
3231 semsg(_(e_not_callable_type_str), name);
3232 else
3233 emsg_funcname(e_unknownfunc, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003234 break;
3235 case FCERR_NOTMETHOD:
3236 emsg_funcname(
3237 N_("E276: Cannot use function as a method: %s"), name);
3238 break;
3239 case FCERR_DELETED:
3240 emsg_funcname(N_(e_func_deleted), name);
3241 break;
3242 case FCERR_TOOMANY:
3243 emsg_funcname((char *)e_toomanyarg, name);
3244 break;
3245 case FCERR_TOOFEW:
3246 emsg_funcname((char *)e_toofewarg, name);
3247 break;
3248 case FCERR_SCRIPT:
3249 emsg_funcname(
3250 N_("E120: Using <SID> not in a script context: %s"), name);
3251 break;
3252 case FCERR_DICT:
3253 emsg_funcname(
3254 N_("E725: Calling dict function without Dictionary: %s"),
3255 name);
3256 break;
3257 }
3258}
3259
3260/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003262 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 * Return FAIL when the function can't be called, OK otherwise.
3264 * Also returns OK when an error was encountered while executing the function.
3265 */
3266 int
3267call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003268 char_u *funcname, // name of the function
3269 int len, // length of "name" or -1 to use strlen()
3270 typval_T *rettv, // return value goes here
3271 int argcount_in, // number of "argvars"
3272 typval_T *argvars_in, // vars for arguments, must have "argcount"
3273 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003274 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275{
3276 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003277 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003279 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 char_u fname_buf[FLEN_FIXED + 1];
3281 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003282 char_u *fname = NULL;
3283 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 int argcount = argcount_in;
3285 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003286 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003287 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003288 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003290 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003291 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003292 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003293
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003294 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3295 // even when call_func() returns FAIL.
3296 rettv->v_type = VAR_UNKNOWN;
3297
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003298 if (partial != NULL)
3299 fp = partial->pt_func;
3300 if (fp == NULL)
3301 {
3302 // Make a copy of the name, if it comes from a funcref variable it
3303 // could be changed or deleted in the called function.
3304 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3305 if (name == NULL)
3306 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003308 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3309 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003311 if (funcexe->fe_doesrange != NULL)
3312 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313
3314 if (partial != NULL)
3315 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003316 // When the function has a partial with a dict and there is a dict
3317 // argument, use the dict argument. That is backwards compatible.
3318 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003319 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003321 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003322 {
3323 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003324 {
3325 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3326 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003327 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003328 goto theend;
3329 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003331 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 for (i = 0; i < argcount_in; ++i)
3333 argv[i + argv_clear] = argvars_in[i];
3334 argvars = argv;
3335 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003336
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003337 if (funcexe->fe_check_type != NULL
3338 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003339 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003340 // Now funcexe->fe_check_type is missing the added arguments,
3341 // make a copy of the type with the correction.
3342 check_type = *funcexe->fe_check_type;
3343 funcexe->fe_check_type = &check_type;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003344 check_type.tt_argcount += partial->pt_argc;
3345 check_type.tt_min_argcount += partial->pt_argc;
3346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 }
3348 }
3349
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003350 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3351 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003352 {
3353 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003354 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003355 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003356 error = FCERR_OTHER;
3357 }
3358
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003359 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 {
3361 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003362 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363
Bram Moolenaar333894b2020-08-01 18:53:07 +02003364 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003365 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003366 {
3367 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003369 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370
Bram Moolenaare38eab22019-12-05 21:50:01 +01003371 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003373 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003374
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003375 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 {
3377 /*
3378 * User defined function.
3379 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003380 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003381 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382
Bram Moolenaare38eab22019-12-05 21:50:01 +01003383 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 if (fp == NULL
3385 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003386 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 && !aborting())
3388 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003389 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003390 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003392 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3394 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003395 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003396 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003398 if (fp == NULL)
3399 {
3400 char_u *p = untrans_function_name(rfname);
3401
3402 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003403 // Don't do this if the name starts with "s:".
3404 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003405 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003406 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003408 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003409 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003410#ifdef FEAT_LUA
3411 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3412 {
3413 cfunc_T cb = fp->uf_cb;
3414
3415 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3416 }
3417#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003418 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003420 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003421 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003422 argcount = funcexe->fe_argv_func(argcount, argvars,
3423 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003424
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003425 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003426 {
3427 // Method call: base->Method()
3428 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003429 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003430 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003431 argvars = argv;
3432 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003433 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003434
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003435 error = call_user_func_check(fp, argcount, argvars, rettv,
3436 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003437 }
3438 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003439 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003440 {
3441 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003442 * expr->method(): Find the method name in the table, call its
3443 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003444 */
3445 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003446 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003447 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 else
3449 {
3450 /*
3451 * Find the function name in the table, call its implementation.
3452 */
3453 error = call_internal_func(fname, argcount, argvars, rettv);
3454 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003455
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 /*
3457 * The function call (or "FuncUndefined" autocommand sequence) might
3458 * have been aborted by an error, an interrupt, or an explicitly thrown
3459 * exception that has not been caught so far. This situation can be
3460 * tested for by calling aborting(). For an error in an internal
3461 * function or for the "E132" error in call_user_func(), however, the
3462 * throw point at which the "force_abort" flag (temporarily reset by
3463 * emsg()) is normally updated has not been reached yet. We need to
3464 * update that flag first to make aborting() reliable.
3465 */
3466 update_force_abort();
3467 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003468 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003469 ret = OK;
3470
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003471theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 /*
3473 * Report an error unless the argument evaluation or function call has been
3474 * cancelled due to an aborting error, an interrupt, or an exception.
3475 */
3476 if (!aborting())
3477 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003478 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 }
3480
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003481 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003483 clear_tv(&argv[--argv_clear + argv_base]);
3484
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 vim_free(tofree);
3486 vim_free(name);
3487
3488 return ret;
3489}
3490
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003491 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003492printable_func_name(ufunc_T *fp)
3493{
3494 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3495}
3496
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003497/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003498 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 */
3500 static void
3501list_func_head(ufunc_T *fp, int indent)
3502{
3503 int j;
3504
3505 msg_start();
3506 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003507 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003508 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003509 msg_puts("def ");
3510 else
3511 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003512 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 msg_putchar('(');
3514 for (j = 0; j < fp->uf_args.ga_len; ++j)
3515 {
3516 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003517 msg_puts(", ");
3518 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003519 if (fp->uf_arg_types != NULL)
3520 {
3521 char *tofree;
3522
3523 msg_puts(": ");
3524 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3525 vim_free(tofree);
3526 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003527 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3528 {
3529 msg_puts(" = ");
3530 msg_puts(((char **)(fp->uf_def_args.ga_data))
3531 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 }
3534 if (fp->uf_varargs)
3535 {
3536 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003537 msg_puts(", ");
3538 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003540 if (fp->uf_va_name != NULL)
3541 {
3542 if (j)
3543 msg_puts(", ");
3544 msg_puts("...");
3545 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003546 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003547 {
3548 char *tofree;
3549
3550 msg_puts(": ");
3551 msg_puts(type_name(fp->uf_va_type, &tofree));
3552 vim_free(tofree);
3553 }
3554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003556
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003557 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003558 {
3559 if (fp->uf_ret_type != &t_void)
3560 {
3561 char *tofree;
3562
3563 msg_puts(": ");
3564 msg_puts(type_name(fp->uf_ret_type, &tofree));
3565 vim_free(tofree);
3566 }
3567 }
3568 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003569 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003571 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003573 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003574 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003575 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 msg_clr_eos();
3577 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003578 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579}
3580
3581/*
3582 * Get a function name, translating "<SID>" and "<SNR>".
3583 * Also handles a Funcref in a List or Dictionary.
3584 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003585 * Set "*is_global" to TRUE when the function must be global, unless
3586 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 * flags:
3588 * TFN_INT: internal function name OK
3589 * TFN_QUIET: be quiet
3590 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003591 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 * Advances "pp" to just after the function name (if no error).
3593 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003594 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595trans_function_name(
3596 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003597 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003598 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003600 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003601 partial_T **partial, // return: partial of a FuncRef
3602 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603{
3604 char_u *name = NULL;
3605 char_u *start;
3606 char_u *end;
3607 int lead;
3608 char_u sid_buf[20];
3609 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003610 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003612 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003613 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614
3615 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003616 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 start = *pp;
3618
Bram Moolenaare38eab22019-12-05 21:50:01 +01003619 // Check for hard coded <SNR>: already translated function ID (from a user
3620 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3622 && (*pp)[2] == (int)KE_SNR)
3623 {
3624 *pp += 3;
3625 len = get_id_len(pp) + 3;
3626 return vim_strnsave(start, len);
3627 }
3628
Bram Moolenaare38eab22019-12-05 21:50:01 +01003629 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3630 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 lead = eval_fname_script(start);
3632 if (lead > 2)
3633 start += lead;
3634
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003636 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003637 lead > 2 ? 0 : FNE_CHECK_START);
3638 if (end == start)
3639 {
3640 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003641 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 goto theend;
3643 }
3644 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3645 {
3646 /*
3647 * Report an invalid expression in braces, unless the expression
3648 * evaluation has been cancelled due to an aborting error, an
3649 * interrupt, or an exception.
3650 */
3651 if (!aborting())
3652 {
3653 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003654 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 }
3656 else
3657 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3658 goto theend;
3659 }
3660
3661 if (lv.ll_tv != NULL)
3662 {
3663 if (fdp != NULL)
3664 {
3665 fdp->fd_dict = lv.ll_dict;
3666 fdp->fd_newkey = lv.ll_newkey;
3667 lv.ll_newkey = NULL;
3668 fdp->fd_di = lv.ll_di;
3669 }
3670 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3671 {
3672 name = vim_strsave(lv.ll_tv->vval.v_string);
3673 *pp = end;
3674 }
3675 else if (lv.ll_tv->v_type == VAR_PARTIAL
3676 && lv.ll_tv->vval.v_partial != NULL)
3677 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003678 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 *pp = end;
3680 if (partial != NULL)
3681 *partial = lv.ll_tv->vval.v_partial;
3682 }
3683 else
3684 {
3685 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3686 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003687 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 else
3689 *pp = end;
3690 name = NULL;
3691 }
3692 goto theend;
3693 }
3694
3695 if (lv.ll_name == NULL)
3696 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003697 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 *pp = end;
3699 goto theend;
3700 }
3701
Bram Moolenaare38eab22019-12-05 21:50:01 +01003702 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 if (lv.ll_exp_name != NULL)
3704 {
3705 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003706 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003707 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708 if (name == lv.ll_exp_name)
3709 name = NULL;
3710 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003711 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 {
3713 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003714 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003715 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003716 if (name == *pp)
3717 name = NULL;
3718 }
3719 if (name != NULL)
3720 {
3721 name = vim_strsave(name);
3722 *pp = end;
3723 if (STRNCMP(name, "<SNR>", 5) == 0)
3724 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003725 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 name[0] = K_SPECIAL;
3727 name[1] = KS_EXTRA;
3728 name[2] = (int)KE_SNR;
3729 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3730 }
3731 goto theend;
3732 }
3733
3734 if (lv.ll_exp_name != NULL)
3735 {
3736 len = (int)STRLEN(lv.ll_exp_name);
3737 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3738 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3739 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003740 // When there was "s:" already or the name expanded to get a
3741 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742 lv.ll_name += 2;
3743 len -= 2;
3744 lead = 2;
3745 }
3746 }
3747 else
3748 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003749 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003751 {
3752 if (is_global != NULL && lv.ll_name[0] == 'g')
3753 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003755 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 len = (int)(end - lv.ll_name);
3757 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003758 if (len <= 0)
3759 {
3760 if (!skip)
3761 emsg(_(e_function_name));
3762 goto theend;
3763 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003765 // In Vim9 script a user function is script-local by default, unless it
3766 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003767 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003768 if (vim9script)
3769 {
3770 char_u *p;
3771
3772 // SomeScript#func() is a global function.
3773 for (p = start; *p != NUL && *p != '('; ++p)
3774 if (*p == AUTOLOAD_CHAR)
3775 vim9script = FALSE;
3776 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003777
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 /*
3779 * Copy the function name to allocated memory.
3780 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3781 * Accept <SNR>123_name() outside a script.
3782 */
3783 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003784 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003785 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003787 if (!vim9script)
3788 lead = 3;
3789 if (vim9script || (lv.ll_exp_name != NULL
3790 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 || eval_fname_sid(*pp))
3792 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003793 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003794 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003796 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 goto theend;
3798 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003799 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003800 if (vim9script)
3801 extra = 3 + (int)STRLEN(sid_buf);
3802 else
3803 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 }
3805 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003806 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3807 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003809 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 start);
3811 goto theend;
3812 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003813 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 {
3815 char_u *cp = vim_strchr(lv.ll_name, ':');
3816
3817 if (cp != NULL && cp < end)
3818 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003819 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 goto theend;
3821 }
3822 }
3823
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003824 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 if (name != NULL)
3826 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003827 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 {
3829 name[0] = K_SPECIAL;
3830 name[1] = KS_EXTRA;
3831 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003832 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 STRCPY(name + 3, sid_buf);
3834 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003835 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3836 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837 }
3838 *pp = end;
3839
3840theend:
3841 clear_lval(&lv);
3842 return name;
3843}
3844
3845/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003846 * Assuming "name" is the result of trans_function_name() and it was prefixed
3847 * to use the script-local name, return the unmodified name (points into
3848 * "name"). Otherwise return NULL.
3849 * This can be used to first search for a script-local function and fall back
3850 * to the global function if not found.
3851 */
3852 char_u *
3853untrans_function_name(char_u *name)
3854{
3855 char_u *p;
3856
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003857 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003858 {
3859 p = vim_strchr(name, '_');
3860 if (p != NULL)
3861 return p + 1;
3862 }
3863 return NULL;
3864}
3865
3866/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003867 * Call trans_function_name(), except that a lambda is returned as-is.
3868 * Returns the name in allocated memory.
3869 */
3870 char_u *
3871save_function_name(
3872 char_u **name,
3873 int *is_global,
3874 int skip,
3875 int flags,
3876 funcdict_T *fudi)
3877{
3878 char_u *p = *name;
3879 char_u *saved;
3880
3881 if (STRNCMP(p, "<lambda>", 8) == 0)
3882 {
3883 p += 8;
3884 (void)getdigits(&p);
3885 saved = vim_strnsave(*name, p - *name);
3886 if (fudi != NULL)
3887 CLEAR_POINTER(fudi);
3888 }
3889 else
3890 saved = trans_function_name(&p, is_global, skip,
3891 flags, fudi, NULL, NULL);
3892 *name = p;
3893 return saved;
3894}
3895
3896/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003897 * List functions. When "regmatch" is NULL all of then.
3898 * Otherwise functions matching "regmatch".
3899 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003900 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003901list_functions(regmatch_T *regmatch)
3902{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003903 int changed = func_hashtab.ht_changed;
3904 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003905 hashitem_T *hi;
3906
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003907 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003908 {
3909 if (!HASHITEM_EMPTY(hi))
3910 {
3911 ufunc_T *fp = HI2UF(hi);
3912
3913 --todo;
3914 if ((fp->uf_flags & FC_DEAD) == 0
3915 && (regmatch == NULL
3916 ? !message_filtered(fp->uf_name)
3917 && !func_name_refcount(fp->uf_name)
3918 : !isdigit(*fp->uf_name)
3919 && vim_regexec(regmatch, fp->uf_name, 0)))
3920 {
3921 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003922 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003923 {
3924 emsg(_("E454: function list was modified"));
3925 return;
3926 }
3927 }
3928 }
3929 }
3930}
3931
3932/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003933 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003934 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3935 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003936 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003938 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003939define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003941 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003942 int j;
3943 int c;
3944 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003945 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003946 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 char_u *p;
3948 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003949 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 char_u *line_arg = NULL;
3951 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003952 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003953 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954 garray_T newlines;
3955 int varargs = FALSE;
3956 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003957 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003958 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003959 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 dictitem_T *v;
3961 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003962 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003965 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003966 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003967 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968
3969 /*
3970 * ":function" without argument: list functions.
3971 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003972 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 {
3974 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003975 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003976 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003977 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 }
3979
3980 /*
3981 * ":function /pat": list functions matching pattern.
3982 */
3983 if (*eap->arg == '/')
3984 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003985 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 if (!eap->skip)
3987 {
3988 regmatch_T regmatch;
3989
3990 c = *p;
3991 *p = NUL;
3992 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3993 *p = c;
3994 if (regmatch.regprog != NULL)
3995 {
3996 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003997 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 vim_regfree(regmatch.regprog);
3999 }
4000 }
4001 if (*p == '/')
4002 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004003 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004004 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 }
4006
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004007 ga_init(&newargs);
4008 ga_init(&argtypes);
4009 ga_init(&default_args);
4010
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 /*
4012 * Get the function name. There are these situations:
4013 * func normal function name
4014 * "name" == func, "fudi.fd_dict" == NULL
4015 * dict.func new dictionary entry
4016 * "name" == NULL, "fudi.fd_dict" set,
4017 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4018 * dict.func existing dict entry with a Funcref
4019 * "name" == func, "fudi.fd_dict" set,
4020 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4021 * dict.func existing dict entry that's not a Funcref
4022 * "name" == NULL, "fudi.fd_dict" set,
4023 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4024 * s:func script-local function name
4025 * g:func global function name, same as "func"
4026 */
4027 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004028 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004030 // nested function, argument is (args).
4031 paren = TRUE;
4032 CLEAR_FIELD(fudi);
4033 }
4034 else
4035 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004036 name = save_function_name(&p, &is_global, eap->skip,
4037 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004038 paren = (vim_strchr(p, '(') != NULL);
4039 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004041 /*
4042 * Return on an invalid expression in braces, unless the expression
4043 * evaluation has been cancelled due to an aborting error, an
4044 * interrupt, or an exception.
4045 */
4046 if (!aborting())
4047 {
4048 if (!eap->skip && fudi.fd_newkey != NULL)
4049 semsg(_(e_dictkey), fudi.fd_newkey);
4050 vim_free(fudi.fd_newkey);
4051 return NULL;
4052 }
4053 else
4054 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 }
4057
Bram Moolenaare38eab22019-12-05 21:50:01 +01004058 // An error in a function call during evaluation of an expression in magic
4059 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 saved_did_emsg = did_emsg;
4061 did_emsg = FALSE;
4062
4063 /*
4064 * ":function func" with only function name: list function.
4065 */
4066 if (!paren)
4067 {
4068 if (!ends_excmd(*skipwhite(p)))
4069 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004070 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 goto ret_free;
4072 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004073 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 if (eap->nextcmd != NULL)
4075 *p = NUL;
4076 if (!eap->skip && !got_int)
4077 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004078 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004079 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4080 {
4081 char_u *up = untrans_function_name(name);
4082
4083 // With Vim9 script the name was made script-local, if not
4084 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004085 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004086 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004087 }
4088
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 if (fp != NULL)
4090 {
4091 list_func_head(fp, TRUE);
4092 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4093 {
4094 if (FUNCLINE(fp, j) == NULL)
4095 continue;
4096 msg_putchar('\n');
4097 msg_outnum((long)(j + 1));
4098 if (j < 9)
4099 msg_putchar(' ');
4100 if (j < 99)
4101 msg_putchar(' ');
4102 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004103 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 ui_breakcheck();
4105 }
4106 if (!got_int)
4107 {
4108 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004109 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004110 msg_puts(" enddef");
4111 else
4112 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 }
4114 }
4115 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004116 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 }
4118 goto ret_free;
4119 }
4120
4121 /*
4122 * ":function name(arg1, arg2)" Define function.
4123 */
4124 p = skipwhite(p);
4125 if (*p != '(')
4126 {
4127 if (!eap->skip)
4128 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004129 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 goto ret_free;
4131 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004132 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133 if (vim_strchr(p, '(') != NULL)
4134 p = vim_strchr(p, '(');
4135 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004137 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4138 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004139 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004140 goto ret_free;
4141 }
4142
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004143 // In Vim9 script only global functions can be redefined.
4144 if (vim9script && eap->forceit && !is_global)
4145 {
4146 emsg(_(e_nobang));
4147 goto ret_free;
4148 }
4149
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004150 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151
Bram Moolenaar04b12692020-05-04 23:24:44 +02004152 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004153 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004154 // Check the name of the function. Unless it's a dictionary function
4155 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 if (name != NULL)
4157 arg = name;
4158 else
4159 arg = fudi.fd_newkey;
4160 if (arg != NULL && (fudi.fd_di == NULL
4161 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4162 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4163 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004164 char_u *name_base = arg;
4165 int i;
4166
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004168 {
4169 name_base = vim_strchr(arg, '_');
4170 if (name_base == NULL)
4171 name_base = arg + 3;
4172 else
4173 ++name_base;
4174 }
4175 for (i = 0; name_base[i] != NUL && (i == 0
4176 ? eval_isnamec1(name_base[i])
4177 : eval_isnamec(name_base[i])); ++i)
4178 ;
4179 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004181
4182 // In Vim9 script a function cannot have the same name as a
4183 // variable.
4184 if (vim9script && *arg == K_SPECIAL
4185 && eval_variable(name_base, STRLEN(name_base), NULL, NULL,
4186 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4187 + EVAL_VAR_NO_FUNC) == OK)
4188 {
4189 semsg(_(e_redefining_script_item_str), name_base);
4190 goto ret_free;
4191 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004193 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004195 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004196 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004197 goto ret_free;
4198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 }
4200
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004201 // This may get more lines and make the pointers into the first line
4202 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004203 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004204 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004205 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004206 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004207 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004209 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004211 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004213 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004214 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004216 if (*p != ':')
4217 {
4218 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4219 p = skipwhite(p);
4220 }
4221 else if (!IS_WHITE_OR_NUL(p[1]))
4222 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004223 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004224 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004225 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004226 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004227 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004228 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004229 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004230 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004231 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004232 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004233 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004234 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004235 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004237 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004239 else
4240 // find extra arguments "range", "dict", "abort" and "closure"
4241 for (;;)
4242 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004243 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004244 p = skipwhite(p);
4245 if (STRNCMP(p, "range", 5) == 0)
4246 {
4247 flags |= FC_RANGE;
4248 p += 5;
4249 }
4250 else if (STRNCMP(p, "dict", 4) == 0)
4251 {
4252 flags |= FC_DICT;
4253 p += 4;
4254 }
4255 else if (STRNCMP(p, "abort", 5) == 0)
4256 {
4257 flags |= FC_ABORT;
4258 p += 5;
4259 }
4260 else if (STRNCMP(p, "closure", 7) == 0)
4261 {
4262 flags |= FC_CLOSURE;
4263 p += 7;
4264 if (current_funccal == NULL)
4265 {
4266 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4267 name == NULL ? (char_u *)"" : name);
4268 goto erret;
4269 }
4270 }
4271 else
4272 break;
4273 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274
Bram Moolenaare38eab22019-12-05 21:50:01 +01004275 // When there is a line break use what follows for the function body.
4276 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 if (*p == '\n')
4278 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004279 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004280 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4281 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004282 && !(VIM_ISWHITE(*whitep) && *p == '#'
4283 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004284 && !eap->skip
4285 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004286 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004287
4288 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004289 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4290 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291 */
4292 if (KeyTyped)
4293 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004294 // Check if the function already exists, don't let the user type the
4295 // whole function before telling him it doesn't work! For a script we
4296 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 if (!eap->skip && !eap->forceit)
4298 {
4299 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004300 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004301 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004302 emsg_funcname(e_funcexts, name);
4303 }
4304
4305 if (!eap->skip && did_emsg)
4306 goto erret;
4307
Bram Moolenaare38eab22019-12-05 21:50:01 +01004308 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 cmdline_row = msg_row;
4310 }
4311
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004312 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004313 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004314
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004315 // Do not define the function when getting the body fails and when
4316 // skipping.
4317 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4318 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 goto erret;
4320
4321 /*
4322 * If there are no errors, add the function
4323 */
4324 if (fudi.fd_dict == NULL)
4325 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004326 hashtab_T *ht;
4327
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004328 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4330 {
4331 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4332 name);
4333 goto erret;
4334 }
4335
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004336 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004337 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004339 char_u *uname = untrans_function_name(name);
4340
4341 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4342 }
4343
4344 if (fp != NULL || import != NULL)
4345 {
4346 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004347
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004348 // Function can be replaced with "function!" and when sourcing the
4349 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004350 // A name that is used by an import can not be overruled.
4351 if (import != NULL
4352 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004353 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004354 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004356 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004357 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004358 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004359 else
4360 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 goto erret;
4362 }
4363 if (fp->uf_calls > 0)
4364 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004365 emsg_funcname(
4366 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 name);
4368 goto erret;
4369 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004370 if (fp->uf_refcount > 1)
4371 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004372 // This function is referenced somewhere, don't redefine it but
4373 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004374 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004375 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004376 fp = NULL;
4377 overwrite = TRUE;
4378 }
4379 else
4380 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004381 char_u *exp_name = fp->uf_name_exp;
4382
4383 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004384 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004385 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004386 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004387 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004388 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004389#ifdef FEAT_PROFILE
4390 fp->uf_profiling = FALSE;
4391 fp->uf_prof_initialized = FALSE;
4392#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004393 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004394 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395 }
4396 }
4397 else
4398 {
4399 char numbuf[20];
4400
4401 fp = NULL;
4402 if (fudi.fd_newkey == NULL && !eap->forceit)
4403 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004404 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 goto erret;
4406 }
4407 if (fudi.fd_di == NULL)
4408 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004409 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004410 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 goto erret;
4412 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004413 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004414 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 goto erret;
4416
Bram Moolenaare38eab22019-12-05 21:50:01 +01004417 // Give the function a sequential number. Can only be used with a
4418 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 vim_free(name);
4420 sprintf(numbuf, "%d", ++func_nr);
4421 name = vim_strsave((char_u *)numbuf);
4422 if (name == NULL)
4423 goto erret;
4424 }
4425
4426 if (fp == NULL)
4427 {
4428 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4429 {
4430 int slen, plen;
4431 char_u *scriptname;
4432
Bram Moolenaare38eab22019-12-05 21:50:01 +01004433 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004435 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 {
4437 scriptname = autoload_name(name);
4438 if (scriptname != NULL)
4439 {
4440 p = vim_strchr(scriptname, '/');
4441 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004442 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004444 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004445 j = OK;
4446 vim_free(scriptname);
4447 }
4448 }
4449 if (j == FAIL)
4450 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004451 linenr_T save_lnum = SOURCING_LNUM;
4452
4453 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004454 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004455 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004456 goto erret;
4457 }
4458 }
4459
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004460 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 if (fp == NULL)
4462 goto erret;
4463
4464 if (fudi.fd_dict != NULL)
4465 {
4466 if (fudi.fd_di == NULL)
4467 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004468 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4470 if (fudi.fd_di == NULL)
4471 {
4472 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004473 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474 goto erret;
4475 }
4476 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4477 {
4478 vim_free(fudi.fd_di);
4479 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004480 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 goto erret;
4482 }
4483 }
4484 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004485 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 clear_tv(&fudi.fd_di->di_tv);
4487 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489
Bram Moolenaare38eab22019-12-05 21:50:01 +01004490 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 flags |= FC_DICT;
4492 }
4493
Bram Moolenaare38eab22019-12-05 21:50:01 +01004494 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004495 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004496 if (overwrite)
4497 {
4498 hi = hash_find(&func_hashtab, name);
4499 hi->hi_key = UF2HIKEY(fp);
4500 }
4501 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502 {
4503 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004504 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004505 goto erret;
4506 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004507 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508 }
4509 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004510 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004511 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004512 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004513
4514 if (eap->cmdidx == CMD_def)
4515 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004516 int lnum_save = SOURCING_LNUM;
4517 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004518
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004519 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004520
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004521 // error messages are for the first function line
4522 SOURCING_LNUM = sourcing_lnum_top;
4523
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004524 // The function may use script variables from the context.
4525 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004526
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004527 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004528 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004529 SOURCING_LNUM = lnum_save;
4530 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004531 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004532 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004533
4534 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004535 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004536 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004537 SOURCING_LNUM = lnum_save;
4538 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004539 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004540 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004541 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004542 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004543 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004546 if ((flags & FC_CLOSURE) != 0)
4547 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004548 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004549 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004550 }
4551 else
4552 fp->uf_scoped = NULL;
4553
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 if (prof_def_func())
4556 func_do_profile(fp);
4557#endif
4558 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004559 if (sandbox)
4560 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004561 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004562 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563 fp->uf_flags = flags;
4564 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004565 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004566 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004567 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004568 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004569 if (is_export)
4570 {
4571 fp->uf_flags |= FC_EXPORT;
4572 // let ex_export() know the export worked.
4573 is_export = FALSE;
4574 }
4575
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004576 if (eap->cmdidx == CMD_def)
4577 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004578 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4579 // :func does not use Vim9 script syntax, even in a Vim9 script file
4580 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 goto ret_free;
4583
4584erret:
4585 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004586 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004587 if (fp != NULL)
4588 {
4589 ga_init(&fp->uf_args);
4590 ga_init(&fp->uf_def_args);
4591 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592errret_2:
4593 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004594 if (fp != NULL)
4595 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004597 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004598 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004600 if (name != name_arg)
4601 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004602 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004604
4605 return fp;
4606}
4607
4608/*
4609 * ":function"
4610 */
4611 void
4612ex_function(exarg_T *eap)
4613{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004614 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004615}
4616
4617/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004618 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004619 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004620 */
4621 void
4622ex_defcompile(exarg_T *eap UNUSED)
4623{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004624 long todo = (long)func_hashtab.ht_used;
4625 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004626 hashitem_T *hi;
4627 ufunc_T *ufunc;
4628
4629 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4630 {
4631 if (!HASHITEM_EMPTY(hi))
4632 {
4633 --todo;
4634 ufunc = HI2UF(hi);
4635 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004636 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4637 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004638 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004639 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004640
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004641 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004642 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004643 // a function has been added or removed, need to start over
4644 todo = (long)func_hashtab.ht_used;
4645 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004646 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004647 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004648 }
4649 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004650 }
4651 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004652}
4653
4654/*
4655 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4656 * Return 2 if "p" starts with "s:".
4657 * Return 0 otherwise.
4658 */
4659 int
4660eval_fname_script(char_u *p)
4661{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004662 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4663 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4665 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4666 return 5;
4667 if (p[0] == 's' && p[1] == ':')
4668 return 2;
4669 return 0;
4670}
4671
4672 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004673translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674{
4675 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004676 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004677 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004678}
4679
4680/*
4681 * Return TRUE when "ufunc" has old-style "..." varargs
4682 * or named varargs "...name: type".
4683 */
4684 int
4685has_varargs(ufunc_T *ufunc)
4686{
4687 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688}
4689
4690/*
4691 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004692 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 */
4694 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004695function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696{
4697 char_u *nm = name;
4698 char_u *p;
4699 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004700 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004701 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004703 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4704 if (no_deref)
4705 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004706 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 nm = skipwhite(nm);
4708
Bram Moolenaare38eab22019-12-05 21:50:01 +01004709 // Only accept "funcname", "funcname ", "funcname (..." and
4710 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004712 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713 vim_free(p);
4714 return n;
4715}
4716
Bram Moolenaar113e1072019-01-20 15:30:40 +01004717#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718 char_u *
4719get_expanded_name(char_u *name, int check)
4720{
4721 char_u *nm = name;
4722 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004723 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004725 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004726 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004728 if (p != NULL && *nm == NUL
4729 && (!check || translated_function_exists(p, is_global)))
4730 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731
4732 vim_free(p);
4733 return NULL;
4734}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004735#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004736
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004737/*
4738 * Function given to ExpandGeneric() to obtain the list of user defined
4739 * function names.
4740 */
4741 char_u *
4742get_user_func_name(expand_T *xp, int idx)
4743{
4744 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004745 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 static hashitem_T *hi;
4747 ufunc_T *fp;
4748
4749 if (idx == 0)
4750 {
4751 done = 0;
4752 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004753 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004755 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 {
4757 if (done++ > 0)
4758 ++hi;
4759 while (HASHITEM_EMPTY(hi))
4760 ++hi;
4761 fp = HI2UF(hi);
4762
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004763 // don't show dead, dict and lambda functions
4764 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004765 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004766 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767
4768 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004769 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770
4771 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004772 if (xp->xp_context != EXPAND_USER_FUNC
4773 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 {
4775 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004776 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 STRCAT(IObuff, ")");
4778 }
4779 return IObuff;
4780 }
4781 return NULL;
4782}
4783
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784/*
4785 * ":delfunction {name}"
4786 */
4787 void
4788ex_delfunction(exarg_T *eap)
4789{
4790 ufunc_T *fp = NULL;
4791 char_u *p;
4792 char_u *name;
4793 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004794 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795
4796 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004797 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4798 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004799 vim_free(fudi.fd_newkey);
4800 if (name == NULL)
4801 {
4802 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004803 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 return;
4805 }
4806 if (!ends_excmd(*skipwhite(p)))
4807 {
4808 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004809 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 return;
4811 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004812 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 if (eap->nextcmd != NULL)
4814 *p = NUL;
4815
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004816 if (isdigit(*name) && fudi.fd_dict == NULL)
4817 {
4818 if (!eap->skip)
4819 semsg(_(e_invarg2), eap->arg);
4820 vim_free(name);
4821 return;
4822 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004824 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 vim_free(name);
4826
4827 if (!eap->skip)
4828 {
4829 if (fp == NULL)
4830 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004831 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004832 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 return;
4834 }
4835 if (fp->uf_calls > 0)
4836 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004837 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 return;
4839 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004840 if (fp->uf_flags & FC_VIM9)
4841 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004842 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004843 return;
4844 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845
4846 if (fudi.fd_dict != NULL)
4847 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004848 // Delete the dict item that refers to the function, it will
4849 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4851 }
4852 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004853 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004854 // A normal function (not a numbered function or lambda) has a
4855 // refcount of 1 for the entry in the hashtable. When deleting
4856 // it and the refcount is more than one, it should be kept.
4857 // A numbered function and lambda should be kept if the refcount is
4858 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004859 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004860 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004861 // Function is still referenced somewhere. Don't free it but
4862 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004863 if (func_remove(fp))
4864 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004865 }
4866 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004867 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004868 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869 }
4870}
4871
4872/*
4873 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004874 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 */
4876 void
4877func_unref(char_u *name)
4878{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004879 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004881 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004882 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004883 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004884 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004886#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004887 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004889 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004891 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004892}
4893
4894/*
4895 * Unreference a Function: decrement the reference count and free it when it
4896 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004897 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004898 */
4899 void
4900func_ptr_unref(ufunc_T *fp)
4901{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004902 if (fp != NULL && (--fp->uf_refcount <= 0
4903 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4904 && fp->uf_partial->pt_refcount <= 1
4905 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004906 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004907 // Only delete it when it's not being used. Otherwise it's done
4908 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004909 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004910 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911 }
4912}
4913
4914/*
4915 * Count a reference to a Function.
4916 */
4917 void
4918func_ref(char_u *name)
4919{
4920 ufunc_T *fp;
4921
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004922 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004924 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004925 if (fp != NULL)
4926 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004928 // Only give an error for a numbered function.
4929 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004930 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004931}
4932
4933/*
4934 * Count a reference to a Function.
4935 */
4936 void
4937func_ptr_ref(ufunc_T *fp)
4938{
4939 if (fp != NULL)
4940 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004941}
4942
4943/*
4944 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4945 * referenced from anywhere that is in use.
4946 */
4947 static int
4948can_free_funccal(funccall_T *fc, int copyID)
4949{
4950 return (fc->l_varlist.lv_copyID != copyID
4951 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004952 && fc->l_avars.dv_copyID != copyID
4953 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004954}
4955
4956/*
4957 * ":return [expr]"
4958 */
4959 void
4960ex_return(exarg_T *eap)
4961{
4962 char_u *arg = eap->arg;
4963 typval_T rettv;
4964 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004965 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966
4967 if (current_funccal == NULL)
4968 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004969 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970 return;
4971 }
4972
Bram Moolenaar844fb642021-10-23 13:32:30 +01004973 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004974 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4975
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976 if (eap->skip)
4977 ++emsg_skip;
4978
4979 eap->nextcmd = NULL;
4980 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004981 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982 {
4983 if (!eap->skip)
4984 returning = do_return(eap, FALSE, TRUE, &rettv);
4985 else
4986 clear_tv(&rettv);
4987 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004988 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004989 else if (!eap->skip)
4990 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004991 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004992 update_force_abort();
4993
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004994 /*
4995 * Return unless the expression evaluation has been cancelled due to an
4996 * aborting error, an interrupt, or an exception.
4997 */
4998 if (!aborting())
4999 returning = do_return(eap, FALSE, TRUE, NULL);
5000 }
5001
Bram Moolenaare38eab22019-12-05 21:50:01 +01005002 // When skipping or the return gets pending, advance to the next command
5003 // in this line (!returning). Otherwise, ignore the rest of the line.
5004 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005 if (returning)
5006 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005007 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005008 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009
5010 if (eap->skip)
5011 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005012 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005013}
5014
5015/*
5016 * ":1,25call func(arg1, arg2)" function call.
5017 */
5018 void
5019ex_call(exarg_T *eap)
5020{
5021 char_u *arg = eap->arg;
5022 char_u *startarg;
5023 char_u *name;
5024 char_u *tofree;
5025 int len;
5026 typval_T rettv;
5027 linenr_T lnum;
5028 int doesrange;
5029 int failed = FALSE;
5030 funcdict_T fudi;
5031 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005032 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005033 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005034 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035
Bram Moolenaare6b53242020-07-01 17:28:33 +02005036 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037 if (eap->skip)
5038 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005039 // trans_function_name() doesn't work well when skipping, use eval0()
5040 // instead to skip to any following command, e.g. for:
5041 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005042 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005043 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005044 clear_tv(&rettv);
5045 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005046 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 return;
5048 }
5049
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005050 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5051 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052 if (fudi.fd_newkey != NULL)
5053 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005054 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005055 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005056 vim_free(fudi.fd_newkey);
5057 }
5058 if (tofree == NULL)
5059 return;
5060
Bram Moolenaare38eab22019-12-05 21:50:01 +01005061 // Increase refcount on dictionary, it could get deleted when evaluating
5062 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063 if (fudi.fd_dict != NULL)
5064 ++fudi.fd_dict->dv_refcount;
5065
Bram Moolenaare38eab22019-12-05 21:50:01 +01005066 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5067 // contents. For VAR_PARTIAL get its partial, unless we already have one
5068 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005069 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005070 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005071 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005072
Bram Moolenaare38eab22019-12-05 21:50:01 +01005073 // Skip white space to allow ":call func ()". Not good, but required for
5074 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005075 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076 if (*startarg != '(')
5077 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005078 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079 goto end;
5080 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005081 if (in_vim9script() && startarg > arg)
5082 {
5083 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5084 goto end;
5085 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005086
5087 /*
5088 * When skipping, evaluate the function once, to find the end of the
5089 * arguments.
5090 * When the function takes a range, this is discovered after the first
5091 * call, and the loop is broken.
5092 */
5093 if (eap->skip)
5094 {
5095 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005096 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097 }
5098 else
5099 lnum = eap->line1;
5100 for ( ; lnum <= eap->line2; ++lnum)
5101 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005102 funcexe_T funcexe;
5103
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104 if (!eap->skip && eap->addr_count > 0)
5105 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005106 if (lnum > curbuf->b_ml.ml_line_count)
5107 {
5108 // If the function deleted lines or switched to another buffer
5109 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005110 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005111 break;
5112 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113 curwin->w_cursor.lnum = lnum;
5114 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005116 }
5117 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005118
Bram Moolenaara80faa82020-04-12 19:37:17 +02005119 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005120 funcexe.fe_firstline = eap->line1;
5121 funcexe.fe_lastline = eap->line2;
5122 funcexe.fe_doesrange = &doesrange;
5123 funcexe.fe_evaluate = !eap->skip;
5124 funcexe.fe_partial = partial;
5125 funcexe.fe_selfdict = fudi.fd_dict;
5126 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005127 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005128 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005129 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 {
5131 failed = TRUE;
5132 break;
5133 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005134 if (has_watchexpr())
5135 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005137 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005138 if (handle_subscript(&arg, &rettv,
5139 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140 {
5141 failed = TRUE;
5142 break;
5143 }
5144
5145 clear_tv(&rettv);
5146 if (doesrange || eap->skip)
5147 break;
5148
Bram Moolenaare38eab22019-12-05 21:50:01 +01005149 // Stop when immediately aborting on error, or when an interrupt
5150 // occurred or an exception was thrown but not caught.
5151 // get_func_tv() returned OK, so that the check for trailing
5152 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 if (aborting())
5154 break;
5155 }
5156 if (eap->skip)
5157 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005158 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159
Bram Moolenaar1d341892021-09-18 15:25:52 +02005160 // When inside :try we need to check for following "| catch" or "| endtry".
5161 // Not when there was an error, but do check if an exception was thrown.
5162 if ((!aborting() || did_throw)
5163 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005165 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005166 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005167 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005169 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005170 {
5171 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005172 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005173 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005174 }
5175 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005176 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 }
5178
5179end:
5180 dict_unref(fudi.fd_dict);
5181 vim_free(tofree);
5182}
5183
5184/*
5185 * Return from a function. Possibly makes the return pending. Also called
5186 * for a pending return at the ":endtry" or after returning from an extra
5187 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5188 * when called due to a ":return" command. "rettv" may point to a typval_T
5189 * with the return rettv. Returns TRUE when the return can be carried out,
5190 * FALSE when the return gets pending.
5191 */
5192 int
5193do_return(
5194 exarg_T *eap,
5195 int reanimate,
5196 int is_cmd,
5197 void *rettv)
5198{
5199 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005200 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201
5202 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005203 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204 current_funccal->returned = FALSE;
5205
5206 /*
5207 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5208 * not in its finally clause (which then is to be executed next) is found.
5209 * In this case, make the ":return" pending for execution at the ":endtry".
5210 * Otherwise, return normally.
5211 */
5212 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5213 if (idx >= 0)
5214 {
5215 cstack->cs_pending[idx] = CSTP_RETURN;
5216
5217 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005218 // A pending return again gets pending. "rettv" points to an
5219 // allocated variable with the rettv of the original ":return"'s
5220 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005221 cstack->cs_rettv[idx] = rettv;
5222 else
5223 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005224 // When undoing a return in order to make it pending, get the stored
5225 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005226 if (reanimate)
5227 rettv = current_funccal->rettv;
5228
5229 if (rettv != NULL)
5230 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005231 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005232 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5233 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5234 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005235 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 }
5237 else
5238 cstack->cs_rettv[idx] = NULL;
5239
5240 if (reanimate)
5241 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005242 // The pending return value could be overwritten by a ":return"
5243 // without argument in a finally clause; reset the default
5244 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005245 current_funccal->rettv->v_type = VAR_NUMBER;
5246 current_funccal->rettv->vval.v_number = 0;
5247 }
5248 }
5249 report_make_pending(CSTP_RETURN, rettv);
5250 }
5251 else
5252 {
5253 current_funccal->returned = TRUE;
5254
Bram Moolenaare38eab22019-12-05 21:50:01 +01005255 // If the return is carried out now, store the return value. For
5256 // a return immediately after reanimation, the value is already
5257 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 if (!reanimate && rettv != NULL)
5259 {
5260 clear_tv(current_funccal->rettv);
5261 *current_funccal->rettv = *(typval_T *)rettv;
5262 if (!is_cmd)
5263 vim_free(rettv);
5264 }
5265 }
5266
5267 return idx < 0;
5268}
5269
5270/*
5271 * Free the variable with a pending return value.
5272 */
5273 void
5274discard_pending_return(void *rettv)
5275{
5276 free_tv((typval_T *)rettv);
5277}
5278
5279/*
5280 * Generate a return command for producing the value of "rettv". The result
5281 * is an allocated string. Used by report_pending() for verbose messages.
5282 */
5283 char_u *
5284get_return_cmd(void *rettv)
5285{
5286 char_u *s = NULL;
5287 char_u *tofree = NULL;
5288 char_u numbuf[NUMBUFLEN];
5289
5290 if (rettv != NULL)
5291 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5292 if (s == NULL)
5293 s = (char_u *)"";
5294
5295 STRCPY(IObuff, ":return ");
5296 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5297 if (STRLEN(s) + 8 >= IOSIZE)
5298 STRCPY(IObuff + IOSIZE - 4, "...");
5299 vim_free(tofree);
5300 return vim_strsave(IObuff);
5301}
5302
5303/*
5304 * Get next function line.
5305 * Called by do_cmdline() to get the next line.
5306 * Returns allocated string, or NULL for end of function.
5307 */
5308 char_u *
5309get_func_line(
5310 int c UNUSED,
5311 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005312 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005313 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314{
5315 funccall_T *fcp = (funccall_T *)cookie;
5316 ufunc_T *fp = fcp->func;
5317 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005318 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319
Bram Moolenaare38eab22019-12-05 21:50:01 +01005320 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321 if (fcp->dbg_tick != debug_tick)
5322 {
5323 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005324 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005325 fcp->dbg_tick = debug_tick;
5326 }
5327#ifdef FEAT_PROFILE
5328 if (do_profiling == PROF_YES)
5329 func_line_end(cookie);
5330#endif
5331
5332 gap = &fp->uf_lines;
5333 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5334 || fcp->returned)
5335 retval = NULL;
5336 else
5337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005338 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339 while (fcp->linenr < gap->ga_len
5340 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5341 ++fcp->linenr;
5342 if (fcp->linenr >= gap->ga_len)
5343 retval = NULL;
5344 else
5345 {
5346 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005347 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348#ifdef FEAT_PROFILE
5349 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005350 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351#endif
5352 }
5353 }
5354
Bram Moolenaare38eab22019-12-05 21:50:01 +01005355 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005356 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005357 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005358 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005359 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005360 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005361 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005362 fcp->dbg_tick = debug_tick;
5363 }
5364
5365 return retval;
5366}
5367
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005368/*
5369 * Return TRUE if the currently active function should be ended, because a
5370 * return was encountered or an error occurred. Used inside a ":while".
5371 */
5372 int
5373func_has_ended(void *cookie)
5374{
5375 funccall_T *fcp = (funccall_T *)cookie;
5376
Bram Moolenaare38eab22019-12-05 21:50:01 +01005377 // Ignore the "abort" flag if the abortion behavior has been changed due to
5378 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005379 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5380 || fcp->returned);
5381}
5382
5383/*
5384 * return TRUE if cookie indicates a function which "abort"s on errors.
5385 */
5386 int
5387func_has_abort(
5388 void *cookie)
5389{
5390 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5391}
5392
5393
5394/*
5395 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5396 * Don't do this when "Func" is already a partial that was bound
5397 * explicitly (pt_auto is FALSE).
5398 * Changes "rettv" in-place.
5399 * Returns the updated "selfdict_in".
5400 */
5401 dict_T *
5402make_partial(dict_T *selfdict_in, typval_T *rettv)
5403{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005404 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005405 char_u *tofree = NULL;
5406 ufunc_T *fp;
5407 char_u fname_buf[FLEN_FIXED + 1];
5408 int error;
5409 dict_T *selfdict = selfdict_in;
5410
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005411 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5412 fp = rettv->vval.v_partial->pt_func;
5413 else
5414 {
5415 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5416 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005417 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005418 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005419 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005420 vim_free(tofree);
5421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005422
5423 if (fp != NULL && (fp->uf_flags & FC_DICT))
5424 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005425 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005426
5427 if (pt != NULL)
5428 {
5429 pt->pt_refcount = 1;
5430 pt->pt_dict = selfdict;
5431 pt->pt_auto = TRUE;
5432 selfdict = NULL;
5433 if (rettv->v_type == VAR_FUNC)
5434 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005435 // Just a function: Take over the function name and use
5436 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005437 pt->pt_name = rettv->vval.v_string;
5438 }
5439 else
5440 {
5441 partial_T *ret_pt = rettv->vval.v_partial;
5442 int i;
5443
Bram Moolenaare38eab22019-12-05 21:50:01 +01005444 // Partial: copy the function name, use selfdict and copy
5445 // args. Can't take over name or args, the partial might
5446 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005447 if (ret_pt->pt_name != NULL)
5448 {
5449 pt->pt_name = vim_strsave(ret_pt->pt_name);
5450 func_ref(pt->pt_name);
5451 }
5452 else
5453 {
5454 pt->pt_func = ret_pt->pt_func;
5455 func_ptr_ref(pt->pt_func);
5456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005457 if (ret_pt->pt_argc > 0)
5458 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005459 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005461 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005462 pt->pt_argc = 0;
5463 else
5464 {
5465 pt->pt_argc = ret_pt->pt_argc;
5466 for (i = 0; i < pt->pt_argc; i++)
5467 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5468 }
5469 }
5470 partial_unref(ret_pt);
5471 }
5472 rettv->v_type = VAR_PARTIAL;
5473 rettv->vval.v_partial = pt;
5474 }
5475 }
5476 return selfdict;
5477}
5478
5479/*
5480 * Return the name of the executed function.
5481 */
5482 char_u *
5483func_name(void *cookie)
5484{
5485 return ((funccall_T *)cookie)->func->uf_name;
5486}
5487
5488/*
5489 * Return the address holding the next breakpoint line for a funccall cookie.
5490 */
5491 linenr_T *
5492func_breakpoint(void *cookie)
5493{
5494 return &((funccall_T *)cookie)->breakpoint;
5495}
5496
5497/*
5498 * Return the address holding the debug tick for a funccall cookie.
5499 */
5500 int *
5501func_dbg_tick(void *cookie)
5502{
5503 return &((funccall_T *)cookie)->dbg_tick;
5504}
5505
5506/*
5507 * Return the nesting level for a funccall cookie.
5508 */
5509 int
5510func_level(void *cookie)
5511{
5512 return ((funccall_T *)cookie)->level;
5513}
5514
5515/*
5516 * Return TRUE when a function was ended by a ":return" command.
5517 */
5518 int
5519current_func_returned(void)
5520{
5521 return current_funccal->returned;
5522}
5523
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005524 int
5525free_unref_funccal(int copyID, int testing)
5526{
5527 int did_free = FALSE;
5528 int did_free_funccal = FALSE;
5529 funccall_T *fc, **pfc;
5530
5531 for (pfc = &previous_funccal; *pfc != NULL; )
5532 {
5533 if (can_free_funccal(*pfc, copyID))
5534 {
5535 fc = *pfc;
5536 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005537 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005538 did_free = TRUE;
5539 did_free_funccal = TRUE;
5540 }
5541 else
5542 pfc = &(*pfc)->caller;
5543 }
5544 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005545 // When a funccal was freed some more items might be garbage
5546 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005547 (void)garbage_collect(testing);
5548
5549 return did_free;
5550}
5551
5552/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005553 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005554 */
5555 static funccall_T *
5556get_funccal(void)
5557{
5558 int i;
5559 funccall_T *funccal;
5560 funccall_T *temp_funccal;
5561
5562 funccal = current_funccal;
5563 if (debug_backtrace_level > 0)
5564 {
5565 for (i = 0; i < debug_backtrace_level; i++)
5566 {
5567 temp_funccal = funccal->caller;
5568 if (temp_funccal)
5569 funccal = temp_funccal;
5570 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005571 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005572 debug_backtrace_level = i;
5573 }
5574 }
5575 return funccal;
5576}
5577
5578/*
5579 * Return the hashtable used for local variables in the current funccal.
5580 * Return NULL if there is no current funccal.
5581 */
5582 hashtab_T *
5583get_funccal_local_ht()
5584{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005585 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005586 return NULL;
5587 return &get_funccal()->l_vars.dv_hashtab;
5588}
5589
5590/*
5591 * Return the l: scope variable.
5592 * Return NULL if there is no current funccal.
5593 */
5594 dictitem_T *
5595get_funccal_local_var()
5596{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005597 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005598 return NULL;
5599 return &get_funccal()->l_vars_var;
5600}
5601
5602/*
5603 * Return the hashtable used for argument in the current funccal.
5604 * Return NULL if there is no current funccal.
5605 */
5606 hashtab_T *
5607get_funccal_args_ht()
5608{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005609 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005610 return NULL;
5611 return &get_funccal()->l_avars.dv_hashtab;
5612}
5613
5614/*
5615 * Return the a: scope variable.
5616 * Return NULL if there is no current funccal.
5617 */
5618 dictitem_T *
5619get_funccal_args_var()
5620{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005621 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005622 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005623 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005624}
5625
5626/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005627 * List function variables, if there is a function.
5628 */
5629 void
5630list_func_vars(int *first)
5631{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005632 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005633 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005634 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005635}
5636
5637/*
5638 * If "ht" is the hashtable for local variables in the current funccal, return
5639 * the dict that contains it.
5640 * Otherwise return NULL.
5641 */
5642 dict_T *
5643get_current_funccal_dict(hashtab_T *ht)
5644{
5645 if (current_funccal != NULL
5646 && ht == &current_funccal->l_vars.dv_hashtab)
5647 return &current_funccal->l_vars;
5648 return NULL;
5649}
5650
5651/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005652 * Search hashitem in parent scope.
5653 */
5654 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005655find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005656{
5657 funccall_T *old_current_funccal = current_funccal;
5658 hashtab_T *ht;
5659 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005660 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005661
5662 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5663 return NULL;
5664
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005665 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005666 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005667 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005668 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005669 ht = find_var_ht(name, &varname);
5670 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005671 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005672 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005673 if (!HASHITEM_EMPTY(hi))
5674 {
5675 *pht = ht;
5676 break;
5677 }
5678 }
5679 if (current_funccal == current_funccal->func->uf_scoped)
5680 break;
5681 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005682 }
5683 current_funccal = old_current_funccal;
5684
5685 return hi;
5686}
5687
5688/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005689 * Search variable in parent scope.
5690 */
5691 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005692find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005693{
5694 dictitem_T *v = NULL;
5695 funccall_T *old_current_funccal = current_funccal;
5696 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005697 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005698
5699 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5700 return NULL;
5701
Bram Moolenaare38eab22019-12-05 21:50:01 +01005702 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005703 current_funccal = current_funccal->func->uf_scoped;
5704 while (current_funccal)
5705 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005706 ht = find_var_ht(name, &varname);
5707 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005708 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005709 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005710 if (v != NULL)
5711 break;
5712 }
5713 if (current_funccal == current_funccal->func->uf_scoped)
5714 break;
5715 current_funccal = current_funccal->func->uf_scoped;
5716 }
5717 current_funccal = old_current_funccal;
5718
5719 return v;
5720}
5721
5722/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005723 * Set "copyID + 1" in previous_funccal and callers.
5724 */
5725 int
5726set_ref_in_previous_funccal(int copyID)
5727{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005728 funccall_T *fc;
5729
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005730 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005731 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005732 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005733 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5734 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5735 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5736 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005737 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005738 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005739}
5740
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005741 static int
5742set_ref_in_funccal(funccall_T *fc, int copyID)
5743{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005744 if (fc->fc_copyID != copyID)
5745 {
5746 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005747 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5748 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5749 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5750 || set_ref_in_func(NULL, fc->func, copyID))
5751 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005752 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005753 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005754}
5755
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005756/*
5757 * Set "copyID" in all local vars and arguments in the call stack.
5758 */
5759 int
5760set_ref_in_call_stack(int copyID)
5761{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005762 funccall_T *fc;
5763 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005764
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005765 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5766 if (set_ref_in_funccal(fc, copyID))
5767 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005768
5769 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005770 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5771 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5772 if (set_ref_in_funccal(fc, copyID))
5773 return TRUE;
5774 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005775}
5776
5777/*
5778 * Set "copyID" in all functions available by name.
5779 */
5780 int
5781set_ref_in_functions(int copyID)
5782{
5783 int todo;
5784 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005785 ufunc_T *fp;
5786
5787 todo = (int)func_hashtab.ht_used;
5788 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005789 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005790 if (!HASHITEM_EMPTY(hi))
5791 {
5792 --todo;
5793 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005794 if (!func_name_refcount(fp->uf_name)
5795 && set_ref_in_func(NULL, fp, copyID))
5796 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005797 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005798 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005799 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005800}
5801
5802/*
5803 * Set "copyID" in all function arguments.
5804 */
5805 int
5806set_ref_in_func_args(int copyID)
5807{
5808 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005809
5810 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005811 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5812 copyID, NULL, NULL))
5813 return TRUE;
5814 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005815}
5816
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005817/*
5818 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005819 * Returns TRUE if setting references failed somehow.
5820 */
5821 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005822set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005823{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005824 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005825 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005826 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005827 char_u fname_buf[FLEN_FIXED + 1];
5828 char_u *tofree = NULL;
5829 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005830 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005831
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005832 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005833 return FALSE;
5834
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005835 if (fp_in == NULL)
5836 {
5837 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005838 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005839 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005840 if (fp != NULL)
5841 {
5842 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005843 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005844 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005845
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005846 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005847 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005848}
5849
Bram Moolenaare38eab22019-12-05 21:50:01 +01005850#endif // FEAT_EVAL