blob: cc921f5a1dd04f3254ff8a3e37ed0c7ed318c365 [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 }
1599 // TODO: what if (import->imp_flags & IMP_FLAGS_STAR)
1600 {
1601 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1602 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1603 + import->imp_var_vals_idx;
1604 tv = sv->sv_tv;
1605 if (type != NULL)
1606 *type = sv->sv_type;
1607 did_type = TRUE;
1608 }
1609 }
1610 }
1611
1612 if (tv != NULL)
1613 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001614 if (found_var != NULL)
1615 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001616 if (tv->v_type == VAR_FUNC)
1617 {
1618 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001619 {
1620 *lenp = 0;
1621 return (char_u *)""; // just in case
1622 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001623 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001624 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001627 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001629 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001630
1631 if (pt == NULL)
1632 {
1633 *lenp = 0;
1634 return (char_u *)""; // just in case
1635 }
1636 if (partialp != NULL)
1637 *partialp = pt;
1638 s = partial_name(pt);
1639 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001641
1642 if (s != NULL)
1643 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001644 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001645 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001646 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001647
1648 if (sv != NULL)
1649 *type = sv->sv_type;
1650 }
1651 return s;
1652 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653 }
1654
1655 return name;
1656}
1657
1658/*
1659 * Give an error message with a function name. Handle <SNR> things.
1660 * "ermsg" is to be passed without translation, use N_() instead of _().
1661 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001662 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001663emsg_funcname(char *ermsg, char_u *name)
1664{
1665 char_u *p;
1666
1667 if (*name == K_SPECIAL)
1668 p = concat_str((char_u *)"<SNR>", name + 3);
1669 else
1670 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001671 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672 if (p != name)
1673 vim_free(p);
1674}
1675
1676/*
1677 * Allocate a variable for the result of a function.
1678 * Return OK or FAIL.
1679 */
1680 int
1681get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001682 char_u *name, // name of the function
1683 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001685 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001686 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001687 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688{
1689 char_u *argp;
1690 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001691 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1692 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001693 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694
1695 /*
1696 * Get the arguments.
1697 */
1698 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001699 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1700 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001702 // skip the '(' or ',' and possibly line breaks
1703 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1704
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 if (*argp == ')' || *argp == ',' || *argp == NUL)
1706 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001707 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 {
1709 ret = FAIL;
1710 break;
1711 }
1712 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001713 // The comma should come right after the argument, but this wasn't
1714 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001715 if (vim9script)
1716 {
1717 if (*argp != ',' && *skipwhite(argp) == ',')
1718 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001719 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001720 ret = FAIL;
1721 break;
1722 }
1723 }
1724 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001725 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 if (*argp != ',')
1727 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001728 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1729 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001730 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001731 ret = FAIL;
1732 break;
1733 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001735 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736 if (*argp == ')')
1737 ++argp;
1738 else
1739 ret = FAIL;
1740
1741 if (ret == OK)
1742 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001743 int i = 0;
1744 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745
1746 if (get_vim_var_nr(VV_TESTING))
1747 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001748 // Prepare for calling test_garbagecollect_now(), need to know
1749 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 if (funcargs.ga_itemsize == 0)
1751 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1752 for (i = 0; i < argcount; ++i)
1753 if (ga_grow(&funcargs, 1) == OK)
1754 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1755 &argvars[i];
1756 }
1757
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001758 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001759 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001760 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001761 // An error in a builtin function does not return FAIL, but we do
1762 // want to abort further processing if an error was given.
1763 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001764 clear_tv(rettv);
1765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001766
1767 funcargs.ga_len -= i;
1768 }
1769 else if (!aborting())
1770 {
1771 if (argcount == MAX_FUNC_ARGS)
1772 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1773 else
1774 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1775 }
1776
1777 while (--argcount >= 0)
1778 clear_tv(&argvars[argcount]);
1779
Bram Moolenaar8294d492020-08-10 22:40:56 +02001780 if (in_vim9script())
1781 *arg = argp;
1782 else
1783 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784 return ret;
1785}
1786
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787/*
1788 * Return TRUE if "p" starts with "<SID>" or "s:".
1789 * Only works if eval_fname_script() returned non-zero for "p"!
1790 */
1791 static int
1792eval_fname_sid(char_u *p)
1793{
1794 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1795}
1796
1797/*
1798 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1799 * Change <SNR>123_name() to K_SNR 123_name().
1800 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1801 * (slow).
1802 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001803 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1805{
1806 int llen;
1807 char_u *fname;
1808 int i;
1809
1810 llen = eval_fname_script(name);
1811 if (llen > 0)
1812 {
1813 fname_buf[0] = K_SPECIAL;
1814 fname_buf[1] = KS_EXTRA;
1815 fname_buf[2] = (int)KE_SNR;
1816 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001817 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001819 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001820 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821 else
1822 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001823 sprintf((char *)fname_buf + 3, "%ld_",
1824 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825 i = (int)STRLEN(fname_buf);
1826 }
1827 }
1828 if (i + STRLEN(name + llen) < FLEN_FIXED)
1829 {
1830 STRCPY(fname_buf + i, name + llen);
1831 fname = fname_buf;
1832 }
1833 else
1834 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001835 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001837 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 else
1839 {
1840 *tofree = fname;
1841 mch_memmove(fname, fname_buf, (size_t)i);
1842 STRCPY(fname + i, name + llen);
1843 }
1844 }
1845 }
1846 else
1847 fname = name;
1848 return fname;
1849}
1850
1851/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001852 * Find a function "name" in script "sid".
1853 */
1854 static ufunc_T *
1855find_func_with_sid(char_u *name, int sid)
1856{
1857 hashitem_T *hi;
1858 char_u buffer[200];
1859
1860 buffer[0] = K_SPECIAL;
1861 buffer[1] = KS_EXTRA;
1862 buffer[2] = (int)KE_SNR;
1863 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1864 (long)sid, name);
1865 hi = hash_find(&func_hashtab, buffer);
1866 if (!HASHITEM_EMPTY(hi))
1867 return HI2UF(hi);
1868
1869 return NULL;
1870}
1871
1872/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001874 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875 * Return NULL for unknown function.
1876 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001877 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001878find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001879{
1880 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 ufunc_T *func;
1882 imported_T *imported;
1883
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001884 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001885 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001886 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001887 long sid = 0;
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001888 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1889 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001890
Bram Moolenaar95006e32020-08-29 17:47:08 +02001891 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001892 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001893 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001894 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1895 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001896 if (func != NULL)
1897 return func;
1898 }
1899
Bram Moolenaarefa94442020-08-08 22:16:00 +02001900 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001901 && name[1] == KS_EXTRA
1902 && name[2] == KE_SNR)
1903 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001904 // Caller changes s: to <SNR>99_name.
1905
1906 after_script = name + 3;
1907 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001908 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001909 ++after_script;
1910 else
1911 after_script = NULL;
1912 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001913 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001914 {
1915 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001916 if (after_script != NULL && sid != current_sctx.sc_sid)
1917 imported = find_imported_in_script(after_script, 0, sid);
1918 else
1919 imported = find_imported(after_script == NULL
1920 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001921 if (imported != NULL && imported->imp_funcname != NULL)
1922 {
1923 hi = hash_find(&func_hashtab, imported->imp_funcname);
1924 if (!HASHITEM_EMPTY(hi))
1925 return HI2UF(hi);
1926 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001927 }
1928 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001929
Bram Moolenaara26b9702020-04-18 19:53:28 +02001930 hi = hash_find(&func_hashtab,
1931 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001932 if (!HASHITEM_EMPTY(hi))
1933 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001934
1935 return NULL;
1936}
1937
1938/*
1939 * Find a function by name, return pointer to it in ufuncs.
1940 * "cctx" is passed in a :def function to find imported functions.
1941 * Return NULL for unknown or dead function.
1942 */
1943 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001944find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001945{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001946 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947
1948 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1949 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950 return NULL;
1951}
1952
1953/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001954 * Return TRUE if "ufunc" is a global function.
1955 */
1956 int
1957func_is_global(ufunc_T *ufunc)
1958{
1959 return ufunc->uf_name[0] != K_SPECIAL;
1960}
1961
1962/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001963 * Copy the function name of "fp" to buffer "buf".
1964 * "buf" must be able to hold the function name plus three bytes.
1965 * Takes care of script-local function names.
1966 */
1967 static void
1968cat_func_name(char_u *buf, ufunc_T *fp)
1969{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001970 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001971 {
1972 STRCPY(buf, "<SNR>");
1973 STRCAT(buf, fp->uf_name + 3);
1974 }
1975 else
1976 STRCPY(buf, fp->uf_name);
1977}
1978
1979/*
1980 * Add a number variable "name" to dict "dp" with value "nr".
1981 */
1982 static void
1983add_nr_var(
1984 dict_T *dp,
1985 dictitem_T *v,
1986 char *name,
1987 varnumber_T nr)
1988{
1989 STRCPY(v->di_key, name);
1990 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1991 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1992 v->di_tv.v_type = VAR_NUMBER;
1993 v->di_tv.v_lock = VAR_FIXED;
1994 v->di_tv.vval.v_number = nr;
1995}
1996
1997/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001998 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001999 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002000 static void
2001free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002002{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002003 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002004
2005 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2006 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002007 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002008
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002009 // When garbage collecting a funccall_T may be freed before the
2010 // function that references it, clear its uf_scoped field.
2011 // The function may have been redefined and point to another
2012 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002013 if (fp != NULL && fp->uf_scoped == fc)
2014 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002015 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002016 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002017
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002018 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002019 vim_free(fc);
2020}
2021
2022/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002023 * Free "fc" and what it contains.
2024 * Can be called only when "fc" is kept beyond the period of it called,
2025 * i.e. after cleanup_function_call(fc).
2026 */
2027 static void
2028free_funccal_contents(funccall_T *fc)
2029{
2030 listitem_T *li;
2031
2032 // Free all l: variables.
2033 vars_clear(&fc->l_vars.dv_hashtab);
2034
2035 // Free all a: variables.
2036 vars_clear(&fc->l_avars.dv_hashtab);
2037
2038 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002039 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002040 clear_tv(&li->li_tv);
2041
2042 free_funccal(fc);
2043}
2044
2045/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002046 * Handle the last part of returning from a function: free the local hashtable.
2047 * Unless it is still in use by a closure.
2048 */
2049 static void
2050cleanup_function_call(funccall_T *fc)
2051{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002052 int may_free_fc = fc->fc_refcount <= 0;
2053 int free_fc = TRUE;
2054
Bram Moolenaar6914c642017-04-01 21:21:30 +02002055 current_funccal = fc->caller;
2056
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002057 // Free all l: variables if not referred.
2058 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2059 vars_clear(&fc->l_vars.dv_hashtab);
2060 else
2061 free_fc = FALSE;
2062
2063 // If the a:000 list and the l: and a: dicts are not referenced and
2064 // there is no closure using it, we can free the funccall_T and what's
2065 // in it.
2066 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2067 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002068 else
2069 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002070 int todo;
2071 hashitem_T *hi;
2072 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002073
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002074 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002075
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002076 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002077 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2078 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2079 {
2080 if (!HASHITEM_EMPTY(hi))
2081 {
2082 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002083 di = HI2DI(hi);
2084 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002085 }
2086 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002087 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002088
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002089 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2090 fc->l_varlist.lv_first = NULL;
2091 else
2092 {
2093 listitem_T *li;
2094
2095 free_fc = FALSE;
2096
2097 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002098 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002099 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002100 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002101
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002102 if (free_fc)
2103 free_funccal(fc);
2104 else
2105 {
2106 static int made_copy = 0;
2107
2108 // "fc" is still in use. This can happen when returning "a:000",
2109 // assigning "l:" to a global variable or defining a closure.
2110 // Link "fc" in the list for garbage collection later.
2111 fc->caller = previous_funccal;
2112 previous_funccal = fc;
2113
2114 if (want_garbage_collect)
2115 // If garbage collector is ready, clear count.
2116 made_copy = 0;
2117 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002118 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002119 // We have made a lot of copies, worth 4 Mbyte. This can happen
2120 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002121 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002122 // too much memory.
2123 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002124 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002125 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002126 }
2127}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002128
2129/*
2130 * There are two kinds of function names:
2131 * 1. ordinary names, function defined with :function or :def
2132 * 2. numbered functions and lambdas
2133 * For the first we only count the name stored in func_hashtab as a reference,
2134 * using function() does not count as a reference, because the function is
2135 * looked up by name.
2136 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002137 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002138func_name_refcount(char_u *name)
2139{
2140 return isdigit(*name) || *name == '<';
2141}
2142
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002143/*
2144 * Unreference "fc": decrement the reference count and free it when it
2145 * becomes zero. "fp" is detached from "fc".
2146 * When "force" is TRUE we are exiting.
2147 */
2148 static void
2149funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2150{
2151 funccall_T **pfc;
2152 int i;
2153
2154 if (fc == NULL)
2155 return;
2156
2157 if (--fc->fc_refcount <= 0 && (force || (
2158 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2159 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2160 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2161 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2162 {
2163 if (fc == *pfc)
2164 {
2165 *pfc = fc->caller;
2166 free_funccal_contents(fc);
2167 return;
2168 }
2169 }
2170 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2171 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2172 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2173}
2174
2175/*
2176 * Remove the function from the function hashtable. If the function was
2177 * deleted while it still has references this was already done.
2178 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2179 */
2180 static int
2181func_remove(ufunc_T *fp)
2182{
2183 hashitem_T *hi;
2184
2185 // Return if it was already virtually deleted.
2186 if (fp->uf_flags & FC_DEAD)
2187 return FALSE;
2188
2189 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2190 if (!HASHITEM_EMPTY(hi))
2191 {
2192 // When there is a def-function index do not actually remove the
2193 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002194 // Do remove it when it's a copy.
2195 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002196 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002197 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002198 return FALSE;
2199 }
2200 hash_remove(&func_hashtab, hi);
2201 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002202 return TRUE;
2203 }
2204 return FALSE;
2205}
2206
2207 static void
2208func_clear_items(ufunc_T *fp)
2209{
2210 ga_clear_strings(&(fp->uf_args));
2211 ga_clear_strings(&(fp->uf_def_args));
2212 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002213 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002214 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002215 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002216 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002217
2218 // Increment the refcount of this function to avoid it being freed
2219 // recursively when the partial is freed.
2220 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002221 partial_unref(fp->uf_partial);
2222 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002223 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002224
2225#ifdef FEAT_LUA
2226 if (fp->uf_cb_free != NULL)
2227 {
2228 fp->uf_cb_free(fp->uf_cb_state);
2229 fp->uf_cb_free = NULL;
2230 }
2231
2232 fp->uf_cb_state = NULL;
2233 fp->uf_cb = NULL;
2234#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002235#ifdef FEAT_PROFILE
2236 VIM_CLEAR(fp->uf_tml_count);
2237 VIM_CLEAR(fp->uf_tml_total);
2238 VIM_CLEAR(fp->uf_tml_self);
2239#endif
2240}
2241
2242/*
2243 * Free all things that a function contains. Does not free the function
2244 * itself, use func_free() for that.
2245 * When "force" is TRUE we are exiting.
2246 */
2247 static void
2248func_clear(ufunc_T *fp, int force)
2249{
2250 if (fp->uf_cleared)
2251 return;
2252 fp->uf_cleared = TRUE;
2253
2254 // clear this function
2255 func_clear_items(fp);
2256 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002257 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002258}
2259
2260/*
2261 * Free a function and remove it from the list of functions. Does not free
2262 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002263 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002264 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002265 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002266 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002267func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002268{
2269 // Only remove it when not done already, otherwise we would remove a newer
2270 // version of the function with the same name.
2271 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2272 func_remove(fp);
2273
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002274 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002275 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002276 if (fp->uf_dfunc_idx > 0)
2277 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002278 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002279 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002280 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002281 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002282 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002283}
2284
2285/*
2286 * Free all things that a function contains and free the function itself.
2287 * When "force" is TRUE we are exiting.
2288 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002289 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002290func_clear_free(ufunc_T *fp, int force)
2291{
2292 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002293 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2294 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002295 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002296 else
2297 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002298}
2299
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002300/*
2301 * Copy already defined function "lambda" to a new function with name "global".
2302 * This is for when a compiled function defines a global function.
2303 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002304 int
2305copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002306{
2307 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002308 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002309
2310 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002311 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002312 semsg(_(e_lambda_function_not_found_str), lambda);
2313 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002314 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002315
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002316 fp = find_func(global, TRUE, NULL);
2317 if (fp != NULL)
2318 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002319 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002320 semsg(_(e_funcexts), global);
2321 return FAIL;
2322 }
2323
2324 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2325 if (fp == NULL)
2326 return FAIL;
2327
2328 fp->uf_varargs = ufunc->uf_varargs;
2329 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2330 fp->uf_def_status = ufunc->uf_def_status;
2331 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2332 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2333 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2334 == FAIL
2335 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2336 goto failed;
2337
2338 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2339 : vim_strsave(ufunc->uf_name_exp);
2340 if (ufunc->uf_arg_types != NULL)
2341 {
2342 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2343 if (fp->uf_arg_types == NULL)
2344 goto failed;
2345 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2346 sizeof(type_T *) * fp->uf_args.ga_len);
2347 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002348 if (ufunc->uf_va_name != NULL)
2349 {
2350 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2351 if (fp->uf_va_name == NULL)
2352 goto failed;
2353 }
2354 fp->uf_ret_type = ufunc->uf_ret_type;
2355
2356 fp->uf_refcount = 1;
2357 STRCPY(fp->uf_name, global);
2358 hash_add(&func_hashtab, UF2HIKEY(fp));
2359
2360 // the referenced dfunc_T is now used one more time
2361 link_def_function(fp);
2362
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002363 // Create a partial to store the context of the function where it was
2364 // instantiated. Only needs to be done once. Do this on the original
2365 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002366 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2367 {
2368 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2369
2370 if (pt == NULL)
2371 goto failed;
2372 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002373 {
2374 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002375 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002376 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002377 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002378 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002379 }
2380
2381 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002382
2383failed:
2384 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002385 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002386}
2387
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002388static int funcdepth = 0;
2389
2390/*
2391 * Increment the function call depth count.
2392 * Return FAIL when going over 'maxfuncdepth'.
2393 * Otherwise return OK, must call funcdepth_decrement() later!
2394 */
2395 int
2396funcdepth_increment(void)
2397{
2398 if (funcdepth >= p_mfd)
2399 {
2400 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2401 return FAIL;
2402 }
2403 ++funcdepth;
2404 return OK;
2405}
2406
2407 void
2408funcdepth_decrement(void)
2409{
2410 --funcdepth;
2411}
2412
2413/*
2414 * Get the current function call depth.
2415 */
2416 int
2417funcdepth_get(void)
2418{
2419 return funcdepth;
2420}
2421
2422/*
2423 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002424 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002425 * times as funcdepth_increment().
2426 */
2427 void
2428funcdepth_restore(int depth)
2429{
2430 funcdepth = depth;
2431}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002432
2433/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 * Call a user function.
2435 */
2436 static void
2437call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002438 ufunc_T *fp, // pointer to function
2439 int argcount, // nr of args
2440 typval_T *argvars, // arguments
2441 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002442 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002443 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002445 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002446 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 funccall_T *fc;
2448 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002449 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002451 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 int i;
2453 int ai;
2454 int islambda = FALSE;
2455 char_u numbuf[NUMBUFLEN];
2456 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002457 typval_T *tv_to_free[MAX_FUNC_ARGS];
2458 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002459#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002460 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002462 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463
Bram Moolenaarb2049902021-01-24 12:53:53 +01002464#ifdef FEAT_PROFILE
2465 CLEAR_FIELD(profile_info);
2466#endif
2467
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002468 // If depth of calling is getting too high, don't execute the function.
2469 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 rettv->v_type = VAR_NUMBER;
2472 rettv->vval.v_number = -1;
2473 return;
2474 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475
Bram Moolenaare38eab22019-12-05 21:50:01 +01002476 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002478 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002479 if (fc == NULL)
2480 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 fc->caller = current_funccal;
2482 current_funccal = fc;
2483 fc->func = fp;
2484 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002486 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2488 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002489 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002490 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002491 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002493 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002494 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002495#ifdef FEAT_PROFILE
2496 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2497#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002498 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002499#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002500 if (do_profiling == PROF_YES)
2501 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002502#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002503 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002504 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002505#ifdef FEAT_PROFILE
2506 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002507 || (caller != NULL && caller->uf_profiling)))
2508 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002509#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002511 free_funccal(fc);
2512 return;
2513 }
2514
Bram Moolenaar38453522021-11-28 22:00:12 +00002515 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516
2517 /*
2518 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2519 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2520 * each argument variable and saves a lot of time.
2521 */
2522 /*
2523 * Init l: variables.
2524 */
2525 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2526 if (selfdict != NULL)
2527 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002528 // Set l:self to "selfdict". Use "name" to avoid a warning from
2529 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 v = &fc->fixvar[fixvar_idx++].var;
2531 name = v->di_key;
2532 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002533 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2535 v->di_tv.v_type = VAR_DICT;
2536 v->di_tv.v_lock = 0;
2537 v->di_tv.vval.v_dict = selfdict;
2538 ++selfdict->dv_refcount;
2539 }
2540
2541 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002542 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002543 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 * Set a:000 to a list with room for the "..." arguments.
2545 */
2546 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002547 if ((fp->uf_flags & FC_NOARGS) == 0)
2548 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002549 (varnumber_T)(argcount >= fp->uf_args.ga_len
2550 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002551 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002552 if ((fp->uf_flags & FC_NOARGS) == 0)
2553 {
2554 // Use "name" to avoid a warning from some compiler that checks the
2555 // destination size.
2556 v = &fc->fixvar[fixvar_idx++].var;
2557 name = v->di_key;
2558 STRCPY(name, "000");
2559 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2560 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2561 v->di_tv.v_type = VAR_LIST;
2562 v->di_tv.v_lock = VAR_FIXED;
2563 v->di_tv.vval.v_list = &fc->l_varlist;
2564 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002565 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2567 fc->l_varlist.lv_lock = VAR_FIXED;
2568
2569 /*
2570 * Set a:firstline to "firstline" and a:lastline to "lastline".
2571 * Set a:name to named arguments.
2572 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002573 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002575 if ((fp->uf_flags & FC_NOARGS) == 0)
2576 {
2577 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002578 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002579 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002580 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002581 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002582 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002583 {
2584 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002585 typval_T def_rettv;
2586 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587
2588 ai = i - fp->uf_args.ga_len;
2589 if (ai < 0)
2590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002591 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592 name = FUNCARG(fp, i);
2593 if (islambda)
2594 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002595
2596 // evaluate named argument default expression
2597 isdefault = ai + fp->uf_def_args.ga_len >= 0
2598 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2599 && argvars[i].vval.v_number == VVAL_NONE));
2600 if (isdefault)
2601 {
2602 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002603
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002604 def_rettv.v_type = VAR_NUMBER;
2605 def_rettv.vval.v_number = -1;
2606
2607 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2608 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002609 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002610 {
2611 default_arg_err = 1;
2612 break;
2613 }
2614 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 }
2616 else
2617 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002618 if ((fp->uf_flags & FC_NOARGS) != 0)
2619 // Bail out if no a: arguments used (in lambda).
2620 break;
2621
Bram Moolenaare38eab22019-12-05 21:50:01 +01002622 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 sprintf((char *)numbuf, "%d", ai + 1);
2624 name = numbuf;
2625 }
2626 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2627 {
2628 v = &fc->fixvar[fixvar_idx++].var;
2629 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002630 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631 }
2632 else
2633 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002634 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635 if (v == NULL)
2636 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002637 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002640 // Note: the values are copied directly to avoid alloc/free.
2641 // "argvars" must have VAR_FIXED for v_lock.
2642 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 v->di_tv.v_lock = VAR_FIXED;
2644
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002645 if (isdefault)
2646 // Need to free this later, no matter where it's stored.
2647 tv_to_free[tv_to_free_len++] = &v->di_tv;
2648
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 if (addlocal)
2650 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002651 // Named arguments should be accessed without the "a:" prefix in
2652 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002653 copy_tv(&v->di_tv, &v->di_tv);
2654 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002656 else
2657 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658
2659 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2660 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002661 listitem_T *li = &fc->l_listitems[ai];
2662
2663 li->li_tv = argvars[i];
2664 li->li_tv.v_lock = VAR_FIXED;
2665 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 }
2667 }
2668
Bram Moolenaare38eab22019-12-05 21:50:01 +01002669 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002671
2672 if (fp->uf_flags & FC_SANDBOX)
2673 {
2674 using_sandbox = TRUE;
2675 ++sandbox;
2676 }
2677
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002678 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002679 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002680 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002682 ++no_wait_return;
2683 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002685 smsg(_("calling %s"), SOURCING_NAME);
2686 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002688 char_u buf[MSG_BUF_LEN];
2689 char_u numbuf2[NUMBUFLEN];
2690 char_u *tofree;
2691 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002693 msg_puts("(");
2694 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002696 if (i > 0)
2697 msg_puts(", ");
2698 if (argvars[i].v_type == VAR_NUMBER)
2699 msg_outnum((long)argvars[i].vval.v_number);
2700 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002702 // Do not want errors such as E724 here.
2703 ++emsg_off;
2704 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2705 --emsg_off;
2706 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002708 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002710 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2711 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002713 msg_puts((char *)s);
2714 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 }
2716 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002718 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002720 msg_puts("\n"); // don't overwrite this either
2721
2722 verbose_leave_scroll();
2723 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 }
2725#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002726 if (do_profiling == PROF_YES)
2727 profile_may_start_func(&profile_info, fp,
2728 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002729#endif
2730
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002731 save_current_sctx = current_sctx;
2732 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 save_did_emsg = did_emsg;
2734 did_emsg = FALSE;
2735
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002736 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2737 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002738 else if (islambda)
2739 {
2740 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2741
2742 // A Lambda always has the command "return {expr}". It is much faster
2743 // to evaluate {expr} directly.
2744 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002745 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002746 --ex_nesting_level;
2747 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002748 else
2749 // call do_cmdline() to execute the lines
2750 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2752
2753 --RedrawingDisabled;
2754
Bram Moolenaare38eab22019-12-05 21:50:01 +01002755 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2757 {
2758 clear_tv(rettv);
2759 rettv->v_type = VAR_NUMBER;
2760 rettv->vval.v_number = -1;
2761 }
2762
2763#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002764 if (do_profiling == PROF_YES)
2765 {
2766 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2767
2768 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2769 profile_may_end_func(&profile_info, fp, caller);
2770 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771#endif
2772
Bram Moolenaare38eab22019-12-05 21:50:01 +01002773 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 if (p_verbose >= 12)
2775 {
2776 ++no_wait_return;
2777 verbose_enter_scroll();
2778
2779 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002780 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002782 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 (long)fc->rettv->vval.v_number);
2784 else
2785 {
2786 char_u buf[MSG_BUF_LEN];
2787 char_u numbuf2[NUMBUFLEN];
2788 char_u *tofree;
2789 char_u *s;
2790
Bram Moolenaare38eab22019-12-05 21:50:01 +01002791 // The value may be very long. Skip the middle part, so that we
2792 // have some idea how it starts and ends. smsg() would always
2793 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 ++emsg_off;
2795 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2796 --emsg_off;
2797 if (s != NULL)
2798 {
2799 if (vim_strsize(s) > MSG_BUF_CLEN)
2800 {
2801 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2802 s = buf;
2803 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002804 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 vim_free(tofree);
2806 }
2807 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002808 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809
2810 verbose_leave_scroll();
2811 --no_wait_return;
2812 }
2813
Bram Moolenaare31ee862020-01-07 20:59:34 +01002814 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002815 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002816 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817#ifdef FEAT_PROFILE
2818 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002819 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002821 if (using_sandbox)
2822 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002823
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 {
2826 ++no_wait_return;
2827 verbose_enter_scroll();
2828
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002829 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002830 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831
2832 verbose_leave_scroll();
2833 --no_wait_return;
2834 }
2835
2836 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002837 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002838 for (i = 0; i < tv_to_free_len; ++i)
2839 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002840 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841}
2842
2843/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002844 * Check the argument count for user function "fp".
2845 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2846 */
2847 int
2848check_user_func_argcount(ufunc_T *fp, int argcount)
2849{
2850 int regular_args = fp->uf_args.ga_len;
2851
2852 if (argcount < regular_args - fp->uf_def_args.ga_len)
2853 return FCERR_TOOFEW;
2854 else if (!has_varargs(fp) && argcount > regular_args)
2855 return FCERR_TOOMANY;
2856 return FCERR_UNKNOWN;
2857}
2858
2859/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002860 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002861 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002862 int
2863call_user_func_check(
2864 ufunc_T *fp,
2865 int argcount,
2866 typval_T *argvars,
2867 typval_T *rettv,
2868 funcexe_T *funcexe,
2869 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002870{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002871 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002872
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002873 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2874 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002875 error = check_user_func_argcount(fp, argcount);
2876 if (error != FCERR_UNKNOWN)
2877 return error;
2878 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002879 error = FCERR_DICT;
2880 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002881 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002882 int did_save_redo = FALSE;
2883 save_redo_T save_redo;
2884
2885 /*
2886 * Call the user function.
2887 * Save and restore search patterns, script variables and
2888 * redo buffer.
2889 */
2890 save_search_patterns();
2891 if (!ins_compl_active())
2892 {
2893 saveRedobuff(&save_redo);
2894 did_save_redo = TRUE;
2895 }
2896 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002897 call_user_func(fp, argcount, argvars, rettv, funcexe,
2898 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002899 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2900 // Function was unreferenced while being used, free it now.
2901 func_clear_free(fp, FALSE);
2902 if (did_save_redo)
2903 restoreRedobuff(&save_redo);
2904 restore_search_patterns();
2905 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002906 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002907 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002908}
2909
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002910static funccal_entry_T *funccal_stack = NULL;
2911
2912/*
2913 * Save the current function call pointer, and set it to NULL.
2914 * Used when executing autocommands and for ":source".
2915 */
2916 void
2917save_funccal(funccal_entry_T *entry)
2918{
2919 entry->top_funccal = current_funccal;
2920 entry->next = funccal_stack;
2921 funccal_stack = entry;
2922 current_funccal = NULL;
2923}
2924
2925 void
2926restore_funccal(void)
2927{
2928 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002929 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002930 else
2931 {
2932 current_funccal = funccal_stack->top_funccal;
2933 funccal_stack = funccal_stack->next;
2934 }
2935}
2936
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002937 funccall_T *
2938get_current_funccal(void)
2939{
2940 return current_funccal;
2941}
2942
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002943/*
2944 * Mark all functions of script "sid" as deleted.
2945 */
2946 void
2947delete_script_functions(int sid)
2948{
2949 hashitem_T *hi;
2950 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002951 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002952 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002953 size_t len;
2954
2955 buf[0] = K_SPECIAL;
2956 buf[1] = KS_EXTRA;
2957 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002958 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002959 len = STRLEN(buf);
2960
Bram Moolenaarce658352020-07-31 23:47:12 +02002961 while (todo > 0)
2962 {
2963 todo = func_hashtab.ht_used;
2964 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2965 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002966 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002967 fp = HI2UF(hi);
2968 if (STRNCMP(fp->uf_name, buf, len) == 0)
2969 {
2970 int changed = func_hashtab.ht_changed;
2971
2972 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002973
2974 if (fp->uf_calls > 0)
2975 {
2976 // Function is executing, don't free it but do remove
2977 // it from the hashtable.
2978 if (func_remove(fp))
2979 fp->uf_refcount--;
2980 }
2981 else
2982 {
2983 func_clear(fp, TRUE);
2984 // When clearing a function another function can be
2985 // cleared as a side effect. When that happens start
2986 // over.
2987 if (changed != func_hashtab.ht_changed)
2988 break;
2989 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002990 }
2991 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002992 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002993 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002994}
2995
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002996#if defined(EXITFREE) || defined(PROTO)
2997 void
2998free_all_functions(void)
2999{
3000 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003001 ufunc_T *fp;
3002 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003003 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003004 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005
Bram Moolenaare38eab22019-12-05 21:50:01 +01003006 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003007 while (current_funccal != NULL)
3008 {
3009 clear_tv(current_funccal->rettv);
3010 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003011 if (current_funccal == NULL && funccal_stack != NULL)
3012 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003013 }
3014
Bram Moolenaare38eab22019-12-05 21:50:01 +01003015 // First clear what the functions contain. Since this may lower the
3016 // reference count of a function, it may also free a function and change
3017 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003018 while (todo > 0)
3019 {
3020 todo = func_hashtab.ht_used;
3021 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3022 if (!HASHITEM_EMPTY(hi))
3023 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003024 // clear the def function index now
3025 fp = HI2UF(hi);
3026 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003027 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003028
Bram Moolenaare38eab22019-12-05 21:50:01 +01003029 // Only free functions that are not refcounted, those are
3030 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003031 if (func_name_refcount(fp->uf_name))
3032 ++skipped;
3033 else
3034 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003035 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003036 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003037 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003038 {
3039 skipped = 0;
3040 break;
3041 }
3042 }
3043 --todo;
3044 }
3045 }
3046
Bram Moolenaare38eab22019-12-05 21:50:01 +01003047 // Now actually free the functions. Need to start all over every time,
3048 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003049 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003050 while (func_hashtab.ht_used > skipped)
3051 {
3052 todo = func_hashtab.ht_used;
3053 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003054 if (!HASHITEM_EMPTY(hi))
3055 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003056 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003057 // Only free functions that are not refcounted, those are
3058 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003059 fp = HI2UF(hi);
3060 if (func_name_refcount(fp->uf_name))
3061 ++skipped;
3062 else
3063 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003064 if (func_free(fp, FALSE) == OK)
3065 {
3066 skipped = 0;
3067 break;
3068 }
3069 // did not actually free it
3070 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003071 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003072 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003073 }
3074 if (skipped == 0)
3075 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003076
3077 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003078}
3079#endif
3080
3081/*
3082 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003083 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084 * "len" is the length of "name", or -1 for NUL terminated.
3085 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003086 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087builtin_function(char_u *name, int len)
3088{
3089 char_u *p;
3090
Bram Moolenaara26b9702020-04-18 19:53:28 +02003091 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 return FALSE;
3093 p = vim_strchr(name, AUTOLOAD_CHAR);
3094 return p == NULL || (len > 0 && p > name + len);
3095}
3096
3097 int
3098func_call(
3099 char_u *name,
3100 typval_T *args,
3101 partial_T *partial,
3102 dict_T *selfdict,
3103 typval_T *rettv)
3104{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003105 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106 listitem_T *item;
3107 typval_T argv[MAX_FUNC_ARGS + 1];
3108 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 int r = 0;
3110
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003111 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003112 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 {
3114 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3115 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003116 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117 break;
3118 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003119 // Make a copy of each argument. This is needed to be able to set
3120 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121 copy_tv(&item->li_tv, &argv[argc++]);
3122 }
3123
3124 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003125 {
3126 funcexe_T funcexe;
3127
Bram Moolenaara80faa82020-04-12 19:37:17 +02003128 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003129 funcexe.fe_firstline = curwin->w_cursor.lnum;
3130 funcexe.fe_lastline = curwin->w_cursor.lnum;
3131 funcexe.fe_evaluate = TRUE;
3132 funcexe.fe_partial = partial;
3133 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003134 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3135 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136
Bram Moolenaare38eab22019-12-05 21:50:01 +01003137 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 while (argc > 0)
3139 clear_tv(&argv[--argc]);
3140
3141 return r;
3142}
3143
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003144static int callback_depth = 0;
3145
3146 int
3147get_callback_depth(void)
3148{
3149 return callback_depth;
3150}
3151
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003153 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003154 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003155 */
3156 int
3157call_callback(
3158 callback_T *callback,
3159 int len, // length of "name" or -1 to use strlen()
3160 typval_T *rettv, // return value goes here
3161 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003162 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003163 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003164{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003165 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003166 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003167
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003168 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3169 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003170 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003171 funcexe.fe_evaluate = TRUE;
3172 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003173 ++callback_depth;
3174 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3175 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003176
3177 // When a :def function was called that uses :try an error would be turned
3178 // into an exception. Need to give the error here.
3179 if (need_rethrow && current_exception != NULL)
3180 {
3181 need_rethrow = FALSE;
3182 handle_did_throw();
3183 }
3184
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003185 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003186}
3187
3188/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003189 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003190 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003191 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3192 */
3193 varnumber_T
3194call_callback_retnr(
3195 callback_T *callback,
3196 int argcount, // number of "argvars"
3197 typval_T *argvars) // vars for arguments, must have "argcount"
3198 // PLUS ONE elements!
3199{
3200 typval_T rettv;
3201 varnumber_T retval;
3202
3203 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003204 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003205
3206 retval = tv_get_number_chk(&rettv, NULL);
3207 clear_tv(&rettv);
3208 return retval;
3209}
3210
3211/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003212 * Give an error message for the result of a function.
3213 * Nothing if "error" is FCERR_NONE.
3214 */
3215 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003216user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003217{
3218 switch (error)
3219 {
3220 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003221 if (funcexe->fe_found_var)
3222 semsg(_(e_not_callable_type_str), name);
3223 else
3224 emsg_funcname(e_unknownfunc, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003225 break;
3226 case FCERR_NOTMETHOD:
3227 emsg_funcname(
3228 N_("E276: Cannot use function as a method: %s"), name);
3229 break;
3230 case FCERR_DELETED:
3231 emsg_funcname(N_(e_func_deleted), name);
3232 break;
3233 case FCERR_TOOMANY:
3234 emsg_funcname((char *)e_toomanyarg, name);
3235 break;
3236 case FCERR_TOOFEW:
3237 emsg_funcname((char *)e_toofewarg, name);
3238 break;
3239 case FCERR_SCRIPT:
3240 emsg_funcname(
3241 N_("E120: Using <SID> not in a script context: %s"), name);
3242 break;
3243 case FCERR_DICT:
3244 emsg_funcname(
3245 N_("E725: Calling dict function without Dictionary: %s"),
3246 name);
3247 break;
3248 }
3249}
3250
3251/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003253 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254 * Return FAIL when the function can't be called, OK otherwise.
3255 * Also returns OK when an error was encountered while executing the function.
3256 */
3257 int
3258call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003259 char_u *funcname, // name of the function
3260 int len, // length of "name" or -1 to use strlen()
3261 typval_T *rettv, // return value goes here
3262 int argcount_in, // number of "argvars"
3263 typval_T *argvars_in, // vars for arguments, must have "argcount"
3264 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003265 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003266{
3267 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003268 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003270 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271 char_u fname_buf[FLEN_FIXED + 1];
3272 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003273 char_u *fname = NULL;
3274 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 int argcount = argcount_in;
3276 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003277 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003278 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003279 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003281 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003282 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003283 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003285 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3286 // even when call_func() returns FAIL.
3287 rettv->v_type = VAR_UNKNOWN;
3288
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003289 if (partial != NULL)
3290 fp = partial->pt_func;
3291 if (fp == NULL)
3292 {
3293 // Make a copy of the name, if it comes from a funcref variable it
3294 // could be changed or deleted in the called function.
3295 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3296 if (name == NULL)
3297 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003298
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003299 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3300 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003301
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003302 if (funcexe->fe_doesrange != NULL)
3303 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304
3305 if (partial != NULL)
3306 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003307 // When the function has a partial with a dict and there is a dict
3308 // argument, use the dict argument. That is backwards compatible.
3309 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003310 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003312 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 {
3314 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003315 {
3316 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3317 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003318 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003319 goto theend;
3320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003322 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323 for (i = 0; i < argcount_in; ++i)
3324 argv[i + argv_clear] = argvars_in[i];
3325 argvars = argv;
3326 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003327
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003328 if (funcexe->fe_check_type != NULL
3329 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003330 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003331 // Now funcexe->fe_check_type is missing the added arguments,
3332 // make a copy of the type with the correction.
3333 check_type = *funcexe->fe_check_type;
3334 funcexe->fe_check_type = &check_type;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003335 check_type.tt_argcount += partial->pt_argc;
3336 check_type.tt_min_argcount += partial->pt_argc;
3337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 }
3339 }
3340
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003341 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3342 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003343 {
3344 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003345 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003346 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003347 error = FCERR_OTHER;
3348 }
3349
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003350 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 {
3352 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003353 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
Bram Moolenaar333894b2020-08-01 18:53:07 +02003355 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003356 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003357 {
3358 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003360 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003361
Bram Moolenaare38eab22019-12-05 21:50:01 +01003362 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003364 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003366 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 {
3368 /*
3369 * User defined function.
3370 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003371 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003372 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373
Bram Moolenaare38eab22019-12-05 21:50:01 +01003374 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 if (fp == NULL
3376 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003377 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 && !aborting())
3379 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003380 // executed an autocommand, search for the function again
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 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3385 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003386 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003387 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003389 if (fp == NULL)
3390 {
3391 char_u *p = untrans_function_name(rfname);
3392
3393 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003394 // Don't do this if the name starts with "s:".
3395 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003396 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003399 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003400 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003401#ifdef FEAT_LUA
3402 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3403 {
3404 cfunc_T cb = fp->uf_cb;
3405
3406 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3407 }
3408#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003409 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003411 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003412 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003413 argcount = funcexe->fe_argv_func(argcount, argvars,
3414 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003415
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003416 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003417 {
3418 // Method call: base->Method()
3419 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003420 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003421 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003422 argvars = argv;
3423 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003424 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003425
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003426 error = call_user_func_check(fp, argcount, argvars, rettv,
3427 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 }
3429 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003430 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003431 {
3432 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003433 * expr->method(): Find the method name in the table, call its
3434 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003435 */
3436 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003437 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 else
3440 {
3441 /*
3442 * Find the function name in the table, call its implementation.
3443 */
3444 error = call_internal_func(fname, argcount, argvars, rettv);
3445 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003446
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 /*
3448 * The function call (or "FuncUndefined" autocommand sequence) might
3449 * have been aborted by an error, an interrupt, or an explicitly thrown
3450 * exception that has not been caught so far. This situation can be
3451 * tested for by calling aborting(). For an error in an internal
3452 * function or for the "E132" error in call_user_func(), however, the
3453 * throw point at which the "force_abort" flag (temporarily reset by
3454 * emsg()) is normally updated has not been reached yet. We need to
3455 * update that flag first to make aborting() reliable.
3456 */
3457 update_force_abort();
3458 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003459 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 ret = OK;
3461
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003462theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 /*
3464 * Report an error unless the argument evaluation or function call has been
3465 * cancelled due to an aborting error, an interrupt, or an exception.
3466 */
3467 if (!aborting())
3468 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003469 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 }
3471
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003472 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003474 clear_tv(&argv[--argv_clear + argv_base]);
3475
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 vim_free(tofree);
3477 vim_free(name);
3478
3479 return ret;
3480}
3481
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003482 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003483printable_func_name(ufunc_T *fp)
3484{
3485 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3486}
3487
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003488/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003489 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 */
3491 static void
3492list_func_head(ufunc_T *fp, int indent)
3493{
3494 int j;
3495
3496 msg_start();
3497 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003498 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003499 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003500 msg_puts("def ");
3501 else
3502 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003503 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 msg_putchar('(');
3505 for (j = 0; j < fp->uf_args.ga_len; ++j)
3506 {
3507 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003508 msg_puts(", ");
3509 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003510 if (fp->uf_arg_types != NULL)
3511 {
3512 char *tofree;
3513
3514 msg_puts(": ");
3515 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3516 vim_free(tofree);
3517 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003518 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3519 {
3520 msg_puts(" = ");
3521 msg_puts(((char **)(fp->uf_def_args.ga_data))
3522 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3523 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003524 }
3525 if (fp->uf_varargs)
3526 {
3527 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003528 msg_puts(", ");
3529 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003531 if (fp->uf_va_name != NULL)
3532 {
3533 if (j)
3534 msg_puts(", ");
3535 msg_puts("...");
3536 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003537 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003538 {
3539 char *tofree;
3540
3541 msg_puts(": ");
3542 msg_puts(type_name(fp->uf_va_type, &tofree));
3543 vim_free(tofree);
3544 }
3545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003547
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003548 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003549 {
3550 if (fp->uf_ret_type != &t_void)
3551 {
3552 char *tofree;
3553
3554 msg_puts(": ");
3555 msg_puts(type_name(fp->uf_ret_type, &tofree));
3556 vim_free(tofree);
3557 }
3558 }
3559 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003560 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003562 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003564 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003565 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003566 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 msg_clr_eos();
3568 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003569 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570}
3571
3572/*
3573 * Get a function name, translating "<SID>" and "<SNR>".
3574 * Also handles a Funcref in a List or Dictionary.
3575 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003576 * Set "*is_global" to TRUE when the function must be global, unless
3577 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 * flags:
3579 * TFN_INT: internal function name OK
3580 * TFN_QUIET: be quiet
3581 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003582 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 * Advances "pp" to just after the function name (if no error).
3584 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003585 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586trans_function_name(
3587 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003588 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003589 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003591 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003592 partial_T **partial, // return: partial of a FuncRef
3593 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594{
3595 char_u *name = NULL;
3596 char_u *start;
3597 char_u *end;
3598 int lead;
3599 char_u sid_buf[20];
3600 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003601 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003603 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003604 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605
3606 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003607 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 start = *pp;
3609
Bram Moolenaare38eab22019-12-05 21:50:01 +01003610 // Check for hard coded <SNR>: already translated function ID (from a user
3611 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3613 && (*pp)[2] == (int)KE_SNR)
3614 {
3615 *pp += 3;
3616 len = get_id_len(pp) + 3;
3617 return vim_strnsave(start, len);
3618 }
3619
Bram Moolenaare38eab22019-12-05 21:50:01 +01003620 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3621 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 lead = eval_fname_script(start);
3623 if (lead > 2)
3624 start += lead;
3625
Bram Moolenaare38eab22019-12-05 21:50:01 +01003626 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003627 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 lead > 2 ? 0 : FNE_CHECK_START);
3629 if (end == start)
3630 {
3631 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003632 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 goto theend;
3634 }
3635 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3636 {
3637 /*
3638 * Report an invalid expression in braces, unless the expression
3639 * evaluation has been cancelled due to an aborting error, an
3640 * interrupt, or an exception.
3641 */
3642 if (!aborting())
3643 {
3644 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003645 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 }
3647 else
3648 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3649 goto theend;
3650 }
3651
3652 if (lv.ll_tv != NULL)
3653 {
3654 if (fdp != NULL)
3655 {
3656 fdp->fd_dict = lv.ll_dict;
3657 fdp->fd_newkey = lv.ll_newkey;
3658 lv.ll_newkey = NULL;
3659 fdp->fd_di = lv.ll_di;
3660 }
3661 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3662 {
3663 name = vim_strsave(lv.ll_tv->vval.v_string);
3664 *pp = end;
3665 }
3666 else if (lv.ll_tv->v_type == VAR_PARTIAL
3667 && lv.ll_tv->vval.v_partial != NULL)
3668 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003669 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 *pp = end;
3671 if (partial != NULL)
3672 *partial = lv.ll_tv->vval.v_partial;
3673 }
3674 else
3675 {
3676 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3677 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003678 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 else
3680 *pp = end;
3681 name = NULL;
3682 }
3683 goto theend;
3684 }
3685
3686 if (lv.ll_name == NULL)
3687 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003688 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 *pp = end;
3690 goto theend;
3691 }
3692
Bram Moolenaare38eab22019-12-05 21:50:01 +01003693 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 if (lv.ll_exp_name != NULL)
3695 {
3696 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003697 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003698 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 if (name == lv.ll_exp_name)
3700 name = NULL;
3701 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003702 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 {
3704 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003705 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003706 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 if (name == *pp)
3708 name = NULL;
3709 }
3710 if (name != NULL)
3711 {
3712 name = vim_strsave(name);
3713 *pp = end;
3714 if (STRNCMP(name, "<SNR>", 5) == 0)
3715 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003716 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 name[0] = K_SPECIAL;
3718 name[1] = KS_EXTRA;
3719 name[2] = (int)KE_SNR;
3720 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3721 }
3722 goto theend;
3723 }
3724
3725 if (lv.ll_exp_name != NULL)
3726 {
3727 len = (int)STRLEN(lv.ll_exp_name);
3728 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3729 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3730 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003731 // When there was "s:" already or the name expanded to get a
3732 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 lv.ll_name += 2;
3734 len -= 2;
3735 lead = 2;
3736 }
3737 }
3738 else
3739 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003740 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003742 {
3743 if (is_global != NULL && lv.ll_name[0] == 'g')
3744 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003745 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003746 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 len = (int)(end - lv.ll_name);
3748 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003749 if (len <= 0)
3750 {
3751 if (!skip)
3752 emsg(_(e_function_name));
3753 goto theend;
3754 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003756 // In Vim9 script a user function is script-local by default, unless it
3757 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003758 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003759 if (vim9script)
3760 {
3761 char_u *p;
3762
3763 // SomeScript#func() is a global function.
3764 for (p = start; *p != NUL && *p != '('; ++p)
3765 if (*p == AUTOLOAD_CHAR)
3766 vim9script = FALSE;
3767 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003768
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 /*
3770 * Copy the function name to allocated memory.
3771 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3772 * Accept <SNR>123_name() outside a script.
3773 */
3774 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003776 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 if (!vim9script)
3779 lead = 3;
3780 if (vim9script || (lv.ll_exp_name != NULL
3781 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 || eval_fname_sid(*pp))
3783 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003784 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003785 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003787 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 goto theend;
3789 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003790 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003791 if (vim9script)
3792 extra = 3 + (int)STRLEN(sid_buf);
3793 else
3794 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 }
3796 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003797 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3798 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003800 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 start);
3802 goto theend;
3803 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003804 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 {
3806 char_u *cp = vim_strchr(lv.ll_name, ':');
3807
3808 if (cp != NULL && cp < end)
3809 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003810 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 goto theend;
3812 }
3813 }
3814
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003815 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 if (name != NULL)
3817 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003818 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 {
3820 name[0] = K_SPECIAL;
3821 name[1] = KS_EXTRA;
3822 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003823 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 STRCPY(name + 3, sid_buf);
3825 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003826 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3827 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 }
3829 *pp = end;
3830
3831theend:
3832 clear_lval(&lv);
3833 return name;
3834}
3835
3836/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003837 * Assuming "name" is the result of trans_function_name() and it was prefixed
3838 * to use the script-local name, return the unmodified name (points into
3839 * "name"). Otherwise return NULL.
3840 * This can be used to first search for a script-local function and fall back
3841 * to the global function if not found.
3842 */
3843 char_u *
3844untrans_function_name(char_u *name)
3845{
3846 char_u *p;
3847
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003848 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003849 {
3850 p = vim_strchr(name, '_');
3851 if (p != NULL)
3852 return p + 1;
3853 }
3854 return NULL;
3855}
3856
3857/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003858 * Call trans_function_name(), except that a lambda is returned as-is.
3859 * Returns the name in allocated memory.
3860 */
3861 char_u *
3862save_function_name(
3863 char_u **name,
3864 int *is_global,
3865 int skip,
3866 int flags,
3867 funcdict_T *fudi)
3868{
3869 char_u *p = *name;
3870 char_u *saved;
3871
3872 if (STRNCMP(p, "<lambda>", 8) == 0)
3873 {
3874 p += 8;
3875 (void)getdigits(&p);
3876 saved = vim_strnsave(*name, p - *name);
3877 if (fudi != NULL)
3878 CLEAR_POINTER(fudi);
3879 }
3880 else
3881 saved = trans_function_name(&p, is_global, skip,
3882 flags, fudi, NULL, NULL);
3883 *name = p;
3884 return saved;
3885}
3886
3887/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003888 * List functions. When "regmatch" is NULL all of then.
3889 * Otherwise functions matching "regmatch".
3890 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003891 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003892list_functions(regmatch_T *regmatch)
3893{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003894 int changed = func_hashtab.ht_changed;
3895 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003896 hashitem_T *hi;
3897
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003898 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003899 {
3900 if (!HASHITEM_EMPTY(hi))
3901 {
3902 ufunc_T *fp = HI2UF(hi);
3903
3904 --todo;
3905 if ((fp->uf_flags & FC_DEAD) == 0
3906 && (regmatch == NULL
3907 ? !message_filtered(fp->uf_name)
3908 && !func_name_refcount(fp->uf_name)
3909 : !isdigit(*fp->uf_name)
3910 && vim_regexec(regmatch, fp->uf_name, 0)))
3911 {
3912 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003913 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003914 {
3915 emsg(_("E454: function list was modified"));
3916 return;
3917 }
3918 }
3919 }
3920 }
3921}
3922
3923/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003924 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003925 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3926 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003927 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003928 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003929 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003930define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003932 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 int j;
3934 int c;
3935 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003936 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003937 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 char_u *p;
3939 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003940 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 char_u *line_arg = NULL;
3942 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003943 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003944 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 garray_T newlines;
3946 int varargs = FALSE;
3947 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003948 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003949 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003950 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951 dictitem_T *v;
3952 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003953 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003956 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003957 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003958 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959
3960 /*
3961 * ":function" without argument: list functions.
3962 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003963 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 {
3965 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003966 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003967 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003968 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 }
3970
3971 /*
3972 * ":function /pat": list functions matching pattern.
3973 */
3974 if (*eap->arg == '/')
3975 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003976 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977 if (!eap->skip)
3978 {
3979 regmatch_T regmatch;
3980
3981 c = *p;
3982 *p = NUL;
3983 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3984 *p = c;
3985 if (regmatch.regprog != NULL)
3986 {
3987 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003988 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 vim_regfree(regmatch.regprog);
3990 }
3991 }
3992 if (*p == '/')
3993 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02003994 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003995 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 }
3997
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003998 ga_init(&newargs);
3999 ga_init(&argtypes);
4000 ga_init(&default_args);
4001
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 /*
4003 * Get the function name. There are these situations:
4004 * func normal function name
4005 * "name" == func, "fudi.fd_dict" == NULL
4006 * dict.func new dictionary entry
4007 * "name" == NULL, "fudi.fd_dict" set,
4008 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4009 * dict.func existing dict entry with a Funcref
4010 * "name" == func, "fudi.fd_dict" set,
4011 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4012 * dict.func existing dict entry that's not a Funcref
4013 * "name" == NULL, "fudi.fd_dict" set,
4014 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4015 * s:func script-local function name
4016 * g:func global function name, same as "func"
4017 */
4018 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004019 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004021 // nested function, argument is (args).
4022 paren = TRUE;
4023 CLEAR_FIELD(fudi);
4024 }
4025 else
4026 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004027 name = save_function_name(&p, &is_global, eap->skip,
4028 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004029 paren = (vim_strchr(p, '(') != NULL);
4030 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004032 /*
4033 * Return on an invalid expression in braces, unless the expression
4034 * evaluation has been cancelled due to an aborting error, an
4035 * interrupt, or an exception.
4036 */
4037 if (!aborting())
4038 {
4039 if (!eap->skip && fudi.fd_newkey != NULL)
4040 semsg(_(e_dictkey), fudi.fd_newkey);
4041 vim_free(fudi.fd_newkey);
4042 return NULL;
4043 }
4044 else
4045 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 }
4048
Bram Moolenaare38eab22019-12-05 21:50:01 +01004049 // An error in a function call during evaluation of an expression in magic
4050 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 saved_did_emsg = did_emsg;
4052 did_emsg = FALSE;
4053
4054 /*
4055 * ":function func" with only function name: list function.
4056 */
4057 if (!paren)
4058 {
4059 if (!ends_excmd(*skipwhite(p)))
4060 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004061 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 goto ret_free;
4063 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004064 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 if (eap->nextcmd != NULL)
4066 *p = NUL;
4067 if (!eap->skip && !got_int)
4068 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004069 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004070 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4071 {
4072 char_u *up = untrans_function_name(name);
4073
4074 // With Vim9 script the name was made script-local, if not
4075 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004076 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004077 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004078 }
4079
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 if (fp != NULL)
4081 {
4082 list_func_head(fp, TRUE);
4083 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4084 {
4085 if (FUNCLINE(fp, j) == NULL)
4086 continue;
4087 msg_putchar('\n');
4088 msg_outnum((long)(j + 1));
4089 if (j < 9)
4090 msg_putchar(' ');
4091 if (j < 99)
4092 msg_putchar(' ');
4093 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004094 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 ui_breakcheck();
4096 }
4097 if (!got_int)
4098 {
4099 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004100 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004101 msg_puts(" enddef");
4102 else
4103 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 }
4105 }
4106 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004107 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 }
4109 goto ret_free;
4110 }
4111
4112 /*
4113 * ":function name(arg1, arg2)" Define function.
4114 */
4115 p = skipwhite(p);
4116 if (*p != '(')
4117 {
4118 if (!eap->skip)
4119 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004120 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121 goto ret_free;
4122 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004123 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 if (vim_strchr(p, '(') != NULL)
4125 p = vim_strchr(p, '(');
4126 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004127
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004128 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4129 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004130 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004131 goto ret_free;
4132 }
4133
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004134 // In Vim9 script only global functions can be redefined.
4135 if (vim9script && eap->forceit && !is_global)
4136 {
4137 emsg(_(e_nobang));
4138 goto ret_free;
4139 }
4140
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004141 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142
Bram Moolenaar04b12692020-05-04 23:24:44 +02004143 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004144 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004145 // Check the name of the function. Unless it's a dictionary function
4146 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 if (name != NULL)
4148 arg = name;
4149 else
4150 arg = fudi.fd_newkey;
4151 if (arg != NULL && (fudi.fd_di == NULL
4152 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4153 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4154 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004155 char_u *name_base = arg;
4156 int i;
4157
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004159 {
4160 name_base = vim_strchr(arg, '_');
4161 if (name_base == NULL)
4162 name_base = arg + 3;
4163 else
4164 ++name_base;
4165 }
4166 for (i = 0; name_base[i] != NUL && (i == 0
4167 ? eval_isnamec1(name_base[i])
4168 : eval_isnamec(name_base[i])); ++i)
4169 ;
4170 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004172
4173 // In Vim9 script a function cannot have the same name as a
4174 // variable.
4175 if (vim9script && *arg == K_SPECIAL
4176 && eval_variable(name_base, STRLEN(name_base), NULL, NULL,
4177 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4178 + EVAL_VAR_NO_FUNC) == OK)
4179 {
4180 semsg(_(e_redefining_script_item_str), name_base);
4181 goto ret_free;
4182 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004184 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004186 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004187 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004188 goto ret_free;
4189 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 }
4191
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004192 // This may get more lines and make the pointers into the first line
4193 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004194 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004195 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004196 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004197 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004198 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004200 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004202 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004204 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004205 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004207 if (*p != ':')
4208 {
4209 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4210 p = skipwhite(p);
4211 }
4212 else if (!IS_WHITE_OR_NUL(p[1]))
4213 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004214 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004215 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004216 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004217 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004218 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004219 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004220 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004221 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004222 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004223 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004224 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004225 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004226 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004228 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004230 else
4231 // find extra arguments "range", "dict", "abort" and "closure"
4232 for (;;)
4233 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004234 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004235 p = skipwhite(p);
4236 if (STRNCMP(p, "range", 5) == 0)
4237 {
4238 flags |= FC_RANGE;
4239 p += 5;
4240 }
4241 else if (STRNCMP(p, "dict", 4) == 0)
4242 {
4243 flags |= FC_DICT;
4244 p += 4;
4245 }
4246 else if (STRNCMP(p, "abort", 5) == 0)
4247 {
4248 flags |= FC_ABORT;
4249 p += 5;
4250 }
4251 else if (STRNCMP(p, "closure", 7) == 0)
4252 {
4253 flags |= FC_CLOSURE;
4254 p += 7;
4255 if (current_funccal == NULL)
4256 {
4257 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4258 name == NULL ? (char_u *)"" : name);
4259 goto erret;
4260 }
4261 }
4262 else
4263 break;
4264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265
Bram Moolenaare38eab22019-12-05 21:50:01 +01004266 // When there is a line break use what follows for the function body.
4267 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 if (*p == '\n')
4269 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004270 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004271 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4272 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004273 && !(VIM_ISWHITE(*whitep) && *p == '#'
4274 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004275 && !eap->skip
4276 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004277 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278
4279 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004280 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4281 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 */
4283 if (KeyTyped)
4284 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004285 // Check if the function already exists, don't let the user type the
4286 // whole function before telling him it doesn't work! For a script we
4287 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288 if (!eap->skip && !eap->forceit)
4289 {
4290 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004291 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004292 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 emsg_funcname(e_funcexts, name);
4294 }
4295
4296 if (!eap->skip && did_emsg)
4297 goto erret;
4298
Bram Moolenaare38eab22019-12-05 21:50:01 +01004299 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 cmdline_row = msg_row;
4301 }
4302
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004303 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004304 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004305
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004306 // Do not define the function when getting the body fails and when
4307 // skipping.
4308 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4309 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 goto erret;
4311
4312 /*
4313 * If there are no errors, add the function
4314 */
4315 if (fudi.fd_dict == NULL)
4316 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004317 hashtab_T *ht;
4318
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004319 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4321 {
4322 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4323 name);
4324 goto erret;
4325 }
4326
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004327 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004328 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004330 char_u *uname = untrans_function_name(name);
4331
4332 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4333 }
4334
4335 if (fp != NULL || import != NULL)
4336 {
4337 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004338
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004339 // Function can be replaced with "function!" and when sourcing the
4340 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004341 // A name that is used by an import can not be overruled.
4342 if (import != NULL
4343 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004344 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004345 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004347 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004348 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004349 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004350 else
4351 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 goto erret;
4353 }
4354 if (fp->uf_calls > 0)
4355 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004356 emsg_funcname(
4357 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 name);
4359 goto erret;
4360 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004361 if (fp->uf_refcount > 1)
4362 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004363 // This function is referenced somewhere, don't redefine it but
4364 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004365 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004366 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004367 fp = NULL;
4368 overwrite = TRUE;
4369 }
4370 else
4371 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004372 char_u *exp_name = fp->uf_name_exp;
4373
4374 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004375 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004376 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004377 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004378 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004379 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004380#ifdef FEAT_PROFILE
4381 fp->uf_profiling = FALSE;
4382 fp->uf_prof_initialized = FALSE;
4383#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004384 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004385 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 }
4387 }
4388 else
4389 {
4390 char numbuf[20];
4391
4392 fp = NULL;
4393 if (fudi.fd_newkey == NULL && !eap->forceit)
4394 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004395 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 goto erret;
4397 }
4398 if (fudi.fd_di == NULL)
4399 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004400 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004401 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 goto erret;
4403 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004404 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004405 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406 goto erret;
4407
Bram Moolenaare38eab22019-12-05 21:50:01 +01004408 // Give the function a sequential number. Can only be used with a
4409 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 vim_free(name);
4411 sprintf(numbuf, "%d", ++func_nr);
4412 name = vim_strsave((char_u *)numbuf);
4413 if (name == NULL)
4414 goto erret;
4415 }
4416
4417 if (fp == NULL)
4418 {
4419 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4420 {
4421 int slen, plen;
4422 char_u *scriptname;
4423
Bram Moolenaare38eab22019-12-05 21:50:01 +01004424 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004426 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 {
4428 scriptname = autoload_name(name);
4429 if (scriptname != NULL)
4430 {
4431 p = vim_strchr(scriptname, '/');
4432 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004433 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004435 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 j = OK;
4437 vim_free(scriptname);
4438 }
4439 }
4440 if (j == FAIL)
4441 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004442 linenr_T save_lnum = SOURCING_LNUM;
4443
4444 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004445 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004446 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 goto erret;
4448 }
4449 }
4450
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004451 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 if (fp == NULL)
4453 goto erret;
4454
4455 if (fudi.fd_dict != NULL)
4456 {
4457 if (fudi.fd_di == NULL)
4458 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004459 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004460 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4461 if (fudi.fd_di == NULL)
4462 {
4463 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004464 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 goto erret;
4466 }
4467 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4468 {
4469 vim_free(fudi.fd_di);
4470 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004471 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 goto erret;
4473 }
4474 }
4475 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004476 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 clear_tv(&fudi.fd_di->di_tv);
4478 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480
Bram Moolenaare38eab22019-12-05 21:50:01 +01004481 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 flags |= FC_DICT;
4483 }
4484
Bram Moolenaare38eab22019-12-05 21:50:01 +01004485 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004486 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004487 if (overwrite)
4488 {
4489 hi = hash_find(&func_hashtab, name);
4490 hi->hi_key = UF2HIKEY(fp);
4491 }
4492 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493 {
4494 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004495 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496 goto erret;
4497 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004498 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 }
4500 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004501 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004502 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004503 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004504
4505 if (eap->cmdidx == CMD_def)
4506 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004507 int lnum_save = SOURCING_LNUM;
4508 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004509
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004510 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004511
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004512 // error messages are for the first function line
4513 SOURCING_LNUM = sourcing_lnum_top;
4514
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004515 // The function may use script variables from the context.
4516 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004517
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004518 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004519 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004520 SOURCING_LNUM = lnum_save;
4521 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004523 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004524
4525 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004526 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004527 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004528 SOURCING_LNUM = lnum_save;
4529 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004530 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004531 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004532 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004533 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004534 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004535
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004537 if ((flags & FC_CLOSURE) != 0)
4538 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004539 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004540 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004541 }
4542 else
4543 fp->uf_scoped = NULL;
4544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546 if (prof_def_func())
4547 func_do_profile(fp);
4548#endif
4549 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004550 if (sandbox)
4551 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004552 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004553 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 fp->uf_flags = flags;
4555 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004556 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004557 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004558 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004559 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004560 if (is_export)
4561 {
4562 fp->uf_flags |= FC_EXPORT;
4563 // let ex_export() know the export worked.
4564 is_export = FALSE;
4565 }
4566
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004567 if (eap->cmdidx == CMD_def)
4568 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004569 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4570 // :func does not use Vim9 script syntax, even in a Vim9 script file
4571 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004572
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 goto ret_free;
4574
4575erret:
4576 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004577 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004578 if (fp != NULL)
4579 {
4580 ga_init(&fp->uf_args);
4581 ga_init(&fp->uf_def_args);
4582 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583errret_2:
4584 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004585 if (fp != NULL)
4586 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004588 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004589 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004591 if (name != name_arg)
4592 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004593 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004595
4596 return fp;
4597}
4598
4599/*
4600 * ":function"
4601 */
4602 void
4603ex_function(exarg_T *eap)
4604{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004605 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004606}
4607
4608/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004609 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004610 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004611 */
4612 void
4613ex_defcompile(exarg_T *eap UNUSED)
4614{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004615 long todo = (long)func_hashtab.ht_used;
4616 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004617 hashitem_T *hi;
4618 ufunc_T *ufunc;
4619
4620 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4621 {
4622 if (!HASHITEM_EMPTY(hi))
4623 {
4624 --todo;
4625 ufunc = HI2UF(hi);
4626 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004627 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4628 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004629 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004630 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004631
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004632 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004633 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004634 // a function has been added or removed, need to start over
4635 todo = (long)func_hashtab.ht_used;
4636 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004637 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004638 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004639 }
4640 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004641 }
4642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004643}
4644
4645/*
4646 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4647 * Return 2 if "p" starts with "s:".
4648 * Return 0 otherwise.
4649 */
4650 int
4651eval_fname_script(char_u *p)
4652{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004653 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4654 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4656 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4657 return 5;
4658 if (p[0] == 's' && p[1] == ':')
4659 return 2;
4660 return 0;
4661}
4662
4663 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004664translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665{
4666 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004667 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004668 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004669}
4670
4671/*
4672 * Return TRUE when "ufunc" has old-style "..." varargs
4673 * or named varargs "...name: type".
4674 */
4675 int
4676has_varargs(ufunc_T *ufunc)
4677{
4678 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679}
4680
4681/*
4682 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004683 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 */
4685 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004686function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687{
4688 char_u *nm = name;
4689 char_u *p;
4690 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004691 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004692 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004694 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4695 if (no_deref)
4696 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004697 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698 nm = skipwhite(nm);
4699
Bram Moolenaare38eab22019-12-05 21:50:01 +01004700 // Only accept "funcname", "funcname ", "funcname (..." and
4701 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004703 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004704 vim_free(p);
4705 return n;
4706}
4707
Bram Moolenaar113e1072019-01-20 15:30:40 +01004708#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709 char_u *
4710get_expanded_name(char_u *name, int check)
4711{
4712 char_u *nm = name;
4713 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004714 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004716 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004717 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004719 if (p != NULL && *nm == NUL
4720 && (!check || translated_function_exists(p, is_global)))
4721 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722
4723 vim_free(p);
4724 return NULL;
4725}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004726#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728/*
4729 * Function given to ExpandGeneric() to obtain the list of user defined
4730 * function names.
4731 */
4732 char_u *
4733get_user_func_name(expand_T *xp, int idx)
4734{
4735 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004736 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004737 static hashitem_T *hi;
4738 ufunc_T *fp;
4739
4740 if (idx == 0)
4741 {
4742 done = 0;
4743 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004744 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004746 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747 {
4748 if (done++ > 0)
4749 ++hi;
4750 while (HASHITEM_EMPTY(hi))
4751 ++hi;
4752 fp = HI2UF(hi);
4753
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004754 // don't show dead, dict and lambda functions
4755 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004756 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004757 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004758
4759 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004760 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761
4762 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004763 if (xp->xp_context != EXPAND_USER_FUNC
4764 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 {
4766 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004767 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 STRCAT(IObuff, ")");
4769 }
4770 return IObuff;
4771 }
4772 return NULL;
4773}
4774
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775/*
4776 * ":delfunction {name}"
4777 */
4778 void
4779ex_delfunction(exarg_T *eap)
4780{
4781 ufunc_T *fp = NULL;
4782 char_u *p;
4783 char_u *name;
4784 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004785 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786
4787 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004788 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4789 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790 vim_free(fudi.fd_newkey);
4791 if (name == NULL)
4792 {
4793 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004794 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 return;
4796 }
4797 if (!ends_excmd(*skipwhite(p)))
4798 {
4799 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004800 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004801 return;
4802 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004803 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 if (eap->nextcmd != NULL)
4805 *p = NUL;
4806
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004807 if (isdigit(*name) && fudi.fd_dict == NULL)
4808 {
4809 if (!eap->skip)
4810 semsg(_(e_invarg2), eap->arg);
4811 vim_free(name);
4812 return;
4813 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004815 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816 vim_free(name);
4817
4818 if (!eap->skip)
4819 {
4820 if (fp == NULL)
4821 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004822 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004823 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824 return;
4825 }
4826 if (fp->uf_calls > 0)
4827 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004828 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 return;
4830 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004831 if (fp->uf_flags & FC_VIM9)
4832 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004833 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004834 return;
4835 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836
4837 if (fudi.fd_dict != NULL)
4838 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004839 // Delete the dict item that refers to the function, it will
4840 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4842 }
4843 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004844 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004845 // A normal function (not a numbered function or lambda) has a
4846 // refcount of 1 for the entry in the hashtable. When deleting
4847 // it and the refcount is more than one, it should be kept.
4848 // A numbered function and lambda should be kept if the refcount is
4849 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004850 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004851 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004852 // Function is still referenced somewhere. Don't free it but
4853 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004854 if (func_remove(fp))
4855 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004856 }
4857 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004858 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004859 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 }
4861}
4862
4863/*
4864 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004865 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866 */
4867 void
4868func_unref(char_u *name)
4869{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004870 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004871
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004872 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004874 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004875 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004877#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004878 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004880 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004881 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004882 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004883}
4884
4885/*
4886 * Unreference a Function: decrement the reference count and free it when it
4887 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004888 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004889 */
4890 void
4891func_ptr_unref(ufunc_T *fp)
4892{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004893 if (fp != NULL && (--fp->uf_refcount <= 0
4894 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4895 && fp->uf_partial->pt_refcount <= 1
4896 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004897 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004898 // Only delete it when it's not being used. Otherwise it's done
4899 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004900 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004901 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902 }
4903}
4904
4905/*
4906 * Count a reference to a Function.
4907 */
4908 void
4909func_ref(char_u *name)
4910{
4911 ufunc_T *fp;
4912
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004913 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004915 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004916 if (fp != NULL)
4917 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004919 // Only give an error for a numbered function.
4920 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004921 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004922}
4923
4924/*
4925 * Count a reference to a Function.
4926 */
4927 void
4928func_ptr_ref(ufunc_T *fp)
4929{
4930 if (fp != NULL)
4931 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932}
4933
4934/*
4935 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4936 * referenced from anywhere that is in use.
4937 */
4938 static int
4939can_free_funccal(funccall_T *fc, int copyID)
4940{
4941 return (fc->l_varlist.lv_copyID != copyID
4942 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004943 && fc->l_avars.dv_copyID != copyID
4944 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945}
4946
4947/*
4948 * ":return [expr]"
4949 */
4950 void
4951ex_return(exarg_T *eap)
4952{
4953 char_u *arg = eap->arg;
4954 typval_T rettv;
4955 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004956 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957
4958 if (current_funccal == NULL)
4959 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004960 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004961 return;
4962 }
4963
Bram Moolenaar844fb642021-10-23 13:32:30 +01004964 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004965 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4966
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967 if (eap->skip)
4968 ++emsg_skip;
4969
4970 eap->nextcmd = NULL;
4971 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004972 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973 {
4974 if (!eap->skip)
4975 returning = do_return(eap, FALSE, TRUE, &rettv);
4976 else
4977 clear_tv(&rettv);
4978 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004979 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980 else if (!eap->skip)
4981 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004982 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004983 update_force_abort();
4984
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 /*
4986 * Return unless the expression evaluation has been cancelled due to an
4987 * aborting error, an interrupt, or an exception.
4988 */
4989 if (!aborting())
4990 returning = do_return(eap, FALSE, TRUE, NULL);
4991 }
4992
Bram Moolenaare38eab22019-12-05 21:50:01 +01004993 // When skipping or the return gets pending, advance to the next command
4994 // in this line (!returning). Otherwise, ignore the rest of the line.
4995 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996 if (returning)
4997 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004998 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02004999 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000
5001 if (eap->skip)
5002 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005003 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004}
5005
5006/*
5007 * ":1,25call func(arg1, arg2)" function call.
5008 */
5009 void
5010ex_call(exarg_T *eap)
5011{
5012 char_u *arg = eap->arg;
5013 char_u *startarg;
5014 char_u *name;
5015 char_u *tofree;
5016 int len;
5017 typval_T rettv;
5018 linenr_T lnum;
5019 int doesrange;
5020 int failed = FALSE;
5021 funcdict_T fudi;
5022 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005023 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005024 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005025 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026
Bram Moolenaare6b53242020-07-01 17:28:33 +02005027 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 if (eap->skip)
5029 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005030 // trans_function_name() doesn't work well when skipping, use eval0()
5031 // instead to skip to any following command, e.g. for:
5032 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005033 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005034 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035 clear_tv(&rettv);
5036 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005037 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005038 return;
5039 }
5040
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005041 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5042 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005043 if (fudi.fd_newkey != NULL)
5044 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005045 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005046 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 vim_free(fudi.fd_newkey);
5048 }
5049 if (tofree == NULL)
5050 return;
5051
Bram Moolenaare38eab22019-12-05 21:50:01 +01005052 // Increase refcount on dictionary, it could get deleted when evaluating
5053 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005054 if (fudi.fd_dict != NULL)
5055 ++fudi.fd_dict->dv_refcount;
5056
Bram Moolenaare38eab22019-12-05 21:50:01 +01005057 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5058 // contents. For VAR_PARTIAL get its partial, unless we already have one
5059 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005061 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005062 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063
Bram Moolenaare38eab22019-12-05 21:50:01 +01005064 // Skip white space to allow ":call func ()". Not good, but required for
5065 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005066 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 if (*startarg != '(')
5068 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005069 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070 goto end;
5071 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005072 if (in_vim9script() && startarg > arg)
5073 {
5074 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5075 goto end;
5076 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005077
5078 /*
5079 * When skipping, evaluate the function once, to find the end of the
5080 * arguments.
5081 * When the function takes a range, this is discovered after the first
5082 * call, and the loop is broken.
5083 */
5084 if (eap->skip)
5085 {
5086 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005087 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005088 }
5089 else
5090 lnum = eap->line1;
5091 for ( ; lnum <= eap->line2; ++lnum)
5092 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005093 funcexe_T funcexe;
5094
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005095 if (!eap->skip && eap->addr_count > 0)
5096 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005097 if (lnum > curbuf->b_ml.ml_line_count)
5098 {
5099 // If the function deleted lines or switched to another buffer
5100 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005101 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005102 break;
5103 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104 curwin->w_cursor.lnum = lnum;
5105 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005107 }
5108 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005109
Bram Moolenaara80faa82020-04-12 19:37:17 +02005110 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005111 funcexe.fe_firstline = eap->line1;
5112 funcexe.fe_lastline = eap->line2;
5113 funcexe.fe_doesrange = &doesrange;
5114 funcexe.fe_evaluate = !eap->skip;
5115 funcexe.fe_partial = partial;
5116 funcexe.fe_selfdict = fudi.fd_dict;
5117 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005118 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005119 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005120 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005121 {
5122 failed = TRUE;
5123 break;
5124 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005125 if (has_watchexpr())
5126 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005128 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005129 if (handle_subscript(&arg, &rettv,
5130 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005131 {
5132 failed = TRUE;
5133 break;
5134 }
5135
5136 clear_tv(&rettv);
5137 if (doesrange || eap->skip)
5138 break;
5139
Bram Moolenaare38eab22019-12-05 21:50:01 +01005140 // Stop when immediately aborting on error, or when an interrupt
5141 // occurred or an exception was thrown but not caught.
5142 // get_func_tv() returned OK, so that the check for trailing
5143 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005144 if (aborting())
5145 break;
5146 }
5147 if (eap->skip)
5148 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005149 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150
Bram Moolenaar1d341892021-09-18 15:25:52 +02005151 // When inside :try we need to check for following "| catch" or "| endtry".
5152 // Not when there was an error, but do check if an exception was thrown.
5153 if ((!aborting() || did_throw)
5154 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005156 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005157 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005158 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005160 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005161 {
5162 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005163 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005164 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165 }
5166 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005167 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 }
5169
5170end:
5171 dict_unref(fudi.fd_dict);
5172 vim_free(tofree);
5173}
5174
5175/*
5176 * Return from a function. Possibly makes the return pending. Also called
5177 * for a pending return at the ":endtry" or after returning from an extra
5178 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5179 * when called due to a ":return" command. "rettv" may point to a typval_T
5180 * with the return rettv. Returns TRUE when the return can be carried out,
5181 * FALSE when the return gets pending.
5182 */
5183 int
5184do_return(
5185 exarg_T *eap,
5186 int reanimate,
5187 int is_cmd,
5188 void *rettv)
5189{
5190 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005191 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192
5193 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005194 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005195 current_funccal->returned = FALSE;
5196
5197 /*
5198 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5199 * not in its finally clause (which then is to be executed next) is found.
5200 * In this case, make the ":return" pending for execution at the ":endtry".
5201 * Otherwise, return normally.
5202 */
5203 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5204 if (idx >= 0)
5205 {
5206 cstack->cs_pending[idx] = CSTP_RETURN;
5207
5208 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005209 // A pending return again gets pending. "rettv" points to an
5210 // allocated variable with the rettv of the original ":return"'s
5211 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 cstack->cs_rettv[idx] = rettv;
5213 else
5214 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005215 // When undoing a return in order to make it pending, get the stored
5216 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005217 if (reanimate)
5218 rettv = current_funccal->rettv;
5219
5220 if (rettv != NULL)
5221 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005222 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5224 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5225 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005226 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005227 }
5228 else
5229 cstack->cs_rettv[idx] = NULL;
5230
5231 if (reanimate)
5232 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005233 // The pending return value could be overwritten by a ":return"
5234 // without argument in a finally clause; reset the default
5235 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 current_funccal->rettv->v_type = VAR_NUMBER;
5237 current_funccal->rettv->vval.v_number = 0;
5238 }
5239 }
5240 report_make_pending(CSTP_RETURN, rettv);
5241 }
5242 else
5243 {
5244 current_funccal->returned = TRUE;
5245
Bram Moolenaare38eab22019-12-05 21:50:01 +01005246 // If the return is carried out now, store the return value. For
5247 // a return immediately after reanimation, the value is already
5248 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249 if (!reanimate && rettv != NULL)
5250 {
5251 clear_tv(current_funccal->rettv);
5252 *current_funccal->rettv = *(typval_T *)rettv;
5253 if (!is_cmd)
5254 vim_free(rettv);
5255 }
5256 }
5257
5258 return idx < 0;
5259}
5260
5261/*
5262 * Free the variable with a pending return value.
5263 */
5264 void
5265discard_pending_return(void *rettv)
5266{
5267 free_tv((typval_T *)rettv);
5268}
5269
5270/*
5271 * Generate a return command for producing the value of "rettv". The result
5272 * is an allocated string. Used by report_pending() for verbose messages.
5273 */
5274 char_u *
5275get_return_cmd(void *rettv)
5276{
5277 char_u *s = NULL;
5278 char_u *tofree = NULL;
5279 char_u numbuf[NUMBUFLEN];
5280
5281 if (rettv != NULL)
5282 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5283 if (s == NULL)
5284 s = (char_u *)"";
5285
5286 STRCPY(IObuff, ":return ");
5287 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5288 if (STRLEN(s) + 8 >= IOSIZE)
5289 STRCPY(IObuff + IOSIZE - 4, "...");
5290 vim_free(tofree);
5291 return vim_strsave(IObuff);
5292}
5293
5294/*
5295 * Get next function line.
5296 * Called by do_cmdline() to get the next line.
5297 * Returns allocated string, or NULL for end of function.
5298 */
5299 char_u *
5300get_func_line(
5301 int c UNUSED,
5302 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005303 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005304 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005305{
5306 funccall_T *fcp = (funccall_T *)cookie;
5307 ufunc_T *fp = fcp->func;
5308 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005309 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005310
Bram Moolenaare38eab22019-12-05 21:50:01 +01005311 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 if (fcp->dbg_tick != debug_tick)
5313 {
5314 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005315 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316 fcp->dbg_tick = debug_tick;
5317 }
5318#ifdef FEAT_PROFILE
5319 if (do_profiling == PROF_YES)
5320 func_line_end(cookie);
5321#endif
5322
5323 gap = &fp->uf_lines;
5324 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5325 || fcp->returned)
5326 retval = NULL;
5327 else
5328 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005329 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005330 while (fcp->linenr < gap->ga_len
5331 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5332 ++fcp->linenr;
5333 if (fcp->linenr >= gap->ga_len)
5334 retval = NULL;
5335 else
5336 {
5337 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005338 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339#ifdef FEAT_PROFILE
5340 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005341 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342#endif
5343 }
5344 }
5345
Bram Moolenaare38eab22019-12-05 21:50:01 +01005346 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005347 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005349 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005350 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005352 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005353 fcp->dbg_tick = debug_tick;
5354 }
5355
5356 return retval;
5357}
5358
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359/*
5360 * Return TRUE if the currently active function should be ended, because a
5361 * return was encountered or an error occurred. Used inside a ":while".
5362 */
5363 int
5364func_has_ended(void *cookie)
5365{
5366 funccall_T *fcp = (funccall_T *)cookie;
5367
Bram Moolenaare38eab22019-12-05 21:50:01 +01005368 // Ignore the "abort" flag if the abortion behavior has been changed due to
5369 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005370 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5371 || fcp->returned);
5372}
5373
5374/*
5375 * return TRUE if cookie indicates a function which "abort"s on errors.
5376 */
5377 int
5378func_has_abort(
5379 void *cookie)
5380{
5381 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5382}
5383
5384
5385/*
5386 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5387 * Don't do this when "Func" is already a partial that was bound
5388 * explicitly (pt_auto is FALSE).
5389 * Changes "rettv" in-place.
5390 * Returns the updated "selfdict_in".
5391 */
5392 dict_T *
5393make_partial(dict_T *selfdict_in, typval_T *rettv)
5394{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005395 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396 char_u *tofree = NULL;
5397 ufunc_T *fp;
5398 char_u fname_buf[FLEN_FIXED + 1];
5399 int error;
5400 dict_T *selfdict = selfdict_in;
5401
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005402 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5403 fp = rettv->vval.v_partial->pt_func;
5404 else
5405 {
5406 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5407 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005408 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005409 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005410 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005411 vim_free(tofree);
5412 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005413
5414 if (fp != NULL && (fp->uf_flags & FC_DICT))
5415 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005416 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005417
5418 if (pt != NULL)
5419 {
5420 pt->pt_refcount = 1;
5421 pt->pt_dict = selfdict;
5422 pt->pt_auto = TRUE;
5423 selfdict = NULL;
5424 if (rettv->v_type == VAR_FUNC)
5425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005426 // Just a function: Take over the function name and use
5427 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005428 pt->pt_name = rettv->vval.v_string;
5429 }
5430 else
5431 {
5432 partial_T *ret_pt = rettv->vval.v_partial;
5433 int i;
5434
Bram Moolenaare38eab22019-12-05 21:50:01 +01005435 // Partial: copy the function name, use selfdict and copy
5436 // args. Can't take over name or args, the partial might
5437 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005438 if (ret_pt->pt_name != NULL)
5439 {
5440 pt->pt_name = vim_strsave(ret_pt->pt_name);
5441 func_ref(pt->pt_name);
5442 }
5443 else
5444 {
5445 pt->pt_func = ret_pt->pt_func;
5446 func_ptr_ref(pt->pt_func);
5447 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005448 if (ret_pt->pt_argc > 0)
5449 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005450 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005451 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005452 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 pt->pt_argc = 0;
5454 else
5455 {
5456 pt->pt_argc = ret_pt->pt_argc;
5457 for (i = 0; i < pt->pt_argc; i++)
5458 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5459 }
5460 }
5461 partial_unref(ret_pt);
5462 }
5463 rettv->v_type = VAR_PARTIAL;
5464 rettv->vval.v_partial = pt;
5465 }
5466 }
5467 return selfdict;
5468}
5469
5470/*
5471 * Return the name of the executed function.
5472 */
5473 char_u *
5474func_name(void *cookie)
5475{
5476 return ((funccall_T *)cookie)->func->uf_name;
5477}
5478
5479/*
5480 * Return the address holding the next breakpoint line for a funccall cookie.
5481 */
5482 linenr_T *
5483func_breakpoint(void *cookie)
5484{
5485 return &((funccall_T *)cookie)->breakpoint;
5486}
5487
5488/*
5489 * Return the address holding the debug tick for a funccall cookie.
5490 */
5491 int *
5492func_dbg_tick(void *cookie)
5493{
5494 return &((funccall_T *)cookie)->dbg_tick;
5495}
5496
5497/*
5498 * Return the nesting level for a funccall cookie.
5499 */
5500 int
5501func_level(void *cookie)
5502{
5503 return ((funccall_T *)cookie)->level;
5504}
5505
5506/*
5507 * Return TRUE when a function was ended by a ":return" command.
5508 */
5509 int
5510current_func_returned(void)
5511{
5512 return current_funccal->returned;
5513}
5514
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515 int
5516free_unref_funccal(int copyID, int testing)
5517{
5518 int did_free = FALSE;
5519 int did_free_funccal = FALSE;
5520 funccall_T *fc, **pfc;
5521
5522 for (pfc = &previous_funccal; *pfc != NULL; )
5523 {
5524 if (can_free_funccal(*pfc, copyID))
5525 {
5526 fc = *pfc;
5527 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005528 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005529 did_free = TRUE;
5530 did_free_funccal = TRUE;
5531 }
5532 else
5533 pfc = &(*pfc)->caller;
5534 }
5535 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005536 // When a funccal was freed some more items might be garbage
5537 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005538 (void)garbage_collect(testing);
5539
5540 return did_free;
5541}
5542
5543/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005544 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005545 */
5546 static funccall_T *
5547get_funccal(void)
5548{
5549 int i;
5550 funccall_T *funccal;
5551 funccall_T *temp_funccal;
5552
5553 funccal = current_funccal;
5554 if (debug_backtrace_level > 0)
5555 {
5556 for (i = 0; i < debug_backtrace_level; i++)
5557 {
5558 temp_funccal = funccal->caller;
5559 if (temp_funccal)
5560 funccal = temp_funccal;
5561 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005562 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005563 debug_backtrace_level = i;
5564 }
5565 }
5566 return funccal;
5567}
5568
5569/*
5570 * Return the hashtable used for local variables in the current funccal.
5571 * Return NULL if there is no current funccal.
5572 */
5573 hashtab_T *
5574get_funccal_local_ht()
5575{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005576 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 return NULL;
5578 return &get_funccal()->l_vars.dv_hashtab;
5579}
5580
5581/*
5582 * Return the l: scope variable.
5583 * Return NULL if there is no current funccal.
5584 */
5585 dictitem_T *
5586get_funccal_local_var()
5587{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005588 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005589 return NULL;
5590 return &get_funccal()->l_vars_var;
5591}
5592
5593/*
5594 * Return the hashtable used for argument in the current funccal.
5595 * Return NULL if there is no current funccal.
5596 */
5597 hashtab_T *
5598get_funccal_args_ht()
5599{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005600 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005601 return NULL;
5602 return &get_funccal()->l_avars.dv_hashtab;
5603}
5604
5605/*
5606 * Return the a: scope variable.
5607 * Return NULL if there is no current funccal.
5608 */
5609 dictitem_T *
5610get_funccal_args_var()
5611{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005612 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005613 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005614 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005615}
5616
5617/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005618 * List function variables, if there is a function.
5619 */
5620 void
5621list_func_vars(int *first)
5622{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005623 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005624 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005625 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005626}
5627
5628/*
5629 * If "ht" is the hashtable for local variables in the current funccal, return
5630 * the dict that contains it.
5631 * Otherwise return NULL.
5632 */
5633 dict_T *
5634get_current_funccal_dict(hashtab_T *ht)
5635{
5636 if (current_funccal != NULL
5637 && ht == &current_funccal->l_vars.dv_hashtab)
5638 return &current_funccal->l_vars;
5639 return NULL;
5640}
5641
5642/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005643 * Search hashitem in parent scope.
5644 */
5645 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005646find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005647{
5648 funccall_T *old_current_funccal = current_funccal;
5649 hashtab_T *ht;
5650 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005651 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005652
5653 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5654 return NULL;
5655
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005656 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005657 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005658 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005659 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005660 ht = find_var_ht(name, &varname);
5661 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005662 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005663 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005664 if (!HASHITEM_EMPTY(hi))
5665 {
5666 *pht = ht;
5667 break;
5668 }
5669 }
5670 if (current_funccal == current_funccal->func->uf_scoped)
5671 break;
5672 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005673 }
5674 current_funccal = old_current_funccal;
5675
5676 return hi;
5677}
5678
5679/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005680 * Search variable in parent scope.
5681 */
5682 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005683find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005684{
5685 dictitem_T *v = NULL;
5686 funccall_T *old_current_funccal = current_funccal;
5687 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005688 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005689
5690 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5691 return NULL;
5692
Bram Moolenaare38eab22019-12-05 21:50:01 +01005693 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005694 current_funccal = current_funccal->func->uf_scoped;
5695 while (current_funccal)
5696 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005697 ht = find_var_ht(name, &varname);
5698 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005699 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005700 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005701 if (v != NULL)
5702 break;
5703 }
5704 if (current_funccal == current_funccal->func->uf_scoped)
5705 break;
5706 current_funccal = current_funccal->func->uf_scoped;
5707 }
5708 current_funccal = old_current_funccal;
5709
5710 return v;
5711}
5712
5713/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005714 * Set "copyID + 1" in previous_funccal and callers.
5715 */
5716 int
5717set_ref_in_previous_funccal(int copyID)
5718{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005719 funccall_T *fc;
5720
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005721 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005722 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005723 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005724 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5725 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5726 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5727 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005728 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005729 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005730}
5731
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005732 static int
5733set_ref_in_funccal(funccall_T *fc, int copyID)
5734{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005735 if (fc->fc_copyID != copyID)
5736 {
5737 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005738 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5739 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5740 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5741 || set_ref_in_func(NULL, fc->func, copyID))
5742 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005743 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005744 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005745}
5746
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005747/*
5748 * Set "copyID" in all local vars and arguments in the call stack.
5749 */
5750 int
5751set_ref_in_call_stack(int copyID)
5752{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005753 funccall_T *fc;
5754 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005755
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005756 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5757 if (set_ref_in_funccal(fc, copyID))
5758 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005759
5760 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005761 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5762 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5763 if (set_ref_in_funccal(fc, copyID))
5764 return TRUE;
5765 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005766}
5767
5768/*
5769 * Set "copyID" in all functions available by name.
5770 */
5771 int
5772set_ref_in_functions(int copyID)
5773{
5774 int todo;
5775 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005776 ufunc_T *fp;
5777
5778 todo = (int)func_hashtab.ht_used;
5779 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005780 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005781 if (!HASHITEM_EMPTY(hi))
5782 {
5783 --todo;
5784 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005785 if (!func_name_refcount(fp->uf_name)
5786 && set_ref_in_func(NULL, fp, copyID))
5787 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005788 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005789 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005790 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005791}
5792
5793/*
5794 * Set "copyID" in all function arguments.
5795 */
5796 int
5797set_ref_in_func_args(int copyID)
5798{
5799 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005800
5801 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005802 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5803 copyID, NULL, NULL))
5804 return TRUE;
5805 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005806}
5807
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005808/*
5809 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005810 * Returns TRUE if setting references failed somehow.
5811 */
5812 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005813set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005814{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005815 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005816 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005817 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005818 char_u fname_buf[FLEN_FIXED + 1];
5819 char_u *tofree = NULL;
5820 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005821 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005822
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005823 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005824 return FALSE;
5825
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005826 if (fp_in == NULL)
5827 {
5828 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005829 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005830 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005831 if (fp != NULL)
5832 {
5833 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005834 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005835 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005836
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005837 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005838 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005839}
5840
Bram Moolenaare38eab22019-12-05 21:50:01 +01005841#endif // FEAT_EVAL