blob: 0fca23afcef620380234a0df93ae467b9c63f421 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000526 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
622function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623{
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643}
644
645/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200647 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
652get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657{
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664#define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200666 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100675 char_u *heredoc_trimmed = NULL;
676
Bram Moolenaar20677332021-06-06 17:02:53 +0200677 ga_init2(&heredoc_ga, 1, 500);
678
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
723 vim_free(*line_to_free);
724 if (eap->getline == NULL)
725 theline = getcmdline(':', 0L, indent, getline_options);
726 else
727 theline = eap->getline(':', eap->cookie, indent,
728 getline_options);
729 *line_to_free = theline;
730 }
731 if (KeyTyped)
732 lines_left = Rows - 1;
733 if (theline == NULL)
734 {
735 // Use the start of the function for the line number.
736 SOURCING_LNUM = sourcing_lnum_top;
737 if (skip_until != NULL)
738 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200739 else if (nesting_inline[nesting])
740 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100741 else if (eap->cmdidx == CMD_def)
742 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100743 else
744 emsg(_("E126: Missing :endfunction"));
745 goto theend;
746 }
747
748 // Detect line continuation: SOURCING_LNUM increased more than one.
749 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
750 if (SOURCING_LNUM < sourcing_lnum_off)
751 sourcing_lnum_off -= SOURCING_LNUM;
752 else
753 sourcing_lnum_off = 0;
754
755 if (skip_until != NULL)
756 {
757 // Don't check for ":endfunc"/":enddef" between
758 // * ":append" and "."
759 // * ":python <<EOF" and "EOF"
760 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
761 if (heredoc_trimmed == NULL
762 || (is_heredoc && skipwhite(theline) == theline)
763 || STRNCMP(theline, heredoc_trimmed,
764 STRLEN(heredoc_trimmed)) == 0)
765 {
766 if (heredoc_trimmed == NULL)
767 p = theline;
768 else if (is_heredoc)
769 p = skipwhite(theline) == theline
770 ? theline : theline + STRLEN(heredoc_trimmed);
771 else
772 p = theline + STRLEN(heredoc_trimmed);
773 if (STRCMP(p, skip_until) == 0)
774 {
775 VIM_CLEAR(skip_until);
776 VIM_CLEAR(heredoc_trimmed);
777 getline_options = vim9_function
778 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
779 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200780
781 if (heredoc_concat_len > 0)
782 {
783 // Replace the starting line with all the concatenated
784 // lines.
785 ga_concat(&heredoc_ga, theline);
786 vim_free(((char_u **)(newlines->ga_data))[
787 heredoc_concat_len - 1]);
788 ((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1] = heredoc_ga.ga_data;
790 ga_init(&heredoc_ga);
791 heredoc_concat_len = 0;
792 theline += STRLEN(theline); // skip the "EOF"
793 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 }
795 }
796 }
797 else
798 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200799 int c;
800 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100801
802 // skip ':' and blanks
803 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
804 ;
805
806 // Check for "endfunction", "enddef" or "}".
807 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200808 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100809 ? *p == '}'
810 : (checkforcmd(&p, nesting_def[nesting]
811 ? "enddef" : "endfunction", 4)
812 && *p != ':'))
813 {
814 if (nesting-- == 0)
815 {
816 char_u *nextcmd = NULL;
817
818 if (*p == '|' || *p == '}')
819 nextcmd = p + 1;
820 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
821 nextcmd = line_arg;
822 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100823 && (vim9_function || p_verbose > 0))
824 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200825 SOURCING_LNUM = sourcing_lnum_top
826 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100827 if (eap->cmdidx == CMD_def)
828 semsg(_(e_text_found_after_enddef_str), p);
829 else
830 give_warning2((char_u *)
831 _("W22: Text found after :endfunction: %s"),
832 p, TRUE);
833 }
834 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100835 {
836 // Another command follows. If the line came from "eap"
837 // we can simply point into it, otherwise we need to
838 // change "eap->cmdlinep".
839 eap->nextcmd = nextcmd;
840 if (*line_to_free != NULL)
841 {
842 vim_free(*eap->cmdlinep);
843 *eap->cmdlinep = *line_to_free;
844 *line_to_free = NULL;
845 }
846 }
847 break;
848 }
849 }
850
851 // Check for mismatched "endfunc" or "enddef".
852 // We don't check for "def" inside "func" thus we also can't check
853 // for "enddef".
854 // We continue to find the end of the function, although we might
855 // not find it.
856 else if (nesting_def[nesting])
857 {
858 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
859 emsg(_(e_mismatched_endfunction));
860 }
861 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
862 emsg(_(e_mismatched_enddef));
863
864 // Increase indent inside "if", "while", "for" and "try", decrease
865 // at "end".
866 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
867 indent -= 2;
868 else if (STRNCMP(p, "if", 2) == 0
869 || STRNCMP(p, "wh", 2) == 0
870 || STRNCMP(p, "for", 3) == 0
871 || STRNCMP(p, "try", 3) == 0)
872 indent += 2;
873
874 // Check for defining a function inside this function.
875 // Only recognize "def" inside "def", not inside "function",
876 // For backwards compatibility, see Test_function_python().
877 c = *p;
878 if (is_function_cmd(&p)
879 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
880 {
881 if (*p == '!')
882 p = skipwhite(p + 1);
883 p += eval_fname_script(p);
884 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
885 NULL, NULL));
886 if (*skipwhite(p) == '(')
887 {
888 if (nesting == MAX_FUNC_NESTING - 1)
889 emsg(_(e_function_nesting_too_deep));
890 else
891 {
892 ++nesting;
893 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200894 nesting_inline[nesting] = FALSE;
895 indent += 2;
896 }
897 }
898 }
899
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200900 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200901 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200902 // Not a comment line: check for nested inline function.
903 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200904 while (end > p && VIM_ISWHITE(*end))
905 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200906 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200907 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200908 int is_block;
909
910 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200911 --end;
912 while (end > p && VIM_ISWHITE(*end))
913 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200914 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
915 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200916 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200917 char_u *s = p;
918
919 // check for line starting with "au" for :autocmd or
920 // "com" for :command, these can use a {} block
921 is_block = checkforcmd_noparen(&s, "autocmd", 2)
922 || checkforcmd_noparen(&s, "command", 3);
923 }
924
925 if (is_block)
926 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting == MAX_FUNC_NESTING - 1)
928 emsg(_(e_function_nesting_too_deep));
929 else
930 {
931 ++nesting;
932 nesting_def[nesting] = TRUE;
933 nesting_inline[nesting] = TRUE;
934 indent += 2;
935 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100936 }
937 }
938 }
939
940 // Check for ":append", ":change", ":insert". Not for :def.
941 p = skip_range(p, FALSE, NULL);
942 if (!vim9_function
943 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
944 || (p[0] == 'c'
945 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
946 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
947 && (STRNCMP(&p[3], "nge", 3) != 0
948 || !ASCII_ISALPHA(p[6])))))))
949 || (p[0] == 'i'
950 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
951 && (!ASCII_ISALPHA(p[2])
952 || (p[2] == 's'
953 && (!ASCII_ISALPHA(p[3])
954 || p[3] == 'e'))))))))
955 skip_until = vim_strsave((char_u *)".");
956
957 // Check for ":python <<EOF", ":tcl <<EOF", etc.
958 arg = skipwhite(skiptowhite(p));
959 if (arg[0] == '<' && arg[1] =='<'
960 && ((p[0] == 'p' && p[1] == 'y'
961 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
962 || ((p[2] == '3' || p[2] == 'x')
963 && !ASCII_ISALPHA(p[3]))))
964 || (p[0] == 'p' && p[1] == 'e'
965 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
966 || (p[0] == 't' && p[1] == 'c'
967 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
968 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
969 && !ASCII_ISALPHA(p[3]))
970 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
971 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
972 || (p[0] == 'm' && p[1] == 'z'
973 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
974 ))
975 {
976 // ":python <<" continues until a dot, like ":append"
977 p = skipwhite(arg + 2);
978 if (STRNCMP(p, "trim", 4) == 0)
979 {
980 // Ignore leading white space.
981 p = skipwhite(p + 4);
982 heredoc_trimmed = vim_strnsave(theline,
983 skipwhite(theline) - theline);
984 }
985 if (*p == NUL)
986 skip_until = vim_strsave((char_u *)".");
987 else
988 skip_until = vim_strnsave(p, skiptowhite(p) - p);
989 getline_options = GETLINE_NONE;
990 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200991 if (eap->cmdidx == CMD_def)
992 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 }
994
995 // Check for ":cmd v =<< [trim] EOF"
996 // and ":cmd [a, b] =<< [trim] EOF"
997 // and "lines =<< [trim] EOF" for Vim9
998 // Where "cmd" can be "let", "var", "final" or "const".
999 arg = skipwhite(skiptowhite(p));
1000 if (*arg == '[')
1001 arg = vim_strchr(arg, ']');
1002 if (arg != NULL)
1003 {
1004 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1005 && arg[1] == '<' && arg[2] =='<');
1006
1007 if (!found)
1008 // skip over the argument after "cmd"
1009 arg = skipwhite(skiptowhite(arg));
1010 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1011 && (checkforcmd(&p, "let", 2)
1012 || checkforcmd(&p, "var", 3)
1013 || checkforcmd(&p, "final", 5)
1014 || checkforcmd(&p, "const", 5))))
1015 {
1016 p = skipwhite(arg + 3);
1017 if (STRNCMP(p, "trim", 4) == 0)
1018 {
1019 // Ignore leading white space.
1020 p = skipwhite(p + 4);
1021 heredoc_trimmed = vim_strnsave(theline,
1022 skipwhite(theline) - theline);
1023 }
1024 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1025 getline_options = GETLINE_NONE;
1026 is_heredoc = TRUE;
1027 }
1028 }
1029 }
1030
1031 // Add the line to the function.
1032 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1033 goto theend;
1034
Bram Moolenaar20677332021-06-06 17:02:53 +02001035 if (heredoc_concat_len > 0)
1036 {
1037 // For a :def function "python << EOF" concatenats all the lines,
1038 // to be used for the instruction later.
1039 ga_concat(&heredoc_ga, theline);
1040 ga_concat(&heredoc_ga, (char_u *)"\n");
1041 p = vim_strsave((char_u *)"");
1042 }
1043 else
1044 {
1045 // Copy the line to newly allocated memory. get_one_sourceline()
1046 // allocates 250 bytes per line, this saves 80% on average. The
1047 // cost is an extra alloc/free.
1048 p = vim_strsave(theline);
1049 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001050 if (p == NULL)
1051 goto theend;
1052 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1053
1054 // Add NULL lines for continuation lines, so that the line count is
1055 // equal to the index in the growarray.
1056 while (sourcing_lnum_off-- > 0)
1057 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1058
1059 // Check for end of eap->arg.
1060 if (line_arg != NULL && *line_arg == NUL)
1061 line_arg = NULL;
1062 }
1063
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001064 // Return OK when no error was detected.
1065 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001066 ret = OK;
1067
1068theend:
1069 vim_free(skip_until);
1070 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001071 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001072 need_wait_return |= saved_wait_return;
1073 return ret;
1074}
1075
1076/*
1077 * Handle the body of a lambda. *arg points to the "{", process statements
1078 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001079 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 * When successful "rettv" is set to a funcref.
1081 */
1082 static int
1083lambda_function_body(
1084 char_u **arg,
1085 typval_T *rettv,
1086 evalarg_T *evalarg,
1087 garray_T *newargs,
1088 garray_T *argtypes,
1089 int varargs,
1090 garray_T *default_args,
1091 char_u *ret_type)
1092{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001093 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001094 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001095 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001096 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001097 exarg_T eap;
1098 garray_T newlines;
1099 char_u *cmdline = NULL;
1100 int ret = FAIL;
1101 char_u *line_to_free = NULL;
1102 partial_T *pt;
1103 char_u *name;
1104 int lnum_save = -1;
1105 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1106
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001107 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1108 {
1109 semsg(_(e_trailing_arg), *arg + 1);
1110 return FAIL;
1111 }
1112
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001113 CLEAR_FIELD(eap);
1114 eap.cmdidx = CMD_block;
1115 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001116 eap.cmdlinep = &cmdline;
1117 eap.skip = !evaluate;
1118 if (evalarg->eval_cctx != NULL)
1119 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1120 else
1121 {
1122 eap.getline = evalarg->eval_getline;
1123 eap.cookie = evalarg->eval_cookie;
1124 }
1125
1126 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1127 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001128 {
1129 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001130 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001131 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001132
1133 // When inside a lambda must add the function lines to evalarg.eval_ga.
1134 evalarg->eval_break_count += newlines.ga_len;
1135 if (gap->ga_itemsize > 0)
1136 {
1137 int idx;
1138 char_u *last;
1139 size_t plen;
1140 char_u *pnl;
1141
1142 for (idx = 0; idx < newlines.ga_len; ++idx)
1143 {
1144 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1145
Bram Moolenaarecb66452021-05-18 15:09:18 +02001146 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001147 goto erret;
1148
1149 // Going to concatenate the lines after parsing. For an empty or
1150 // comment line use an empty string.
1151 // Insert NL characters at the start of each line, the string will
1152 // be split again later in .get_lambda_tv().
1153 if (*p == NUL || vim9_comment_start(p))
1154 p = (char_u *)"";
1155 plen = STRLEN(p);
1156 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1157 if (pnl != NULL)
1158 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001159 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1160 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001161 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001162 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001163 goto erret;
1164 if (cmdline != NULL)
1165 // more is following after the "}", which was skipped
1166 last = cmdline;
1167 else
1168 // nothing is following the "}"
1169 last = (char_u *)"}";
1170 plen = STRLEN(last);
1171 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1172 if (pnl != NULL)
1173 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001174 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1175 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001176 }
1177
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 if (cmdline != NULL)
1179 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001180 garray_T *tfgap = &evalarg->eval_tofree_ga;
1181
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001182 // Something comes after the "}".
1183 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001184
1185 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001186 if (ga_grow(tfgap, 1) == OK)
1187 {
1188 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1189 evalarg->eval_using_cmdline = TRUE;
1190 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001191 }
1192 else
1193 *arg = (char_u *)"";
1194
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001195 if (!evaluate)
1196 {
1197 ret = OK;
1198 goto erret;
1199 }
1200
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001201 name = get_lambda_name();
1202 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1203 if (ufunc == NULL)
1204 goto erret;
1205 set_ufunc_name(ufunc, name);
1206 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001207 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001208 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 ufunc->uf_refcount = 1;
1210 ufunc->uf_args = *newargs;
1211 newargs->ga_data = NULL;
1212 ufunc->uf_def_args = *default_args;
1213 default_args->ga_data = NULL;
1214 ufunc->uf_func_type = &t_func_any;
1215
1216 // error messages are for the first function line
1217 lnum_save = SOURCING_LNUM;
1218 SOURCING_LNUM = sourcing_lnum_top;
1219
1220 // parse argument types
1221 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1222 {
1223 SOURCING_LNUM = lnum_save;
1224 goto erret;
1225 }
1226
1227 // parse the return type, if any
1228 if (parse_return_type(ufunc, ret_type) == FAIL)
1229 goto erret;
1230
1231 pt = ALLOC_CLEAR_ONE(partial_T);
1232 if (pt == NULL)
1233 goto erret;
1234 pt->pt_func = ufunc;
1235 pt->pt_refcount = 1;
1236
1237 ufunc->uf_lines = newlines;
1238 newlines.ga_data = NULL;
1239 if (sandbox)
1240 ufunc->uf_flags |= FC_SANDBOX;
1241 if (!ASCII_ISUPPER(*ufunc->uf_name))
1242 ufunc->uf_flags |= FC_VIM9;
1243 ufunc->uf_script_ctx = current_sctx;
1244 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1245 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1246 set_function_type(ufunc);
1247
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001248 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1249
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001250 rettv->vval.v_partial = pt;
1251 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001252 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001253 ret = OK;
1254
1255erret:
1256 if (lnum_save >= 0)
1257 SOURCING_LNUM = lnum_save;
1258 vim_free(line_to_free);
1259 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001260 if (newargs != NULL)
1261 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001263 if (ufunc != NULL)
1264 {
1265 func_clear(ufunc, TRUE);
1266 func_free(ufunc, TRUE);
1267 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001268 return ret;
1269}
1270
1271/*
1272 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001273 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001274 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001275 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1276 */
1277 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001278get_lambda_tv(
1279 char_u **arg,
1280 typval_T *rettv,
1281 int types_optional,
1282 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001284 int evaluate = evalarg != NULL
1285 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286 garray_T newargs;
1287 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001288 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001289 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001290 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001292 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001294 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001296 char_u *s;
1297 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001298 int *old_eval_lavars = eval_lavars_used;
1299 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001300 char_u *tofree1 = NULL;
1301 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001302 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001303 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001304 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001305
1306 if (equal_arrow && !in_vim9script())
1307 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001308
1309 ga_init(&newargs);
1310 ga_init(&newlines);
1311
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001312 // First, check if this is really a lambda expression. "->" or "=>" must
1313 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001314 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001315 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001316 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001317 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001318 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001319 {
1320 if (types_optional)
1321 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001322 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001323 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001325 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001326 if (evaluate)
1327 pnewargs = &newargs;
1328 else
1329 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001330 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001331 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001332 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001333 &varargs, &default_args,
1334 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001336 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001337 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001338 {
1339 if (types_optional)
1340 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001341 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001342 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001343 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001344 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001345
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001346 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1347 if (ret_type != NULL)
1348 {
1349 ret_type = vim_strsave(ret_type);
1350 tofree2 = ret_type;
1351 }
1352
Bram Moolenaare38eab22019-12-05 21:50:01 +01001353 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001354 if (evaluate)
1355 eval_lavars_used = &eval_lavars;
1356
Bram Moolenaar65c44152020-12-24 15:14:01 +01001357 *arg = skipwhite_and_linebreak(*arg, evalarg);
1358
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001359 // Recognize "{" as the start of a function body.
1360 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001361 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001362 if (evalarg == NULL)
1363 // cannot happen?
1364 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001365 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1366 types_optional ? &argtypes : NULL, varargs,
1367 &default_args, ret_type) == FAIL)
1368 goto errret;
1369 goto theend;
1370 }
1371 if (default_args.ga_len > 0)
1372 {
1373 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001374 goto errret;
1375 }
1376
Bram Moolenaare38eab22019-12-05 21:50:01 +01001377 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001378 start = *arg;
1379 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380 if (ret == FAIL)
1381 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001382 if (evalarg != NULL)
1383 {
1384 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001385 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001386 evalarg->eval_tofree = NULL;
1387 }
1388
Bram Moolenaar65c44152020-12-24 15:14:01 +01001389 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001390 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001391 *arg = skipwhite_and_linebreak(*arg, evalarg);
1392 if (**arg != '}')
1393 {
1394 semsg(_("E451: Expected }: %s"), *arg);
1395 goto errret;
1396 }
1397 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399
1400 if (evaluate)
1401 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001402 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001403 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001404 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001405 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001406 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001407
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001408 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409 if (fp == NULL)
1410 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001411 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001412 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001413 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001414 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1417 if (ga_grow(&newlines, 1) == FAIL)
1418 goto errret;
1419
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001420 // If there are line breaks, we need to split up the string.
1421 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001422 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001423 line_end = end;
1424
1425 // Add "return " before the expression (or the first line).
1426 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001427 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001428 if (p == NULL)
1429 goto errret;
1430 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1431 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001432 vim_strncpy(p + 7, start, line_end - start);
1433
1434 if (line_end != end)
1435 {
1436 // Add more lines, split by line breaks. Thus is used when a
1437 // lambda with { cmds } is encountered.
1438 while (*line_end == '\n')
1439 {
1440 if (ga_grow(&newlines, 1) == FAIL)
1441 goto errret;
1442 start = line_end + 1;
1443 line_end = vim_strchr(start, '\n');
1444 if (line_end == NULL)
1445 line_end = end;
1446 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1447 vim_strnsave(start, line_end - start);
1448 }
1449 }
1450
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001451 if (strstr((char *)p + 7, "a:") == NULL)
1452 // No a: variables are used for sure.
1453 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454
1455 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001456 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001458 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001459 if (types_optional)
1460 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001461 if (parse_argument_types(fp, &argtypes,
1462 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001463 goto errret;
1464 if (ret_type != NULL)
1465 {
1466 fp->uf_ret_type = parse_type(&ret_type,
1467 &fp->uf_type_list, TRUE);
1468 if (fp->uf_ret_type == NULL)
1469 goto errret;
1470 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001471 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001472 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001473 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001474
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001476 if (current_funccal != NULL && eval_lavars)
1477 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001478 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001479 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001480 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001481 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482
1483#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484 if (prof_def_func())
1485 func_do_profile(fp);
1486#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001487 if (sandbox)
1488 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001489 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001490 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1491 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001492 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001493 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001494 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001495 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001497 function_using_block_scopes(fp, evalarg->eval_cstack);
1498
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001499 pt->pt_func = fp;
1500 pt->pt_refcount = 1;
1501 rettv->vval.v_partial = pt;
1502 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001503
1504 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001507theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001508 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001509 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001510 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001511 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001512 vim_free(tofree1);
1513 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001514 if (types_optional)
1515 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001516
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 return OK;
1518
1519errret:
1520 ga_clear_strings(&newargs);
1521 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001522 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001523 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001524 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001525 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001526 if (fp != NULL)
1527 vim_free(fp->uf_arg_types);
1528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001530 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001531 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001532 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001533 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001534 vim_free(tofree1);
1535 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001536 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 return FAIL;
1538}
1539
1540/*
1541 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1542 * name it contains, otherwise return "name".
1543 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1544 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001545 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1546 * type of the variable.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001547 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 */
1549 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001550deref_func_name(
1551 char_u *name,
1552 int *lenp,
1553 partial_T **partialp,
1554 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001555 int no_autoload,
1556 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001557{
1558 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001559 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001561 char_u *s = NULL;
1562 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001563 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564
1565 if (partialp != NULL)
1566 *partialp = NULL;
1567
1568 cc = name[*lenp];
1569 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001570
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001571 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001573 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001575 tv = &v->di_tv;
1576 }
1577 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1578 {
1579 imported_T *import;
1580 char_u *p = name;
1581 int len = *lenp;
1582
1583 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001585 p = name + 2;
1586 len -= 2;
1587 }
1588 import = find_imported(p, len, NULL);
1589
1590 // imported variable from another script
1591 if (import != NULL)
1592 {
1593 if (import->imp_funcname != NULL)
1594 {
1595 s = import->imp_funcname;
1596 *lenp = (int)STRLEN(s);
1597 return s;
1598 }
Bram Moolenaarf8a79fc2021-12-14 12:06:16 +00001599 if (import->imp_flags & IMP_FLAGS_STAR)
1600 {
1601 name[len] = NUL;
1602 semsg(_(e_cannot_use_str_itself_it_is_imported_with_star),
1603 name);
1604 name[len] = cc;
1605 *lenp = 0;
1606 return (char_u *)""; // just in case
1607 }
1608 else
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001609 {
1610 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1611 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1612 + import->imp_var_vals_idx;
1613 tv = sv->sv_tv;
1614 if (type != NULL)
1615 *type = sv->sv_type;
1616 did_type = TRUE;
1617 }
1618 }
1619 }
1620
1621 if (tv != NULL)
1622 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001623 if (found_var != NULL)
1624 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001625 if (tv->v_type == VAR_FUNC)
1626 {
1627 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001628 {
1629 *lenp = 0;
1630 return (char_u *)""; // just in case
1631 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001632 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001633 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001636 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001638 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001639
1640 if (pt == NULL)
1641 {
1642 *lenp = 0;
1643 return (char_u *)""; // just in case
1644 }
1645 if (partialp != NULL)
1646 *partialp = pt;
1647 s = partial_name(pt);
1648 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001650
1651 if (s != NULL)
1652 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001653 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001654 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001655 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001656
1657 if (sv != NULL)
1658 *type = sv->sv_type;
1659 }
1660 return s;
1661 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001662 }
1663
1664 return name;
1665}
1666
1667/*
1668 * Give an error message with a function name. Handle <SNR> things.
1669 * "ermsg" is to be passed without translation, use N_() instead of _().
1670 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001671 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672emsg_funcname(char *ermsg, char_u *name)
1673{
1674 char_u *p;
1675
1676 if (*name == K_SPECIAL)
1677 p = concat_str((char_u *)"<SNR>", name + 3);
1678 else
1679 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001680 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 if (p != name)
1682 vim_free(p);
1683}
1684
1685/*
1686 * Allocate a variable for the result of a function.
1687 * Return OK or FAIL.
1688 */
1689 int
1690get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001691 char_u *name, // name of the function
1692 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001694 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001695 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001696 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697{
1698 char_u *argp;
1699 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001700 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1701 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001702 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703
1704 /*
1705 * Get the arguments.
1706 */
1707 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001708 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1709 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001711 // skip the '(' or ',' and possibly line breaks
1712 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1713
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 if (*argp == ')' || *argp == ',' || *argp == NUL)
1715 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001716 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 {
1718 ret = FAIL;
1719 break;
1720 }
1721 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001722 // The comma should come right after the argument, but this wasn't
1723 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001724 if (vim9script)
1725 {
1726 if (*argp != ',' && *skipwhite(argp) == ',')
1727 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001728 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001729 ret = FAIL;
1730 break;
1731 }
1732 }
1733 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001734 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735 if (*argp != ',')
1736 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001737 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1738 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001739 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001740 ret = FAIL;
1741 break;
1742 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001744 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 if (*argp == ')')
1746 ++argp;
1747 else
1748 ret = FAIL;
1749
1750 if (ret == OK)
1751 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001752 int i = 0;
1753 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754
1755 if (get_vim_var_nr(VV_TESTING))
1756 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001757 // Prepare for calling test_garbagecollect_now(), need to know
1758 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 if (funcargs.ga_itemsize == 0)
1760 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1761 for (i = 0; i < argcount; ++i)
1762 if (ga_grow(&funcargs, 1) == OK)
1763 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1764 &argvars[i];
1765 }
1766
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001767 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001768 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001769 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001770 // An error in a builtin function does not return FAIL, but we do
1771 // want to abort further processing if an error was given.
1772 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001773 clear_tv(rettv);
1774 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775
1776 funcargs.ga_len -= i;
1777 }
1778 else if (!aborting())
1779 {
1780 if (argcount == MAX_FUNC_ARGS)
1781 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1782 else
1783 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1784 }
1785
1786 while (--argcount >= 0)
1787 clear_tv(&argvars[argcount]);
1788
Bram Moolenaar8294d492020-08-10 22:40:56 +02001789 if (in_vim9script())
1790 *arg = argp;
1791 else
1792 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 return ret;
1794}
1795
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796/*
1797 * Return TRUE if "p" starts with "<SID>" or "s:".
1798 * Only works if eval_fname_script() returned non-zero for "p"!
1799 */
1800 static int
1801eval_fname_sid(char_u *p)
1802{
1803 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1804}
1805
1806/*
1807 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1808 * Change <SNR>123_name() to K_SNR 123_name().
1809 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1810 * (slow).
1811 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001812 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1814{
1815 int llen;
1816 char_u *fname;
1817 int i;
1818
1819 llen = eval_fname_script(name);
1820 if (llen > 0)
1821 {
1822 fname_buf[0] = K_SPECIAL;
1823 fname_buf[1] = KS_EXTRA;
1824 fname_buf[2] = (int)KE_SNR;
1825 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001826 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001828 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001829 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 else
1831 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001832 sprintf((char *)fname_buf + 3, "%ld_",
1833 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 i = (int)STRLEN(fname_buf);
1835 }
1836 }
1837 if (i + STRLEN(name + llen) < FLEN_FIXED)
1838 {
1839 STRCPY(fname_buf + i, name + llen);
1840 fname = fname_buf;
1841 }
1842 else
1843 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001844 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001846 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001847 else
1848 {
1849 *tofree = fname;
1850 mch_memmove(fname, fname_buf, (size_t)i);
1851 STRCPY(fname + i, name + llen);
1852 }
1853 }
1854 }
1855 else
1856 fname = name;
1857 return fname;
1858}
1859
1860/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001861 * Find a function "name" in script "sid".
1862 */
1863 static ufunc_T *
1864find_func_with_sid(char_u *name, int sid)
1865{
1866 hashitem_T *hi;
1867 char_u buffer[200];
1868
1869 buffer[0] = K_SPECIAL;
1870 buffer[1] = KS_EXTRA;
1871 buffer[2] = (int)KE_SNR;
1872 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1873 (long)sid, name);
1874 hi = hash_find(&func_hashtab, buffer);
1875 if (!HASHITEM_EMPTY(hi))
1876 return HI2UF(hi);
1877
1878 return NULL;
1879}
1880
1881/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001882 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001883 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884 * Return NULL for unknown function.
1885 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001886 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001887find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001888{
1889 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001890 ufunc_T *func;
1891 imported_T *imported;
1892
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001893 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001894 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001895 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001896 long sid = 0;
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001897 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1898 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001899
Bram Moolenaar95006e32020-08-29 17:47:08 +02001900 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001901 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001902 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001903 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1904 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001905 if (func != NULL)
1906 return func;
1907 }
1908
Bram Moolenaarefa94442020-08-08 22:16:00 +02001909 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001910 && name[1] == KS_EXTRA
1911 && name[2] == KE_SNR)
1912 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001913 // Caller changes s: to <SNR>99_name.
1914
1915 after_script = name + 3;
1916 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001917 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001918 ++after_script;
1919 else
1920 after_script = NULL;
1921 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001922 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001923 {
1924 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001925 if (after_script != NULL && sid != current_sctx.sc_sid)
1926 imported = find_imported_in_script(after_script, 0, sid);
1927 else
1928 imported = find_imported(after_script == NULL
1929 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001930 if (imported != NULL && imported->imp_funcname != NULL)
1931 {
1932 hi = hash_find(&func_hashtab, imported->imp_funcname);
1933 if (!HASHITEM_EMPTY(hi))
1934 return HI2UF(hi);
1935 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001936 }
1937 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938
Bram Moolenaara26b9702020-04-18 19:53:28 +02001939 hi = hash_find(&func_hashtab,
1940 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001941 if (!HASHITEM_EMPTY(hi))
1942 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001943
1944 return NULL;
1945}
1946
1947/*
1948 * Find a function by name, return pointer to it in ufuncs.
1949 * "cctx" is passed in a :def function to find imported functions.
1950 * Return NULL for unknown or dead function.
1951 */
1952 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001953find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001955 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956
1957 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1958 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001959 return NULL;
1960}
1961
1962/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001963 * Return TRUE if "ufunc" is a global function.
1964 */
1965 int
1966func_is_global(ufunc_T *ufunc)
1967{
1968 return ufunc->uf_name[0] != K_SPECIAL;
1969}
1970
1971/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001972 * Copy the function name of "fp" to buffer "buf".
1973 * "buf" must be able to hold the function name plus three bytes.
1974 * Takes care of script-local function names.
1975 */
1976 static void
1977cat_func_name(char_u *buf, ufunc_T *fp)
1978{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001979 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001980 {
1981 STRCPY(buf, "<SNR>");
1982 STRCAT(buf, fp->uf_name + 3);
1983 }
1984 else
1985 STRCPY(buf, fp->uf_name);
1986}
1987
1988/*
1989 * Add a number variable "name" to dict "dp" with value "nr".
1990 */
1991 static void
1992add_nr_var(
1993 dict_T *dp,
1994 dictitem_T *v,
1995 char *name,
1996 varnumber_T nr)
1997{
1998 STRCPY(v->di_key, name);
1999 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2000 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2001 v->di_tv.v_type = VAR_NUMBER;
2002 v->di_tv.v_lock = VAR_FIXED;
2003 v->di_tv.vval.v_number = nr;
2004}
2005
2006/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002007 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002008 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002009 static void
2010free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002011{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002012 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002013
2014 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2015 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002016 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002017
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002018 // When garbage collecting a funccall_T may be freed before the
2019 // function that references it, clear its uf_scoped field.
2020 // The function may have been redefined and point to another
2021 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002022 if (fp != NULL && fp->uf_scoped == fc)
2023 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002024 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002025 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002026
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002027 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 vim_free(fc);
2029}
2030
2031/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002032 * Free "fc" and what it contains.
2033 * Can be called only when "fc" is kept beyond the period of it called,
2034 * i.e. after cleanup_function_call(fc).
2035 */
2036 static void
2037free_funccal_contents(funccall_T *fc)
2038{
2039 listitem_T *li;
2040
2041 // Free all l: variables.
2042 vars_clear(&fc->l_vars.dv_hashtab);
2043
2044 // Free all a: variables.
2045 vars_clear(&fc->l_avars.dv_hashtab);
2046
2047 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002048 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002049 clear_tv(&li->li_tv);
2050
2051 free_funccal(fc);
2052}
2053
2054/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002055 * Handle the last part of returning from a function: free the local hashtable.
2056 * Unless it is still in use by a closure.
2057 */
2058 static void
2059cleanup_function_call(funccall_T *fc)
2060{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002061 int may_free_fc = fc->fc_refcount <= 0;
2062 int free_fc = TRUE;
2063
Bram Moolenaar6914c642017-04-01 21:21:30 +02002064 current_funccal = fc->caller;
2065
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002066 // Free all l: variables if not referred.
2067 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2068 vars_clear(&fc->l_vars.dv_hashtab);
2069 else
2070 free_fc = FALSE;
2071
2072 // If the a:000 list and the l: and a: dicts are not referenced and
2073 // there is no closure using it, we can free the funccall_T and what's
2074 // in it.
2075 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2076 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002077 else
2078 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002079 int todo;
2080 hashitem_T *hi;
2081 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002082
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002083 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002084
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002085 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002086 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2087 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2088 {
2089 if (!HASHITEM_EMPTY(hi))
2090 {
2091 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002092 di = HI2DI(hi);
2093 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002094 }
2095 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002096 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002097
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002098 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2099 fc->l_varlist.lv_first = NULL;
2100 else
2101 {
2102 listitem_T *li;
2103
2104 free_fc = FALSE;
2105
2106 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002107 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002108 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002109 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002110
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002111 if (free_fc)
2112 free_funccal(fc);
2113 else
2114 {
2115 static int made_copy = 0;
2116
2117 // "fc" is still in use. This can happen when returning "a:000",
2118 // assigning "l:" to a global variable or defining a closure.
2119 // Link "fc" in the list for garbage collection later.
2120 fc->caller = previous_funccal;
2121 previous_funccal = fc;
2122
2123 if (want_garbage_collect)
2124 // If garbage collector is ready, clear count.
2125 made_copy = 0;
2126 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002127 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002128 // We have made a lot of copies, worth 4 Mbyte. This can happen
2129 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002130 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002131 // too much memory.
2132 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002133 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002134 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002135 }
2136}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002137
2138/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002139 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2140 */
2141 static int
2142numbered_function(char_u *name)
2143{
2144 return isdigit(*name)
2145 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2146}
2147
2148/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002149 * There are two kinds of function names:
2150 * 1. ordinary names, function defined with :function or :def
2151 * 2. numbered functions and lambdas
2152 * For the first we only count the name stored in func_hashtab as a reference,
2153 * using function() does not count as a reference, because the function is
2154 * looked up by name.
2155 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002156 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002157func_name_refcount(char_u *name)
2158{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002159 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002160}
2161
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002162/*
2163 * Unreference "fc": decrement the reference count and free it when it
2164 * becomes zero. "fp" is detached from "fc".
2165 * When "force" is TRUE we are exiting.
2166 */
2167 static void
2168funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2169{
2170 funccall_T **pfc;
2171 int i;
2172
2173 if (fc == NULL)
2174 return;
2175
2176 if (--fc->fc_refcount <= 0 && (force || (
2177 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2178 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2179 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2180 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2181 {
2182 if (fc == *pfc)
2183 {
2184 *pfc = fc->caller;
2185 free_funccal_contents(fc);
2186 return;
2187 }
2188 }
2189 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2190 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2191 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2192}
2193
2194/*
2195 * Remove the function from the function hashtable. If the function was
2196 * deleted while it still has references this was already done.
2197 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2198 */
2199 static int
2200func_remove(ufunc_T *fp)
2201{
2202 hashitem_T *hi;
2203
2204 // Return if it was already virtually deleted.
2205 if (fp->uf_flags & FC_DEAD)
2206 return FALSE;
2207
2208 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2209 if (!HASHITEM_EMPTY(hi))
2210 {
2211 // When there is a def-function index do not actually remove the
2212 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002213 // Do remove it when it's a copy.
2214 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002215 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002216 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002217 return FALSE;
2218 }
2219 hash_remove(&func_hashtab, hi);
2220 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002221 return TRUE;
2222 }
2223 return FALSE;
2224}
2225
2226 static void
2227func_clear_items(ufunc_T *fp)
2228{
2229 ga_clear_strings(&(fp->uf_args));
2230 ga_clear_strings(&(fp->uf_def_args));
2231 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002232 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002233 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002234 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002235 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002236
2237 // Increment the refcount of this function to avoid it being freed
2238 // recursively when the partial is freed.
2239 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002240 partial_unref(fp->uf_partial);
2241 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002242 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002243
2244#ifdef FEAT_LUA
2245 if (fp->uf_cb_free != NULL)
2246 {
2247 fp->uf_cb_free(fp->uf_cb_state);
2248 fp->uf_cb_free = NULL;
2249 }
2250
2251 fp->uf_cb_state = NULL;
2252 fp->uf_cb = NULL;
2253#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002254#ifdef FEAT_PROFILE
2255 VIM_CLEAR(fp->uf_tml_count);
2256 VIM_CLEAR(fp->uf_tml_total);
2257 VIM_CLEAR(fp->uf_tml_self);
2258#endif
2259}
2260
2261/*
2262 * Free all things that a function contains. Does not free the function
2263 * itself, use func_free() for that.
2264 * When "force" is TRUE we are exiting.
2265 */
2266 static void
2267func_clear(ufunc_T *fp, int force)
2268{
2269 if (fp->uf_cleared)
2270 return;
2271 fp->uf_cleared = TRUE;
2272
2273 // clear this function
2274 func_clear_items(fp);
2275 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002276 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002277}
2278
2279/*
2280 * Free a function and remove it from the list of functions. Does not free
2281 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002282 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002283 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002284 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002285 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002286func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002287{
2288 // Only remove it when not done already, otherwise we would remove a newer
2289 // version of the function with the same name.
2290 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2291 func_remove(fp);
2292
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002293 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002294 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002295 if (fp->uf_dfunc_idx > 0)
2296 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002297 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002298 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002299 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002300 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002301 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002302}
2303
2304/*
2305 * Free all things that a function contains and free the function itself.
2306 * When "force" is TRUE we are exiting.
2307 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002308 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002309func_clear_free(ufunc_T *fp, int force)
2310{
2311 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002312 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2313 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002314 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002315 else
2316 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002317}
2318
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002319/*
2320 * Copy already defined function "lambda" to a new function with name "global".
2321 * This is for when a compiled function defines a global function.
2322 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002323 int
2324copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002325{
2326 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002327 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002328
2329 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002330 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002331 semsg(_(e_lambda_function_not_found_str), lambda);
2332 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002333 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002334
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002335 fp = find_func(global, TRUE, NULL);
2336 if (fp != NULL)
2337 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002338 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002339 semsg(_(e_funcexts), global);
2340 return FAIL;
2341 }
2342
2343 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2344 if (fp == NULL)
2345 return FAIL;
2346
2347 fp->uf_varargs = ufunc->uf_varargs;
2348 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2349 fp->uf_def_status = ufunc->uf_def_status;
2350 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2351 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2352 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2353 == FAIL
2354 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2355 goto failed;
2356
2357 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2358 : vim_strsave(ufunc->uf_name_exp);
2359 if (ufunc->uf_arg_types != NULL)
2360 {
2361 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2362 if (fp->uf_arg_types == NULL)
2363 goto failed;
2364 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2365 sizeof(type_T *) * fp->uf_args.ga_len);
2366 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002367 if (ufunc->uf_va_name != NULL)
2368 {
2369 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2370 if (fp->uf_va_name == NULL)
2371 goto failed;
2372 }
2373 fp->uf_ret_type = ufunc->uf_ret_type;
2374
2375 fp->uf_refcount = 1;
2376 STRCPY(fp->uf_name, global);
2377 hash_add(&func_hashtab, UF2HIKEY(fp));
2378
2379 // the referenced dfunc_T is now used one more time
2380 link_def_function(fp);
2381
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002382 // Create a partial to store the context of the function where it was
2383 // instantiated. Only needs to be done once. Do this on the original
2384 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002385 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2386 {
2387 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2388
2389 if (pt == NULL)
2390 goto failed;
2391 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002392 {
2393 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002394 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002395 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002396 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002397 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002398 }
2399
2400 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002401
2402failed:
2403 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002404 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002405}
2406
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002407static int funcdepth = 0;
2408
2409/*
2410 * Increment the function call depth count.
2411 * Return FAIL when going over 'maxfuncdepth'.
2412 * Otherwise return OK, must call funcdepth_decrement() later!
2413 */
2414 int
2415funcdepth_increment(void)
2416{
2417 if (funcdepth >= p_mfd)
2418 {
2419 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2420 return FAIL;
2421 }
2422 ++funcdepth;
2423 return OK;
2424}
2425
2426 void
2427funcdepth_decrement(void)
2428{
2429 --funcdepth;
2430}
2431
2432/*
2433 * Get the current function call depth.
2434 */
2435 int
2436funcdepth_get(void)
2437{
2438 return funcdepth;
2439}
2440
2441/*
2442 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002443 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002444 * times as funcdepth_increment().
2445 */
2446 void
2447funcdepth_restore(int depth)
2448{
2449 funcdepth = depth;
2450}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002451
2452/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 * Call a user function.
2454 */
2455 static void
2456call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002457 ufunc_T *fp, // pointer to function
2458 int argcount, // nr of args
2459 typval_T *argvars, // arguments
2460 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002461 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002462 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002464 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002465 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 funccall_T *fc;
2467 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002468 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002470 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 int i;
2472 int ai;
2473 int islambda = FALSE;
2474 char_u numbuf[NUMBUFLEN];
2475 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002476 typval_T *tv_to_free[MAX_FUNC_ARGS];
2477 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002478#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002479 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002481 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482
Bram Moolenaarb2049902021-01-24 12:53:53 +01002483#ifdef FEAT_PROFILE
2484 CLEAR_FIELD(profile_info);
2485#endif
2486
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002487 // If depth of calling is getting too high, don't execute the function.
2488 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 rettv->v_type = VAR_NUMBER;
2491 rettv->vval.v_number = -1;
2492 return;
2493 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494
Bram Moolenaare38eab22019-12-05 21:50:01 +01002495 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002497 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002498 if (fc == NULL)
2499 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 fc->caller = current_funccal;
2501 current_funccal = fc;
2502 fc->func = fp;
2503 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002505 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2507 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002508 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002509 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002510 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002512 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002513 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002514#ifdef FEAT_PROFILE
2515 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2516#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002517 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002518#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002519 if (do_profiling == PROF_YES)
2520 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002521#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002522 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002523 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002524#ifdef FEAT_PROFILE
2525 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002526 || (caller != NULL && caller->uf_profiling)))
2527 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002528#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002529 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002530 free_funccal(fc);
2531 return;
2532 }
2533
Bram Moolenaar38453522021-11-28 22:00:12 +00002534 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535
2536 /*
2537 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2538 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2539 * each argument variable and saves a lot of time.
2540 */
2541 /*
2542 * Init l: variables.
2543 */
2544 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2545 if (selfdict != NULL)
2546 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002547 // Set l:self to "selfdict". Use "name" to avoid a warning from
2548 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 v = &fc->fixvar[fixvar_idx++].var;
2550 name = v->di_key;
2551 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002552 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2554 v->di_tv.v_type = VAR_DICT;
2555 v->di_tv.v_lock = 0;
2556 v->di_tv.vval.v_dict = selfdict;
2557 ++selfdict->dv_refcount;
2558 }
2559
2560 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002561 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002562 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002563 * Set a:000 to a list with room for the "..." arguments.
2564 */
2565 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002566 if ((fp->uf_flags & FC_NOARGS) == 0)
2567 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002568 (varnumber_T)(argcount >= fp->uf_args.ga_len
2569 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002570 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002571 if ((fp->uf_flags & FC_NOARGS) == 0)
2572 {
2573 // Use "name" to avoid a warning from some compiler that checks the
2574 // destination size.
2575 v = &fc->fixvar[fixvar_idx++].var;
2576 name = v->di_key;
2577 STRCPY(name, "000");
2578 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2579 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2580 v->di_tv.v_type = VAR_LIST;
2581 v->di_tv.v_lock = VAR_FIXED;
2582 v->di_tv.vval.v_list = &fc->l_varlist;
2583 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002584 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2586 fc->l_varlist.lv_lock = VAR_FIXED;
2587
2588 /*
2589 * Set a:firstline to "firstline" and a:lastline to "lastline".
2590 * Set a:name to named arguments.
2591 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002592 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002593 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002594 if ((fp->uf_flags & FC_NOARGS) == 0)
2595 {
2596 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002597 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002598 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002599 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002600 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002601 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602 {
2603 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002604 typval_T def_rettv;
2605 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002606
2607 ai = i - fp->uf_args.ga_len;
2608 if (ai < 0)
2609 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002610 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002611 name = FUNCARG(fp, i);
2612 if (islambda)
2613 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002614
2615 // evaluate named argument default expression
2616 isdefault = ai + fp->uf_def_args.ga_len >= 0
2617 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2618 && argvars[i].vval.v_number == VVAL_NONE));
2619 if (isdefault)
2620 {
2621 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002622
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002623 def_rettv.v_type = VAR_NUMBER;
2624 def_rettv.vval.v_number = -1;
2625
2626 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2627 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002628 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002629 {
2630 default_arg_err = 1;
2631 break;
2632 }
2633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 }
2635 else
2636 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002637 if ((fp->uf_flags & FC_NOARGS) != 0)
2638 // Bail out if no a: arguments used (in lambda).
2639 break;
2640
Bram Moolenaare38eab22019-12-05 21:50:01 +01002641 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 sprintf((char *)numbuf, "%d", ai + 1);
2643 name = numbuf;
2644 }
2645 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2646 {
2647 v = &fc->fixvar[fixvar_idx++].var;
2648 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002649 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 }
2651 else
2652 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002653 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002654 if (v == NULL)
2655 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002656 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002659 // Note: the values are copied directly to avoid alloc/free.
2660 // "argvars" must have VAR_FIXED for v_lock.
2661 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 v->di_tv.v_lock = VAR_FIXED;
2663
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002664 if (isdefault)
2665 // Need to free this later, no matter where it's stored.
2666 tv_to_free[tv_to_free_len++] = &v->di_tv;
2667
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 if (addlocal)
2669 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002670 // Named arguments should be accessed without the "a:" prefix in
2671 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002672 copy_tv(&v->di_tv, &v->di_tv);
2673 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002675 else
2676 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677
2678 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2679 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002680 listitem_T *li = &fc->l_listitems[ai];
2681
2682 li->li_tv = argvars[i];
2683 li->li_tv.v_lock = VAR_FIXED;
2684 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 }
2686 }
2687
Bram Moolenaare38eab22019-12-05 21:50:01 +01002688 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002690
2691 if (fp->uf_flags & FC_SANDBOX)
2692 {
2693 using_sandbox = TRUE;
2694 ++sandbox;
2695 }
2696
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002697 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002698 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002699 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002701 ++no_wait_return;
2702 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002704 smsg(_("calling %s"), SOURCING_NAME);
2705 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002707 char_u buf[MSG_BUF_LEN];
2708 char_u numbuf2[NUMBUFLEN];
2709 char_u *tofree;
2710 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002712 msg_puts("(");
2713 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002715 if (i > 0)
2716 msg_puts(", ");
2717 if (argvars[i].v_type == VAR_NUMBER)
2718 msg_outnum((long)argvars[i].vval.v_number);
2719 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002721 // Do not want errors such as E724 here.
2722 ++emsg_off;
2723 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2724 --emsg_off;
2725 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002726 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002727 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002729 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2730 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002732 msg_puts((char *)s);
2733 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734 }
2735 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002737 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002738 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002739 msg_puts("\n"); // don't overwrite this either
2740
2741 verbose_leave_scroll();
2742 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 }
2744#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002745 if (do_profiling == PROF_YES)
2746 profile_may_start_func(&profile_info, fp,
2747 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748#endif
2749
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002750 save_current_sctx = current_sctx;
2751 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002752 save_did_emsg = did_emsg;
2753 did_emsg = FALSE;
2754
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002755 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2756 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002757 else if (islambda)
2758 {
2759 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2760
2761 // A Lambda always has the command "return {expr}". It is much faster
2762 // to evaluate {expr} directly.
2763 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002764 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002765 --ex_nesting_level;
2766 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002767 else
2768 // call do_cmdline() to execute the lines
2769 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2771
2772 --RedrawingDisabled;
2773
Bram Moolenaare38eab22019-12-05 21:50:01 +01002774 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2776 {
2777 clear_tv(rettv);
2778 rettv->v_type = VAR_NUMBER;
2779 rettv->vval.v_number = -1;
2780 }
2781
2782#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002783 if (do_profiling == PROF_YES)
2784 {
2785 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2786
2787 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2788 profile_may_end_func(&profile_info, fp, caller);
2789 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790#endif
2791
Bram Moolenaare38eab22019-12-05 21:50:01 +01002792 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793 if (p_verbose >= 12)
2794 {
2795 ++no_wait_return;
2796 verbose_enter_scroll();
2797
2798 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002799 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002801 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 (long)fc->rettv->vval.v_number);
2803 else
2804 {
2805 char_u buf[MSG_BUF_LEN];
2806 char_u numbuf2[NUMBUFLEN];
2807 char_u *tofree;
2808 char_u *s;
2809
Bram Moolenaare38eab22019-12-05 21:50:01 +01002810 // The value may be very long. Skip the middle part, so that we
2811 // have some idea how it starts and ends. smsg() would always
2812 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 ++emsg_off;
2814 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2815 --emsg_off;
2816 if (s != NULL)
2817 {
2818 if (vim_strsize(s) > MSG_BUF_CLEN)
2819 {
2820 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2821 s = buf;
2822 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002823 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 vim_free(tofree);
2825 }
2826 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002827 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828
2829 verbose_leave_scroll();
2830 --no_wait_return;
2831 }
2832
Bram Moolenaare31ee862020-01-07 20:59:34 +01002833 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002834 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002835 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836#ifdef FEAT_PROFILE
2837 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002838 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002840 if (using_sandbox)
2841 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002843 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 {
2845 ++no_wait_return;
2846 verbose_enter_scroll();
2847
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002848 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002849 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850
2851 verbose_leave_scroll();
2852 --no_wait_return;
2853 }
2854
2855 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002856 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002857 for (i = 0; i < tv_to_free_len; ++i)
2858 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002859 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860}
2861
2862/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002863 * Check the argument count for user function "fp".
2864 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2865 */
2866 int
2867check_user_func_argcount(ufunc_T *fp, int argcount)
2868{
2869 int regular_args = fp->uf_args.ga_len;
2870
2871 if (argcount < regular_args - fp->uf_def_args.ga_len)
2872 return FCERR_TOOFEW;
2873 else if (!has_varargs(fp) && argcount > regular_args)
2874 return FCERR_TOOMANY;
2875 return FCERR_UNKNOWN;
2876}
2877
2878/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002879 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002880 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 int
2882call_user_func_check(
2883 ufunc_T *fp,
2884 int argcount,
2885 typval_T *argvars,
2886 typval_T *rettv,
2887 funcexe_T *funcexe,
2888 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002889{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002890 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002891
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002892 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2893 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002894 error = check_user_func_argcount(fp, argcount);
2895 if (error != FCERR_UNKNOWN)
2896 return error;
2897 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002898 error = FCERR_DICT;
2899 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002900 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 int did_save_redo = FALSE;
2902 save_redo_T save_redo;
2903
2904 /*
2905 * Call the user function.
2906 * Save and restore search patterns, script variables and
2907 * redo buffer.
2908 */
2909 save_search_patterns();
2910 if (!ins_compl_active())
2911 {
2912 saveRedobuff(&save_redo);
2913 did_save_redo = TRUE;
2914 }
2915 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002916 call_user_func(fp, argcount, argvars, rettv, funcexe,
2917 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002918 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2919 // Function was unreferenced while being used, free it now.
2920 func_clear_free(fp, FALSE);
2921 if (did_save_redo)
2922 restoreRedobuff(&save_redo);
2923 restore_search_patterns();
2924 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002925 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002926 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002927}
2928
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002929static funccal_entry_T *funccal_stack = NULL;
2930
2931/*
2932 * Save the current function call pointer, and set it to NULL.
2933 * Used when executing autocommands and for ":source".
2934 */
2935 void
2936save_funccal(funccal_entry_T *entry)
2937{
2938 entry->top_funccal = current_funccal;
2939 entry->next = funccal_stack;
2940 funccal_stack = entry;
2941 current_funccal = NULL;
2942}
2943
2944 void
2945restore_funccal(void)
2946{
2947 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002948 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002949 else
2950 {
2951 current_funccal = funccal_stack->top_funccal;
2952 funccal_stack = funccal_stack->next;
2953 }
2954}
2955
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002956 funccall_T *
2957get_current_funccal(void)
2958{
2959 return current_funccal;
2960}
2961
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002962/*
2963 * Mark all functions of script "sid" as deleted.
2964 */
2965 void
2966delete_script_functions(int sid)
2967{
2968 hashitem_T *hi;
2969 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002970 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002971 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002972 size_t len;
2973
2974 buf[0] = K_SPECIAL;
2975 buf[1] = KS_EXTRA;
2976 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002977 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002978 len = STRLEN(buf);
2979
Bram Moolenaarce658352020-07-31 23:47:12 +02002980 while (todo > 0)
2981 {
2982 todo = func_hashtab.ht_used;
2983 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2984 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002985 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002986 fp = HI2UF(hi);
2987 if (STRNCMP(fp->uf_name, buf, len) == 0)
2988 {
2989 int changed = func_hashtab.ht_changed;
2990
2991 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002992
2993 if (fp->uf_calls > 0)
2994 {
2995 // Function is executing, don't free it but do remove
2996 // it from the hashtable.
2997 if (func_remove(fp))
2998 fp->uf_refcount--;
2999 }
3000 else
3001 {
3002 func_clear(fp, TRUE);
3003 // When clearing a function another function can be
3004 // cleared as a side effect. When that happens start
3005 // over.
3006 if (changed != func_hashtab.ht_changed)
3007 break;
3008 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003009 }
3010 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003011 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003012 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003013}
3014
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003015#if defined(EXITFREE) || defined(PROTO)
3016 void
3017free_all_functions(void)
3018{
3019 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003020 ufunc_T *fp;
3021 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003022 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003023 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024
Bram Moolenaare38eab22019-12-05 21:50:01 +01003025 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003026 while (current_funccal != NULL)
3027 {
3028 clear_tv(current_funccal->rettv);
3029 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003030 if (current_funccal == NULL && funccal_stack != NULL)
3031 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003032 }
3033
Bram Moolenaare38eab22019-12-05 21:50:01 +01003034 // First clear what the functions contain. Since this may lower the
3035 // reference count of a function, it may also free a function and change
3036 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003037 while (todo > 0)
3038 {
3039 todo = func_hashtab.ht_used;
3040 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3041 if (!HASHITEM_EMPTY(hi))
3042 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003043 // clear the def function index now
3044 fp = HI2UF(hi);
3045 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003046 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003047
Bram Moolenaare38eab22019-12-05 21:50:01 +01003048 // Only free functions that are not refcounted, those are
3049 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003050 if (func_name_refcount(fp->uf_name))
3051 ++skipped;
3052 else
3053 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003054 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003055 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003056 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003057 {
3058 skipped = 0;
3059 break;
3060 }
3061 }
3062 --todo;
3063 }
3064 }
3065
Bram Moolenaare38eab22019-12-05 21:50:01 +01003066 // Now actually free the functions. Need to start all over every time,
3067 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003068 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003069 while (func_hashtab.ht_used > skipped)
3070 {
3071 todo = func_hashtab.ht_used;
3072 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073 if (!HASHITEM_EMPTY(hi))
3074 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003075 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003076 // Only free functions that are not refcounted, those are
3077 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003078 fp = HI2UF(hi);
3079 if (func_name_refcount(fp->uf_name))
3080 ++skipped;
3081 else
3082 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003083 if (func_free(fp, FALSE) == OK)
3084 {
3085 skipped = 0;
3086 break;
3087 }
3088 // did not actually free it
3089 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003090 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003092 }
3093 if (skipped == 0)
3094 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003095
3096 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097}
3098#endif
3099
3100/*
3101 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003102 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 * "len" is the length of "name", or -1 for NUL terminated.
3104 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003105 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106builtin_function(char_u *name, int len)
3107{
3108 char_u *p;
3109
Bram Moolenaara26b9702020-04-18 19:53:28 +02003110 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 return FALSE;
3112 p = vim_strchr(name, AUTOLOAD_CHAR);
3113 return p == NULL || (len > 0 && p > name + len);
3114}
3115
3116 int
3117func_call(
3118 char_u *name,
3119 typval_T *args,
3120 partial_T *partial,
3121 dict_T *selfdict,
3122 typval_T *rettv)
3123{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003124 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125 listitem_T *item;
3126 typval_T argv[MAX_FUNC_ARGS + 1];
3127 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 int r = 0;
3129
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003130 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003131 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132 {
3133 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3134 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003135 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136 break;
3137 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003138 // Make a copy of each argument. This is needed to be able to set
3139 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003140 copy_tv(&item->li_tv, &argv[argc++]);
3141 }
3142
3143 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003144 {
3145 funcexe_T funcexe;
3146
Bram Moolenaara80faa82020-04-12 19:37:17 +02003147 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003148 funcexe.fe_firstline = curwin->w_cursor.lnum;
3149 funcexe.fe_lastline = curwin->w_cursor.lnum;
3150 funcexe.fe_evaluate = TRUE;
3151 funcexe.fe_partial = partial;
3152 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003153 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3154 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003155
Bram Moolenaare38eab22019-12-05 21:50:01 +01003156 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 while (argc > 0)
3158 clear_tv(&argv[--argc]);
3159
3160 return r;
3161}
3162
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003163static int callback_depth = 0;
3164
3165 int
3166get_callback_depth(void)
3167{
3168 return callback_depth;
3169}
3170
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003171/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003172 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003173 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003174 */
3175 int
3176call_callback(
3177 callback_T *callback,
3178 int len, // length of "name" or -1 to use strlen()
3179 typval_T *rettv, // return value goes here
3180 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003181 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003182 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003183{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003184 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003185 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003186
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003187 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3188 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003189 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003190 funcexe.fe_evaluate = TRUE;
3191 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003192 ++callback_depth;
3193 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3194 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003195
3196 // When a :def function was called that uses :try an error would be turned
3197 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003198 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003199 {
3200 need_rethrow = FALSE;
3201 handle_did_throw();
3202 }
3203
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003204 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003205}
3206
3207/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003208 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003209 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003210 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3211 */
3212 varnumber_T
3213call_callback_retnr(
3214 callback_T *callback,
3215 int argcount, // number of "argvars"
3216 typval_T *argvars) // vars for arguments, must have "argcount"
3217 // PLUS ONE elements!
3218{
3219 typval_T rettv;
3220 varnumber_T retval;
3221
3222 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003223 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003224
3225 retval = tv_get_number_chk(&rettv, NULL);
3226 clear_tv(&rettv);
3227 return retval;
3228}
3229
3230/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003231 * Give an error message for the result of a function.
3232 * Nothing if "error" is FCERR_NONE.
3233 */
3234 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003235user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003236{
3237 switch (error)
3238 {
3239 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003240 if (funcexe->fe_found_var)
3241 semsg(_(e_not_callable_type_str), name);
3242 else
3243 emsg_funcname(e_unknownfunc, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003244 break;
3245 case FCERR_NOTMETHOD:
3246 emsg_funcname(
3247 N_("E276: Cannot use function as a method: %s"), name);
3248 break;
3249 case FCERR_DELETED:
3250 emsg_funcname(N_(e_func_deleted), name);
3251 break;
3252 case FCERR_TOOMANY:
3253 emsg_funcname((char *)e_toomanyarg, name);
3254 break;
3255 case FCERR_TOOFEW:
3256 emsg_funcname((char *)e_toofewarg, name);
3257 break;
3258 case FCERR_SCRIPT:
3259 emsg_funcname(
3260 N_("E120: Using <SID> not in a script context: %s"), name);
3261 break;
3262 case FCERR_DICT:
3263 emsg_funcname(
3264 N_("E725: Calling dict function without Dictionary: %s"),
3265 name);
3266 break;
3267 }
3268}
3269
3270/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003272 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 * Return FAIL when the function can't be called, OK otherwise.
3274 * Also returns OK when an error was encountered while executing the function.
3275 */
3276 int
3277call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003278 char_u *funcname, // name of the function
3279 int len, // length of "name" or -1 to use strlen()
3280 typval_T *rettv, // return value goes here
3281 int argcount_in, // number of "argvars"
3282 typval_T *argvars_in, // vars for arguments, must have "argcount"
3283 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003284 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285{
3286 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003287 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003289 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003290 char_u fname_buf[FLEN_FIXED + 1];
3291 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003292 char_u *fname = NULL;
3293 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 int argcount = argcount_in;
3295 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003296 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003297 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003298 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003300 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003301 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003302 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003304 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3305 // even when call_func() returns FAIL.
3306 rettv->v_type = VAR_UNKNOWN;
3307
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003308 if (partial != NULL)
3309 fp = partial->pt_func;
3310 if (fp == NULL)
3311 {
3312 // Make a copy of the name, if it comes from a funcref variable it
3313 // could be changed or deleted in the called function.
3314 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3315 if (name == NULL)
3316 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003318 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3319 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003321 if (funcexe->fe_doesrange != NULL)
3322 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323
3324 if (partial != NULL)
3325 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003326 // When the function has a partial with a dict and there is a dict
3327 // argument, use the dict argument. That is backwards compatible.
3328 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003329 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003331 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 {
3333 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003334 {
3335 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3336 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003337 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003338 goto theend;
3339 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 for (i = 0; i < argcount_in; ++i)
3343 argv[i + argv_clear] = argvars_in[i];
3344 argvars = argv;
3345 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003346
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003347 if (funcexe->fe_check_type != NULL
3348 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003349 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003350 // Now funcexe->fe_check_type is missing the added arguments,
3351 // make a copy of the type with the correction.
3352 check_type = *funcexe->fe_check_type;
3353 funcexe->fe_check_type = &check_type;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003354 check_type.tt_argcount += partial->pt_argc;
3355 check_type.tt_min_argcount += partial->pt_argc;
3356 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 }
3358 }
3359
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003360 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3361 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003362 {
3363 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003364 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003365 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003366 error = FCERR_OTHER;
3367 }
3368
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003369 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 {
3371 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003372 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373
Bram Moolenaar333894b2020-08-01 18:53:07 +02003374 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003375 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003376 {
3377 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003379 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380
Bram Moolenaare38eab22019-12-05 21:50:01 +01003381 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003383 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003385 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 {
3387 /*
3388 * User defined function.
3389 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003390 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003391 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392
Bram Moolenaare38eab22019-12-05 21:50:01 +01003393 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394 if (fp == NULL
3395 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003396 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 && !aborting())
3398 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003399 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003400 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003402 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3404 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003405 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003406 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003408 if (fp == NULL)
3409 {
3410 char_u *p = untrans_function_name(rfname);
3411
3412 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003413 // Don't do this if the name starts with "s:".
3414 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003415 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003418 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003419 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003420#ifdef FEAT_LUA
3421 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3422 {
3423 cfunc_T cb = fp->uf_cb;
3424
3425 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3426 }
3427#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003428 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003430 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003431 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003432 argcount = funcexe->fe_argv_func(argcount, argvars,
3433 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003434
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003435 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003436 {
3437 // Method call: base->Method()
3438 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003439 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003440 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003441 argvars = argv;
3442 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003443 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003444
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003445 error = call_user_func_check(fp, argcount, argvars, rettv,
3446 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 }
3448 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003449 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003450 {
3451 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003452 * expr->method(): Find the method name in the table, call its
3453 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003454 */
3455 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003456 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 else
3459 {
3460 /*
3461 * Find the function name in the table, call its implementation.
3462 */
3463 error = call_internal_func(fname, argcount, argvars, rettv);
3464 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003465
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 /*
3467 * The function call (or "FuncUndefined" autocommand sequence) might
3468 * have been aborted by an error, an interrupt, or an explicitly thrown
3469 * exception that has not been caught so far. This situation can be
3470 * tested for by calling aborting(). For an error in an internal
3471 * function or for the "E132" error in call_user_func(), however, the
3472 * throw point at which the "force_abort" flag (temporarily reset by
3473 * emsg()) is normally updated has not been reached yet. We need to
3474 * update that flag first to make aborting() reliable.
3475 */
3476 update_force_abort();
3477 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003478 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 ret = OK;
3480
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003481theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 /*
3483 * Report an error unless the argument evaluation or function call has been
3484 * cancelled due to an aborting error, an interrupt, or an exception.
3485 */
3486 if (!aborting())
3487 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003488 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 }
3490
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003491 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003493 clear_tv(&argv[--argv_clear + argv_base]);
3494
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495 vim_free(tofree);
3496 vim_free(name);
3497
3498 return ret;
3499}
3500
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003501 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003502printable_func_name(ufunc_T *fp)
3503{
3504 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3505}
3506
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003508 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 */
3510 static void
3511list_func_head(ufunc_T *fp, int indent)
3512{
3513 int j;
3514
3515 msg_start();
3516 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003517 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003518 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003519 msg_puts("def ");
3520 else
3521 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003522 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 msg_putchar('(');
3524 for (j = 0; j < fp->uf_args.ga_len; ++j)
3525 {
3526 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003527 msg_puts(", ");
3528 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003529 if (fp->uf_arg_types != NULL)
3530 {
3531 char *tofree;
3532
3533 msg_puts(": ");
3534 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3535 vim_free(tofree);
3536 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003537 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3538 {
3539 msg_puts(" = ");
3540 msg_puts(((char **)(fp->uf_def_args.ga_data))
3541 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3542 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 }
3544 if (fp->uf_varargs)
3545 {
3546 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003547 msg_puts(", ");
3548 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003550 if (fp->uf_va_name != NULL)
3551 {
3552 if (j)
3553 msg_puts(", ");
3554 msg_puts("...");
3555 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003556 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003557 {
3558 char *tofree;
3559
3560 msg_puts(": ");
3561 msg_puts(type_name(fp->uf_va_type, &tofree));
3562 vim_free(tofree);
3563 }
3564 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003566
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003567 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003568 {
3569 if (fp->uf_ret_type != &t_void)
3570 {
3571 char *tofree;
3572
3573 msg_puts(": ");
3574 msg_puts(type_name(fp->uf_ret_type, &tofree));
3575 vim_free(tofree);
3576 }
3577 }
3578 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003579 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003581 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003582 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003583 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003584 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003585 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 msg_clr_eos();
3587 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003588 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589}
3590
3591/*
3592 * Get a function name, translating "<SID>" and "<SNR>".
3593 * Also handles a Funcref in a List or Dictionary.
3594 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003595 * Set "*is_global" to TRUE when the function must be global, unless
3596 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 * flags:
3598 * TFN_INT: internal function name OK
3599 * TFN_QUIET: be quiet
3600 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003601 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 * Advances "pp" to just after the function name (if no error).
3603 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003604 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605trans_function_name(
3606 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003607 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003608 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003610 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003611 partial_T **partial, // return: partial of a FuncRef
3612 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613{
3614 char_u *name = NULL;
3615 char_u *start;
3616 char_u *end;
3617 int lead;
3618 char_u sid_buf[20];
3619 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003620 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003622 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003623 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624
3625 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003626 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 start = *pp;
3628
Bram Moolenaare38eab22019-12-05 21:50:01 +01003629 // Check for hard coded <SNR>: already translated function ID (from a user
3630 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3632 && (*pp)[2] == (int)KE_SNR)
3633 {
3634 *pp += 3;
3635 len = get_id_len(pp) + 3;
3636 return vim_strnsave(start, len);
3637 }
3638
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3640 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 lead = eval_fname_script(start);
3642 if (lead > 2)
3643 start += lead;
3644
Bram Moolenaare38eab22019-12-05 21:50:01 +01003645 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003646 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003647 lead > 2 ? 0 : FNE_CHECK_START);
3648 if (end == start)
3649 {
3650 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003651 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 goto theend;
3653 }
3654 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3655 {
3656 /*
3657 * Report an invalid expression in braces, unless the expression
3658 * evaluation has been cancelled due to an aborting error, an
3659 * interrupt, or an exception.
3660 */
3661 if (!aborting())
3662 {
3663 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003664 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 }
3666 else
3667 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3668 goto theend;
3669 }
3670
3671 if (lv.ll_tv != NULL)
3672 {
3673 if (fdp != NULL)
3674 {
3675 fdp->fd_dict = lv.ll_dict;
3676 fdp->fd_newkey = lv.ll_newkey;
3677 lv.ll_newkey = NULL;
3678 fdp->fd_di = lv.ll_di;
3679 }
3680 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3681 {
3682 name = vim_strsave(lv.ll_tv->vval.v_string);
3683 *pp = end;
3684 }
3685 else if (lv.ll_tv->v_type == VAR_PARTIAL
3686 && lv.ll_tv->vval.v_partial != NULL)
3687 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003688 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 *pp = end;
3690 if (partial != NULL)
3691 *partial = lv.ll_tv->vval.v_partial;
3692 }
3693 else
3694 {
3695 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3696 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003697 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 else
3699 *pp = end;
3700 name = NULL;
3701 }
3702 goto theend;
3703 }
3704
3705 if (lv.ll_name == NULL)
3706 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003707 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708 *pp = end;
3709 goto theend;
3710 }
3711
Bram Moolenaare38eab22019-12-05 21:50:01 +01003712 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 if (lv.ll_exp_name != NULL)
3714 {
3715 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003716 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003717 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718 if (name == lv.ll_exp_name)
3719 name = NULL;
3720 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003721 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 {
3723 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003724 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003725 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 if (name == *pp)
3727 name = NULL;
3728 }
3729 if (name != NULL)
3730 {
3731 name = vim_strsave(name);
3732 *pp = end;
3733 if (STRNCMP(name, "<SNR>", 5) == 0)
3734 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003735 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736 name[0] = K_SPECIAL;
3737 name[1] = KS_EXTRA;
3738 name[2] = (int)KE_SNR;
3739 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3740 }
3741 goto theend;
3742 }
3743
3744 if (lv.ll_exp_name != NULL)
3745 {
3746 len = (int)STRLEN(lv.ll_exp_name);
3747 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3748 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3749 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003750 // When there was "s:" already or the name expanded to get a
3751 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 lv.ll_name += 2;
3753 len -= 2;
3754 lead = 2;
3755 }
3756 }
3757 else
3758 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003759 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003761 {
3762 if (is_global != NULL && lv.ll_name[0] == 'g')
3763 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 len = (int)(end - lv.ll_name);
3767 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003768 if (len <= 0)
3769 {
3770 if (!skip)
3771 emsg(_(e_function_name));
3772 goto theend;
3773 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003775 // In Vim9 script a user function is script-local by default, unless it
3776 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003777 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003778 if (vim9script)
3779 {
3780 char_u *p;
3781
3782 // SomeScript#func() is a global function.
3783 for (p = start; *p != NUL && *p != '('; ++p)
3784 if (*p == AUTOLOAD_CHAR)
3785 vim9script = FALSE;
3786 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003787
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 /*
3789 * Copy the function name to allocated memory.
3790 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3791 * Accept <SNR>123_name() outside a script.
3792 */
3793 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003794 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003795 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003797 if (!vim9script)
3798 lead = 3;
3799 if (vim9script || (lv.ll_exp_name != NULL
3800 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 || eval_fname_sid(*pp))
3802 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003803 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003804 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003806 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 goto theend;
3808 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003809 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 if (vim9script)
3811 extra = 3 + (int)STRLEN(sid_buf);
3812 else
3813 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 }
3815 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003816 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3817 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003819 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 start);
3821 goto theend;
3822 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003823 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 {
3825 char_u *cp = vim_strchr(lv.ll_name, ':');
3826
3827 if (cp != NULL && cp < end)
3828 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003829 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 goto theend;
3831 }
3832 }
3833
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 if (name != NULL)
3836 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003837 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 {
3839 name[0] = K_SPECIAL;
3840 name[1] = KS_EXTRA;
3841 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003842 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 STRCPY(name + 3, sid_buf);
3844 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003845 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3846 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 }
3848 *pp = end;
3849
3850theend:
3851 clear_lval(&lv);
3852 return name;
3853}
3854
3855/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003856 * Assuming "name" is the result of trans_function_name() and it was prefixed
3857 * to use the script-local name, return the unmodified name (points into
3858 * "name"). Otherwise return NULL.
3859 * This can be used to first search for a script-local function and fall back
3860 * to the global function if not found.
3861 */
3862 char_u *
3863untrans_function_name(char_u *name)
3864{
3865 char_u *p;
3866
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003867 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003868 {
3869 p = vim_strchr(name, '_');
3870 if (p != NULL)
3871 return p + 1;
3872 }
3873 return NULL;
3874}
3875
3876/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003877 * Call trans_function_name(), except that a lambda is returned as-is.
3878 * Returns the name in allocated memory.
3879 */
3880 char_u *
3881save_function_name(
3882 char_u **name,
3883 int *is_global,
3884 int skip,
3885 int flags,
3886 funcdict_T *fudi)
3887{
3888 char_u *p = *name;
3889 char_u *saved;
3890
3891 if (STRNCMP(p, "<lambda>", 8) == 0)
3892 {
3893 p += 8;
3894 (void)getdigits(&p);
3895 saved = vim_strnsave(*name, p - *name);
3896 if (fudi != NULL)
3897 CLEAR_POINTER(fudi);
3898 }
3899 else
3900 saved = trans_function_name(&p, is_global, skip,
3901 flags, fudi, NULL, NULL);
3902 *name = p;
3903 return saved;
3904}
3905
3906/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003907 * List functions. When "regmatch" is NULL all of then.
3908 * Otherwise functions matching "regmatch".
3909 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003910 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003911list_functions(regmatch_T *regmatch)
3912{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003913 int changed = func_hashtab.ht_changed;
3914 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003915 hashitem_T *hi;
3916
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003917 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003918 {
3919 if (!HASHITEM_EMPTY(hi))
3920 {
3921 ufunc_T *fp = HI2UF(hi);
3922
3923 --todo;
3924 if ((fp->uf_flags & FC_DEAD) == 0
3925 && (regmatch == NULL
3926 ? !message_filtered(fp->uf_name)
3927 && !func_name_refcount(fp->uf_name)
3928 : !isdigit(*fp->uf_name)
3929 && vim_regexec(regmatch, fp->uf_name, 0)))
3930 {
3931 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003932 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003933 {
3934 emsg(_("E454: function list was modified"));
3935 return;
3936 }
3937 }
3938 }
3939 }
3940}
3941
3942/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003943 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003944 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3945 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003946 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003948 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003949define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003951 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 int j;
3953 int c;
3954 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003955 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003956 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 char_u *p;
3958 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003959 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 char_u *line_arg = NULL;
3961 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003962 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003963 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 garray_T newlines;
3965 int varargs = FALSE;
3966 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003967 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003968 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00003969 int fp_allocated = FALSE;
3970 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003971 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003972 dictitem_T *v;
3973 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003974 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003975 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003977 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003978 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003979 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980
3981 /*
3982 * ":function" without argument: list functions.
3983 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003984 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 {
3986 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003987 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003988 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003989 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 }
3991
3992 /*
3993 * ":function /pat": list functions matching pattern.
3994 */
3995 if (*eap->arg == '/')
3996 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003997 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 if (!eap->skip)
3999 {
4000 regmatch_T regmatch;
4001
4002 c = *p;
4003 *p = NUL;
4004 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4005 *p = c;
4006 if (regmatch.regprog != NULL)
4007 {
4008 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004009 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 vim_regfree(regmatch.regprog);
4011 }
4012 }
4013 if (*p == '/')
4014 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004015 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004016 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 }
4018
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004019 ga_init(&newargs);
4020 ga_init(&argtypes);
4021 ga_init(&default_args);
4022
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 /*
4024 * Get the function name. There are these situations:
4025 * func normal function name
4026 * "name" == func, "fudi.fd_dict" == NULL
4027 * dict.func new dictionary entry
4028 * "name" == NULL, "fudi.fd_dict" set,
4029 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4030 * dict.func existing dict entry with a Funcref
4031 * "name" == func, "fudi.fd_dict" set,
4032 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4033 * dict.func existing dict entry that's not a Funcref
4034 * "name" == NULL, "fudi.fd_dict" set,
4035 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4036 * s:func script-local function name
4037 * g:func global function name, same as "func"
4038 */
4039 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004040 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004042 // nested function, argument is (args).
4043 paren = TRUE;
4044 CLEAR_FIELD(fudi);
4045 }
4046 else
4047 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004048 name = save_function_name(&p, &is_global, eap->skip,
4049 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004050 paren = (vim_strchr(p, '(') != NULL);
4051 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004053 /*
4054 * Return on an invalid expression in braces, unless the expression
4055 * evaluation has been cancelled due to an aborting error, an
4056 * interrupt, or an exception.
4057 */
4058 if (!aborting())
4059 {
4060 if (!eap->skip && fudi.fd_newkey != NULL)
4061 semsg(_(e_dictkey), fudi.fd_newkey);
4062 vim_free(fudi.fd_newkey);
4063 return NULL;
4064 }
4065 else
4066 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068 }
4069
Bram Moolenaare38eab22019-12-05 21:50:01 +01004070 // An error in a function call during evaluation of an expression in magic
4071 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 saved_did_emsg = did_emsg;
4073 did_emsg = FALSE;
4074
4075 /*
4076 * ":function func" with only function name: list function.
4077 */
4078 if (!paren)
4079 {
4080 if (!ends_excmd(*skipwhite(p)))
4081 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004082 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004083 goto ret_free;
4084 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004085 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 if (eap->nextcmd != NULL)
4087 *p = NUL;
4088 if (!eap->skip && !got_int)
4089 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004090 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004091 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4092 {
4093 char_u *up = untrans_function_name(name);
4094
4095 // With Vim9 script the name was made script-local, if not
4096 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004097 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004098 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004099 }
4100
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 if (fp != NULL)
4102 {
4103 list_func_head(fp, TRUE);
4104 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4105 {
4106 if (FUNCLINE(fp, j) == NULL)
4107 continue;
4108 msg_putchar('\n');
4109 msg_outnum((long)(j + 1));
4110 if (j < 9)
4111 msg_putchar(' ');
4112 if (j < 99)
4113 msg_putchar(' ');
4114 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004115 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116 ui_breakcheck();
4117 }
4118 if (!got_int)
4119 {
4120 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004121 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004122 msg_puts(" enddef");
4123 else
4124 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004125 }
4126 }
4127 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004128 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 }
4130 goto ret_free;
4131 }
4132
4133 /*
4134 * ":function name(arg1, arg2)" Define function.
4135 */
4136 p = skipwhite(p);
4137 if (*p != '(')
4138 {
4139 if (!eap->skip)
4140 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004141 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142 goto ret_free;
4143 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004144 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 if (vim_strchr(p, '(') != NULL)
4146 p = vim_strchr(p, '(');
4147 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004149 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4150 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004151 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004152 goto ret_free;
4153 }
4154
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004155 // In Vim9 script only global functions can be redefined.
4156 if (vim9script && eap->forceit && !is_global)
4157 {
4158 emsg(_(e_nobang));
4159 goto ret_free;
4160 }
4161
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004162 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163
Bram Moolenaar04b12692020-05-04 23:24:44 +02004164 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004166 // Check the name of the function. Unless it's a dictionary function
4167 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004168 if (name != NULL)
4169 arg = name;
4170 else
4171 arg = fudi.fd_newkey;
4172 if (arg != NULL && (fudi.fd_di == NULL
4173 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4174 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4175 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004176 char_u *name_base = arg;
4177 int i;
4178
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004180 {
4181 name_base = vim_strchr(arg, '_');
4182 if (name_base == NULL)
4183 name_base = arg + 3;
4184 else
4185 ++name_base;
4186 }
4187 for (i = 0; name_base[i] != NUL && (i == 0
4188 ? eval_isnamec1(name_base[i])
4189 : eval_isnamec(name_base[i])); ++i)
4190 ;
4191 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004193
4194 // In Vim9 script a function cannot have the same name as a
4195 // variable.
4196 if (vim9script && *arg == K_SPECIAL
4197 && eval_variable(name_base, STRLEN(name_base), NULL, NULL,
4198 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4199 + EVAL_VAR_NO_FUNC) == OK)
4200 {
4201 semsg(_(e_redefining_script_item_str), name_base);
4202 goto ret_free;
4203 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004205 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004207 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004208 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004209 goto ret_free;
4210 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 }
4212
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004213 // This may get more lines and make the pointers into the first line
4214 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004215 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004216 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004217 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004218 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004219 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004221 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004223 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004224 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004225 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004226 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004228 if (*p != ':')
4229 {
4230 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4231 p = skipwhite(p);
4232 }
4233 else if (!IS_WHITE_OR_NUL(p[1]))
4234 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004235 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004236 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004237 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004238 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004239 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004240 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004241 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004242 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004243 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004244 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004245 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004246 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004247 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004249 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004251 else
4252 // find extra arguments "range", "dict", "abort" and "closure"
4253 for (;;)
4254 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004255 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004256 p = skipwhite(p);
4257 if (STRNCMP(p, "range", 5) == 0)
4258 {
4259 flags |= FC_RANGE;
4260 p += 5;
4261 }
4262 else if (STRNCMP(p, "dict", 4) == 0)
4263 {
4264 flags |= FC_DICT;
4265 p += 4;
4266 }
4267 else if (STRNCMP(p, "abort", 5) == 0)
4268 {
4269 flags |= FC_ABORT;
4270 p += 5;
4271 }
4272 else if (STRNCMP(p, "closure", 7) == 0)
4273 {
4274 flags |= FC_CLOSURE;
4275 p += 7;
4276 if (current_funccal == NULL)
4277 {
4278 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4279 name == NULL ? (char_u *)"" : name);
4280 goto erret;
4281 }
4282 }
4283 else
4284 break;
4285 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286
Bram Moolenaare38eab22019-12-05 21:50:01 +01004287 // When there is a line break use what follows for the function body.
4288 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 if (*p == '\n')
4290 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004291 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004292 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4293 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004294 && !(VIM_ISWHITE(*whitep) && *p == '#'
4295 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004296 && !eap->skip
4297 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004298 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299
4300 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004301 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4302 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 */
4304 if (KeyTyped)
4305 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004306 // Check if the function already exists, don't let the user type the
4307 // whole function before telling him it doesn't work! For a script we
4308 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 if (!eap->skip && !eap->forceit)
4310 {
4311 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004312 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004313 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 emsg_funcname(e_funcexts, name);
4315 }
4316
4317 if (!eap->skip && did_emsg)
4318 goto erret;
4319
Bram Moolenaare38eab22019-12-05 21:50:01 +01004320 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 cmdline_row = msg_row;
4322 }
4323
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004324 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004325 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004326
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004327 // Do not define the function when getting the body fails and when
4328 // skipping.
4329 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4330 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331 goto erret;
4332
4333 /*
4334 * If there are no errors, add the function
4335 */
4336 if (fudi.fd_dict == NULL)
4337 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004338 hashtab_T *ht;
4339
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004340 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4342 {
4343 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4344 name);
4345 goto erret;
4346 }
4347
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004348 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004349 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004350 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004351 char_u *uname = untrans_function_name(name);
4352
4353 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4354 }
4355
4356 if (fp != NULL || import != NULL)
4357 {
4358 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004359
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004360 // Function can be replaced with "function!" and when sourcing the
4361 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004362 // A name that is used by an import can not be overruled.
4363 if (import != NULL
4364 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004365 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004366 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004368 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004369 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004370 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004371 else
4372 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004373 goto erret;
4374 }
4375 if (fp->uf_calls > 0)
4376 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004377 emsg_funcname(
4378 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379 name);
4380 goto erret;
4381 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004382 if (fp->uf_refcount > 1)
4383 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004384 // This function is referenced somewhere, don't redefine it but
4385 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004386 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004387 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004388 fp = NULL;
4389 overwrite = TRUE;
4390 }
4391 else
4392 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004393 char_u *exp_name = fp->uf_name_exp;
4394
4395 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004396 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004397 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004398 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004399 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004400 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004401#ifdef FEAT_PROFILE
4402 fp->uf_profiling = FALSE;
4403 fp->uf_prof_initialized = FALSE;
4404#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004405 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004406 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 }
4408 }
4409 else
4410 {
4411 char numbuf[20];
4412
4413 fp = NULL;
4414 if (fudi.fd_newkey == NULL && !eap->forceit)
4415 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004416 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004417 goto erret;
4418 }
4419 if (fudi.fd_di == NULL)
4420 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004421 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004422 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 goto erret;
4424 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004425 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004426 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 goto erret;
4428
Bram Moolenaare38eab22019-12-05 21:50:01 +01004429 // Give the function a sequential number. Can only be used with a
4430 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 vim_free(name);
4432 sprintf(numbuf, "%d", ++func_nr);
4433 name = vim_strsave((char_u *)numbuf);
4434 if (name == NULL)
4435 goto erret;
4436 }
4437
4438 if (fp == NULL)
4439 {
4440 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4441 {
4442 int slen, plen;
4443 char_u *scriptname;
4444
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004447 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448 {
4449 scriptname = autoload_name(name);
4450 if (scriptname != NULL)
4451 {
4452 p = vim_strchr(scriptname, '/');
4453 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004454 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004456 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 j = OK;
4458 vim_free(scriptname);
4459 }
4460 }
4461 if (j == FAIL)
4462 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004463 linenr_T save_lnum = SOURCING_LNUM;
4464
4465 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004466 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004467 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 goto erret;
4469 }
4470 }
4471
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004472 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 if (fp == NULL)
4474 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004475 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476
4477 if (fudi.fd_dict != NULL)
4478 {
4479 if (fudi.fd_di == NULL)
4480 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004481 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4483 if (fudi.fd_di == NULL)
4484 {
4485 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004486 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 goto erret;
4488 }
4489 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4490 {
4491 vim_free(fudi.fd_di);
4492 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004493 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 goto erret;
4495 }
4496 }
4497 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004498 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 clear_tv(&fudi.fd_di->di_tv);
4500 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502
Bram Moolenaare38eab22019-12-05 21:50:01 +01004503 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 flags |= FC_DICT;
4505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 }
4507 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004508 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004509 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004510 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004511
4512 if (eap->cmdidx == CMD_def)
4513 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004514 int lnum_save = SOURCING_LNUM;
4515 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004516
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004517 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004518
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004519 // error messages are for the first function line
4520 SOURCING_LNUM = sourcing_lnum_top;
4521
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004522 // The function may use script variables from the context.
4523 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004524
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004525 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004526 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004527 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004528 free_fp = fp_allocated;
4529 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004530 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004531 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004532
4533 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004534 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004535 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004536 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004537 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004538 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004539 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004540 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004541 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004542 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004543 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004544
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004545 if (fp_allocated)
4546 {
4547 // insert the new function in the function list
4548 set_ufunc_name(fp, name);
4549 if (overwrite)
4550 {
4551 hi = hash_find(&func_hashtab, name);
4552 hi->hi_key = UF2HIKEY(fp);
4553 }
4554 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4555 {
4556 free_fp = TRUE;
4557 goto erret;
4558 }
4559 fp->uf_refcount = 1;
4560 }
4561
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004563 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004564 if ((flags & FC_CLOSURE) != 0)
4565 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004566 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004567 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004568 }
4569 else
4570 fp->uf_scoped = NULL;
4571
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 if (prof_def_func())
4574 func_do_profile(fp);
4575#endif
4576 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004577 if (sandbox)
4578 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004579 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004580 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 fp->uf_flags = flags;
4582 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004583 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004584 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004585 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004586 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004587 if (is_export)
4588 {
4589 fp->uf_flags |= FC_EXPORT;
4590 // let ex_export() know the export worked.
4591 is_export = FALSE;
4592 }
4593
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004594 if (eap->cmdidx == CMD_def)
4595 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004596 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4597 // :func does not use Vim9 script syntax, even in a Vim9 script file
4598 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004599
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 goto ret_free;
4601
4602erret:
4603 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004604 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004605 if (fp != NULL)
4606 {
4607 ga_init(&fp->uf_args);
4608 ga_init(&fp->uf_def_args);
4609 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610errret_2:
4611 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004612 if (fp != NULL)
4613 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004614 if (free_fp)
4615 {
4616 vim_free(fp);
4617 fp = NULL;
4618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004620 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004621 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004623 if (name != name_arg)
4624 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004625 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004627
4628 return fp;
4629}
4630
4631/*
4632 * ":function"
4633 */
4634 void
4635ex_function(exarg_T *eap)
4636{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004637 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004638}
4639
4640/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004641 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004642 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004643 */
4644 void
4645ex_defcompile(exarg_T *eap UNUSED)
4646{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004647 long todo = (long)func_hashtab.ht_used;
4648 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004649 hashitem_T *hi;
4650 ufunc_T *ufunc;
4651
4652 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4653 {
4654 if (!HASHITEM_EMPTY(hi))
4655 {
4656 --todo;
4657 ufunc = HI2UF(hi);
4658 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004659 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4660 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004661 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004662 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004663
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004664 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004665 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004666 // a function has been added or removed, need to start over
4667 todo = (long)func_hashtab.ht_used;
4668 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004669 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004670 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004671 }
4672 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004673 }
4674 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675}
4676
4677/*
4678 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4679 * Return 2 if "p" starts with "s:".
4680 * Return 0 otherwise.
4681 */
4682 int
4683eval_fname_script(char_u *p)
4684{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004685 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4686 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4688 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4689 return 5;
4690 if (p[0] == 's' && p[1] == ':')
4691 return 2;
4692 return 0;
4693}
4694
4695 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004696translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697{
4698 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004699 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004700 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004701}
4702
4703/*
4704 * Return TRUE when "ufunc" has old-style "..." varargs
4705 * or named varargs "...name: type".
4706 */
4707 int
4708has_varargs(ufunc_T *ufunc)
4709{
4710 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711}
4712
4713/*
4714 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004715 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004716 */
4717 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004718function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719{
4720 char_u *nm = name;
4721 char_u *p;
4722 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004723 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004724 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004726 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4727 if (no_deref)
4728 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004729 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 nm = skipwhite(nm);
4731
Bram Moolenaare38eab22019-12-05 21:50:01 +01004732 // Only accept "funcname", "funcname ", "funcname (..." and
4733 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004735 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004736 vim_free(p);
4737 return n;
4738}
4739
Bram Moolenaar113e1072019-01-20 15:30:40 +01004740#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004741 char_u *
4742get_expanded_name(char_u *name, int check)
4743{
4744 char_u *nm = name;
4745 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004746 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004748 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004749 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004751 if (p != NULL && *nm == NUL
4752 && (!check || translated_function_exists(p, is_global)))
4753 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754
4755 vim_free(p);
4756 return NULL;
4757}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004758#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004760/*
4761 * Function given to ExpandGeneric() to obtain the list of user defined
4762 * function names.
4763 */
4764 char_u *
4765get_user_func_name(expand_T *xp, int idx)
4766{
4767 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004768 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 static hashitem_T *hi;
4770 ufunc_T *fp;
4771
4772 if (idx == 0)
4773 {
4774 done = 0;
4775 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004776 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004778 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004779 {
4780 if (done++ > 0)
4781 ++hi;
4782 while (HASHITEM_EMPTY(hi))
4783 ++hi;
4784 fp = HI2UF(hi);
4785
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004786 // don't show dead, dict and lambda functions
4787 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004788 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004789 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790
4791 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004792 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793
4794 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004795 if (xp->xp_context != EXPAND_USER_FUNC
4796 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797 {
4798 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004799 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 STRCAT(IObuff, ")");
4801 }
4802 return IObuff;
4803 }
4804 return NULL;
4805}
4806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807/*
4808 * ":delfunction {name}"
4809 */
4810 void
4811ex_delfunction(exarg_T *eap)
4812{
4813 ufunc_T *fp = NULL;
4814 char_u *p;
4815 char_u *name;
4816 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004817 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818
4819 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004820 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4821 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822 vim_free(fudi.fd_newkey);
4823 if (name == NULL)
4824 {
4825 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004826 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 return;
4828 }
4829 if (!ends_excmd(*skipwhite(p)))
4830 {
4831 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004832 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 return;
4834 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004835 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 if (eap->nextcmd != NULL)
4837 *p = NUL;
4838
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004839 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004840 {
4841 if (!eap->skip)
4842 semsg(_(e_invarg2), eap->arg);
4843 vim_free(name);
4844 return;
4845 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004846 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004847 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 vim_free(name);
4849
4850 if (!eap->skip)
4851 {
4852 if (fp == NULL)
4853 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004854 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004855 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004856 return;
4857 }
4858 if (fp->uf_calls > 0)
4859 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004860 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004861 return;
4862 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004863 if (fp->uf_flags & FC_VIM9)
4864 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004865 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004866 return;
4867 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004868
4869 if (fudi.fd_dict != NULL)
4870 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004871 // Delete the dict item that refers to the function, it will
4872 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4874 }
4875 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004876 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004877 // A normal function (not a numbered function or lambda) has a
4878 // refcount of 1 for the entry in the hashtable. When deleting
4879 // it and the refcount is more than one, it should be kept.
4880 // A numbered function and lambda should be kept if the refcount is
4881 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004882 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004883 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004884 // Function is still referenced somewhere. Don't free it but
4885 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004886 if (func_remove(fp))
4887 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004888 }
4889 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004890 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004891 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 }
4893}
4894
4895/*
4896 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004897 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 */
4899 void
4900func_unref(char_u *name)
4901{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004902 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004904 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004906 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004907 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004909#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004910 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004912 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004914 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004915}
4916
4917/*
4918 * Unreference a Function: decrement the reference count and free it when it
4919 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004920 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004921 */
4922 void
4923func_ptr_unref(ufunc_T *fp)
4924{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004925 if (fp != NULL && (--fp->uf_refcount <= 0
4926 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4927 && fp->uf_partial->pt_refcount <= 1
4928 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004929 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004930 // Only delete it when it's not being used. Otherwise it's done
4931 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004932 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004933 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934 }
4935}
4936
4937/*
4938 * Count a reference to a Function.
4939 */
4940 void
4941func_ref(char_u *name)
4942{
4943 ufunc_T *fp;
4944
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004945 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004947 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004948 if (fp != NULL)
4949 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004950 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004951 // Only give an error for a numbered function.
4952 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004953 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004954}
4955
4956/*
4957 * Count a reference to a Function.
4958 */
4959 void
4960func_ptr_ref(ufunc_T *fp)
4961{
4962 if (fp != NULL)
4963 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004964}
4965
4966/*
4967 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4968 * referenced from anywhere that is in use.
4969 */
4970 static int
4971can_free_funccal(funccall_T *fc, int copyID)
4972{
4973 return (fc->l_varlist.lv_copyID != copyID
4974 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004975 && fc->l_avars.dv_copyID != copyID
4976 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977}
4978
4979/*
4980 * ":return [expr]"
4981 */
4982 void
4983ex_return(exarg_T *eap)
4984{
4985 char_u *arg = eap->arg;
4986 typval_T rettv;
4987 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004988 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004989
4990 if (current_funccal == NULL)
4991 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004992 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993 return;
4994 }
4995
Bram Moolenaar844fb642021-10-23 13:32:30 +01004996 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004997 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4998
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004999 if (eap->skip)
5000 ++emsg_skip;
5001
5002 eap->nextcmd = NULL;
5003 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005004 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005 {
5006 if (!eap->skip)
5007 returning = do_return(eap, FALSE, TRUE, &rettv);
5008 else
5009 clear_tv(&rettv);
5010 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005011 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012 else if (!eap->skip)
5013 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005014 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005015 update_force_abort();
5016
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017 /*
5018 * Return unless the expression evaluation has been cancelled due to an
5019 * aborting error, an interrupt, or an exception.
5020 */
5021 if (!aborting())
5022 returning = do_return(eap, FALSE, TRUE, NULL);
5023 }
5024
Bram Moolenaare38eab22019-12-05 21:50:01 +01005025 // When skipping or the return gets pending, advance to the next command
5026 // in this line (!returning). Otherwise, ignore the rest of the line.
5027 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 if (returning)
5029 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005030 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005031 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032
5033 if (eap->skip)
5034 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005035 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005036}
5037
5038/*
5039 * ":1,25call func(arg1, arg2)" function call.
5040 */
5041 void
5042ex_call(exarg_T *eap)
5043{
5044 char_u *arg = eap->arg;
5045 char_u *startarg;
5046 char_u *name;
5047 char_u *tofree;
5048 int len;
5049 typval_T rettv;
5050 linenr_T lnum;
5051 int doesrange;
5052 int failed = FALSE;
5053 funcdict_T fudi;
5054 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005055 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005056 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005057 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058
Bram Moolenaare6b53242020-07-01 17:28:33 +02005059 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060 if (eap->skip)
5061 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005062 // trans_function_name() doesn't work well when skipping, use eval0()
5063 // instead to skip to any following command, e.g. for:
5064 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005066 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 clear_tv(&rettv);
5068 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005069 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070 return;
5071 }
5072
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005073 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5074 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005075 if (fudi.fd_newkey != NULL)
5076 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005077 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005078 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079 vim_free(fudi.fd_newkey);
5080 }
5081 if (tofree == NULL)
5082 return;
5083
Bram Moolenaare38eab22019-12-05 21:50:01 +01005084 // Increase refcount on dictionary, it could get deleted when evaluating
5085 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005086 if (fudi.fd_dict != NULL)
5087 ++fudi.fd_dict->dv_refcount;
5088
Bram Moolenaare38eab22019-12-05 21:50:01 +01005089 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5090 // contents. For VAR_PARTIAL get its partial, unless we already have one
5091 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005092 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005093 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005094 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005095
Bram Moolenaare38eab22019-12-05 21:50:01 +01005096 // Skip white space to allow ":call func ()". Not good, but required for
5097 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005098 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005099 if (*startarg != '(')
5100 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005101 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102 goto end;
5103 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005104 if (in_vim9script() && startarg > arg)
5105 {
5106 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5107 goto end;
5108 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109
5110 /*
5111 * When skipping, evaluate the function once, to find the end of the
5112 * arguments.
5113 * When the function takes a range, this is discovered after the first
5114 * call, and the loop is broken.
5115 */
5116 if (eap->skip)
5117 {
5118 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005119 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005120 }
5121 else
5122 lnum = eap->line1;
5123 for ( ; lnum <= eap->line2; ++lnum)
5124 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005125 funcexe_T funcexe;
5126
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127 if (!eap->skip && eap->addr_count > 0)
5128 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005129 if (lnum > curbuf->b_ml.ml_line_count)
5130 {
5131 // If the function deleted lines or switched to another buffer
5132 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005133 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005134 break;
5135 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136 curwin->w_cursor.lnum = lnum;
5137 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005139 }
5140 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005141
Bram Moolenaara80faa82020-04-12 19:37:17 +02005142 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005143 funcexe.fe_firstline = eap->line1;
5144 funcexe.fe_lastline = eap->line2;
5145 funcexe.fe_doesrange = &doesrange;
5146 funcexe.fe_evaluate = !eap->skip;
5147 funcexe.fe_partial = partial;
5148 funcexe.fe_selfdict = fudi.fd_dict;
5149 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005150 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005151 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005152 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 {
5154 failed = TRUE;
5155 break;
5156 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005157 if (has_watchexpr())
5158 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005160 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005161 if (handle_subscript(&arg, &rettv,
5162 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005163 {
5164 failed = TRUE;
5165 break;
5166 }
5167
5168 clear_tv(&rettv);
5169 if (doesrange || eap->skip)
5170 break;
5171
Bram Moolenaare38eab22019-12-05 21:50:01 +01005172 // Stop when immediately aborting on error, or when an interrupt
5173 // occurred or an exception was thrown but not caught.
5174 // get_func_tv() returned OK, so that the check for trailing
5175 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005176 if (aborting())
5177 break;
5178 }
5179 if (eap->skip)
5180 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005181 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005182
Bram Moolenaar1d341892021-09-18 15:25:52 +02005183 // When inside :try we need to check for following "| catch" or "| endtry".
5184 // Not when there was an error, but do check if an exception was thrown.
5185 if ((!aborting() || did_throw)
5186 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005187 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005188 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005189 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005190 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005191 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005192 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005193 {
5194 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005195 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005196 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005197 }
5198 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005199 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200 }
5201
5202end:
5203 dict_unref(fudi.fd_dict);
5204 vim_free(tofree);
5205}
5206
5207/*
5208 * Return from a function. Possibly makes the return pending. Also called
5209 * for a pending return at the ":endtry" or after returning from an extra
5210 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5211 * when called due to a ":return" command. "rettv" may point to a typval_T
5212 * with the return rettv. Returns TRUE when the return can be carried out,
5213 * FALSE when the return gets pending.
5214 */
5215 int
5216do_return(
5217 exarg_T *eap,
5218 int reanimate,
5219 int is_cmd,
5220 void *rettv)
5221{
5222 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005223 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224
5225 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005226 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005227 current_funccal->returned = FALSE;
5228
5229 /*
5230 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5231 * not in its finally clause (which then is to be executed next) is found.
5232 * In this case, make the ":return" pending for execution at the ":endtry".
5233 * Otherwise, return normally.
5234 */
5235 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5236 if (idx >= 0)
5237 {
5238 cstack->cs_pending[idx] = CSTP_RETURN;
5239
5240 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005241 // A pending return again gets pending. "rettv" points to an
5242 // allocated variable with the rettv of the original ":return"'s
5243 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005244 cstack->cs_rettv[idx] = rettv;
5245 else
5246 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005247 // When undoing a return in order to make it pending, get the stored
5248 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249 if (reanimate)
5250 rettv = current_funccal->rettv;
5251
5252 if (rettv != NULL)
5253 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005254 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005255 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5256 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5257 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005258 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005259 }
5260 else
5261 cstack->cs_rettv[idx] = NULL;
5262
5263 if (reanimate)
5264 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005265 // The pending return value could be overwritten by a ":return"
5266 // without argument in a finally clause; reset the default
5267 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268 current_funccal->rettv->v_type = VAR_NUMBER;
5269 current_funccal->rettv->vval.v_number = 0;
5270 }
5271 }
5272 report_make_pending(CSTP_RETURN, rettv);
5273 }
5274 else
5275 {
5276 current_funccal->returned = TRUE;
5277
Bram Moolenaare38eab22019-12-05 21:50:01 +01005278 // If the return is carried out now, store the return value. For
5279 // a return immediately after reanimation, the value is already
5280 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281 if (!reanimate && rettv != NULL)
5282 {
5283 clear_tv(current_funccal->rettv);
5284 *current_funccal->rettv = *(typval_T *)rettv;
5285 if (!is_cmd)
5286 vim_free(rettv);
5287 }
5288 }
5289
5290 return idx < 0;
5291}
5292
5293/*
5294 * Free the variable with a pending return value.
5295 */
5296 void
5297discard_pending_return(void *rettv)
5298{
5299 free_tv((typval_T *)rettv);
5300}
5301
5302/*
5303 * Generate a return command for producing the value of "rettv". The result
5304 * is an allocated string. Used by report_pending() for verbose messages.
5305 */
5306 char_u *
5307get_return_cmd(void *rettv)
5308{
5309 char_u *s = NULL;
5310 char_u *tofree = NULL;
5311 char_u numbuf[NUMBUFLEN];
5312
5313 if (rettv != NULL)
5314 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5315 if (s == NULL)
5316 s = (char_u *)"";
5317
5318 STRCPY(IObuff, ":return ");
5319 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5320 if (STRLEN(s) + 8 >= IOSIZE)
5321 STRCPY(IObuff + IOSIZE - 4, "...");
5322 vim_free(tofree);
5323 return vim_strsave(IObuff);
5324}
5325
5326/*
5327 * Get next function line.
5328 * Called by do_cmdline() to get the next line.
5329 * Returns allocated string, or NULL for end of function.
5330 */
5331 char_u *
5332get_func_line(
5333 int c UNUSED,
5334 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005335 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005336 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337{
5338 funccall_T *fcp = (funccall_T *)cookie;
5339 ufunc_T *fp = fcp->func;
5340 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005341 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342
Bram Moolenaare38eab22019-12-05 21:50:01 +01005343 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005344 if (fcp->dbg_tick != debug_tick)
5345 {
5346 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005347 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 fcp->dbg_tick = debug_tick;
5349 }
5350#ifdef FEAT_PROFILE
5351 if (do_profiling == PROF_YES)
5352 func_line_end(cookie);
5353#endif
5354
5355 gap = &fp->uf_lines;
5356 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5357 || fcp->returned)
5358 retval = NULL;
5359 else
5360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005361 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005362 while (fcp->linenr < gap->ga_len
5363 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5364 ++fcp->linenr;
5365 if (fcp->linenr >= gap->ga_len)
5366 retval = NULL;
5367 else
5368 {
5369 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005370 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005371#ifdef FEAT_PROFILE
5372 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005373 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005374#endif
5375 }
5376 }
5377
Bram Moolenaare38eab22019-12-05 21:50:01 +01005378 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005379 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005380 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005381 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005382 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005383 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005384 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385 fcp->dbg_tick = debug_tick;
5386 }
5387
5388 return retval;
5389}
5390
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005391/*
5392 * Return TRUE if the currently active function should be ended, because a
5393 * return was encountered or an error occurred. Used inside a ":while".
5394 */
5395 int
5396func_has_ended(void *cookie)
5397{
5398 funccall_T *fcp = (funccall_T *)cookie;
5399
Bram Moolenaare38eab22019-12-05 21:50:01 +01005400 // Ignore the "abort" flag if the abortion behavior has been changed due to
5401 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005402 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5403 || fcp->returned);
5404}
5405
5406/*
5407 * return TRUE if cookie indicates a function which "abort"s on errors.
5408 */
5409 int
5410func_has_abort(
5411 void *cookie)
5412{
5413 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5414}
5415
5416
5417/*
5418 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5419 * Don't do this when "Func" is already a partial that was bound
5420 * explicitly (pt_auto is FALSE).
5421 * Changes "rettv" in-place.
5422 * Returns the updated "selfdict_in".
5423 */
5424 dict_T *
5425make_partial(dict_T *selfdict_in, typval_T *rettv)
5426{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005427 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005428 char_u *tofree = NULL;
5429 ufunc_T *fp;
5430 char_u fname_buf[FLEN_FIXED + 1];
5431 int error;
5432 dict_T *selfdict = selfdict_in;
5433
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005434 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5435 fp = rettv->vval.v_partial->pt_func;
5436 else
5437 {
5438 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5439 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005440 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005441 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005442 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005443 vim_free(tofree);
5444 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005445
5446 if (fp != NULL && (fp->uf_flags & FC_DICT))
5447 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005448 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005449
5450 if (pt != NULL)
5451 {
5452 pt->pt_refcount = 1;
5453 pt->pt_dict = selfdict;
5454 pt->pt_auto = TRUE;
5455 selfdict = NULL;
5456 if (rettv->v_type == VAR_FUNC)
5457 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005458 // Just a function: Take over the function name and use
5459 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460 pt->pt_name = rettv->vval.v_string;
5461 }
5462 else
5463 {
5464 partial_T *ret_pt = rettv->vval.v_partial;
5465 int i;
5466
Bram Moolenaare38eab22019-12-05 21:50:01 +01005467 // Partial: copy the function name, use selfdict and copy
5468 // args. Can't take over name or args, the partial might
5469 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005470 if (ret_pt->pt_name != NULL)
5471 {
5472 pt->pt_name = vim_strsave(ret_pt->pt_name);
5473 func_ref(pt->pt_name);
5474 }
5475 else
5476 {
5477 pt->pt_func = ret_pt->pt_func;
5478 func_ptr_ref(pt->pt_func);
5479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005480 if (ret_pt->pt_argc > 0)
5481 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005482 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005483 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005484 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005485 pt->pt_argc = 0;
5486 else
5487 {
5488 pt->pt_argc = ret_pt->pt_argc;
5489 for (i = 0; i < pt->pt_argc; i++)
5490 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5491 }
5492 }
5493 partial_unref(ret_pt);
5494 }
5495 rettv->v_type = VAR_PARTIAL;
5496 rettv->vval.v_partial = pt;
5497 }
5498 }
5499 return selfdict;
5500}
5501
5502/*
5503 * Return the name of the executed function.
5504 */
5505 char_u *
5506func_name(void *cookie)
5507{
5508 return ((funccall_T *)cookie)->func->uf_name;
5509}
5510
5511/*
5512 * Return the address holding the next breakpoint line for a funccall cookie.
5513 */
5514 linenr_T *
5515func_breakpoint(void *cookie)
5516{
5517 return &((funccall_T *)cookie)->breakpoint;
5518}
5519
5520/*
5521 * Return the address holding the debug tick for a funccall cookie.
5522 */
5523 int *
5524func_dbg_tick(void *cookie)
5525{
5526 return &((funccall_T *)cookie)->dbg_tick;
5527}
5528
5529/*
5530 * Return the nesting level for a funccall cookie.
5531 */
5532 int
5533func_level(void *cookie)
5534{
5535 return ((funccall_T *)cookie)->level;
5536}
5537
5538/*
5539 * Return TRUE when a function was ended by a ":return" command.
5540 */
5541 int
5542current_func_returned(void)
5543{
5544 return current_funccal->returned;
5545}
5546
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005547 int
5548free_unref_funccal(int copyID, int testing)
5549{
5550 int did_free = FALSE;
5551 int did_free_funccal = FALSE;
5552 funccall_T *fc, **pfc;
5553
5554 for (pfc = &previous_funccal; *pfc != NULL; )
5555 {
5556 if (can_free_funccal(*pfc, copyID))
5557 {
5558 fc = *pfc;
5559 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005560 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005561 did_free = TRUE;
5562 did_free_funccal = TRUE;
5563 }
5564 else
5565 pfc = &(*pfc)->caller;
5566 }
5567 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005568 // When a funccal was freed some more items might be garbage
5569 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005570 (void)garbage_collect(testing);
5571
5572 return did_free;
5573}
5574
5575/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005576 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 */
5578 static funccall_T *
5579get_funccal(void)
5580{
5581 int i;
5582 funccall_T *funccal;
5583 funccall_T *temp_funccal;
5584
5585 funccal = current_funccal;
5586 if (debug_backtrace_level > 0)
5587 {
5588 for (i = 0; i < debug_backtrace_level; i++)
5589 {
5590 temp_funccal = funccal->caller;
5591 if (temp_funccal)
5592 funccal = temp_funccal;
5593 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005594 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005595 debug_backtrace_level = i;
5596 }
5597 }
5598 return funccal;
5599}
5600
5601/*
5602 * Return the hashtable used for local variables in the current funccal.
5603 * Return NULL if there is no current funccal.
5604 */
5605 hashtab_T *
5606get_funccal_local_ht()
5607{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005608 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005609 return NULL;
5610 return &get_funccal()->l_vars.dv_hashtab;
5611}
5612
5613/*
5614 * Return the l: scope variable.
5615 * Return NULL if there is no current funccal.
5616 */
5617 dictitem_T *
5618get_funccal_local_var()
5619{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005620 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005621 return NULL;
5622 return &get_funccal()->l_vars_var;
5623}
5624
5625/*
5626 * Return the hashtable used for argument in the current funccal.
5627 * Return NULL if there is no current funccal.
5628 */
5629 hashtab_T *
5630get_funccal_args_ht()
5631{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005632 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005633 return NULL;
5634 return &get_funccal()->l_avars.dv_hashtab;
5635}
5636
5637/*
5638 * Return the a: scope variable.
5639 * Return NULL if there is no current funccal.
5640 */
5641 dictitem_T *
5642get_funccal_args_var()
5643{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005644 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005645 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005646 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005647}
5648
5649/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005650 * List function variables, if there is a function.
5651 */
5652 void
5653list_func_vars(int *first)
5654{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005655 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005656 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005657 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005658}
5659
5660/*
5661 * If "ht" is the hashtable for local variables in the current funccal, return
5662 * the dict that contains it.
5663 * Otherwise return NULL.
5664 */
5665 dict_T *
5666get_current_funccal_dict(hashtab_T *ht)
5667{
5668 if (current_funccal != NULL
5669 && ht == &current_funccal->l_vars.dv_hashtab)
5670 return &current_funccal->l_vars;
5671 return NULL;
5672}
5673
5674/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005675 * Search hashitem in parent scope.
5676 */
5677 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005678find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005679{
5680 funccall_T *old_current_funccal = current_funccal;
5681 hashtab_T *ht;
5682 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005683 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005684
5685 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5686 return NULL;
5687
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005688 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005689 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005690 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005691 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005692 ht = find_var_ht(name, &varname);
5693 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005694 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005695 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005696 if (!HASHITEM_EMPTY(hi))
5697 {
5698 *pht = ht;
5699 break;
5700 }
5701 }
5702 if (current_funccal == current_funccal->func->uf_scoped)
5703 break;
5704 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005705 }
5706 current_funccal = old_current_funccal;
5707
5708 return hi;
5709}
5710
5711/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005712 * Search variable in parent scope.
5713 */
5714 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005715find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005716{
5717 dictitem_T *v = NULL;
5718 funccall_T *old_current_funccal = current_funccal;
5719 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005720 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005721
5722 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5723 return NULL;
5724
Bram Moolenaare38eab22019-12-05 21:50:01 +01005725 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005726 current_funccal = current_funccal->func->uf_scoped;
5727 while (current_funccal)
5728 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005729 ht = find_var_ht(name, &varname);
5730 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005731 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005732 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005733 if (v != NULL)
5734 break;
5735 }
5736 if (current_funccal == current_funccal->func->uf_scoped)
5737 break;
5738 current_funccal = current_funccal->func->uf_scoped;
5739 }
5740 current_funccal = old_current_funccal;
5741
5742 return v;
5743}
5744
5745/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005746 * Set "copyID + 1" in previous_funccal and callers.
5747 */
5748 int
5749set_ref_in_previous_funccal(int copyID)
5750{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005751 funccall_T *fc;
5752
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005753 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005754 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005755 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005756 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5757 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5758 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5759 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005760 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005761 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005762}
5763
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005764 static int
5765set_ref_in_funccal(funccall_T *fc, int copyID)
5766{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005767 if (fc->fc_copyID != copyID)
5768 {
5769 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005770 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5771 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5772 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5773 || set_ref_in_func(NULL, fc->func, copyID))
5774 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005775 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005776 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005777}
5778
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005779/*
5780 * Set "copyID" in all local vars and arguments in the call stack.
5781 */
5782 int
5783set_ref_in_call_stack(int copyID)
5784{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005785 funccall_T *fc;
5786 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005787
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005788 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5789 if (set_ref_in_funccal(fc, copyID))
5790 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005791
5792 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005793 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5794 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5795 if (set_ref_in_funccal(fc, copyID))
5796 return TRUE;
5797 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005798}
5799
5800/*
5801 * Set "copyID" in all functions available by name.
5802 */
5803 int
5804set_ref_in_functions(int copyID)
5805{
5806 int todo;
5807 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005808 ufunc_T *fp;
5809
5810 todo = (int)func_hashtab.ht_used;
5811 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005812 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005813 if (!HASHITEM_EMPTY(hi))
5814 {
5815 --todo;
5816 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005817 if (!func_name_refcount(fp->uf_name)
5818 && set_ref_in_func(NULL, fp, copyID))
5819 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005820 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005821 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005822 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005823}
5824
5825/*
5826 * Set "copyID" in all function arguments.
5827 */
5828 int
5829set_ref_in_func_args(int copyID)
5830{
5831 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005832
5833 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005834 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5835 copyID, NULL, NULL))
5836 return TRUE;
5837 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005838}
5839
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005840/*
5841 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005842 * Returns TRUE if setting references failed somehow.
5843 */
5844 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005845set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005846{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005847 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005848 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005849 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005850 char_u fname_buf[FLEN_FIXED + 1];
5851 char_u *tofree = NULL;
5852 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005853 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005854
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005855 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005856 return FALSE;
5857
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005858 if (fp_in == NULL)
5859 {
5860 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005861 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005862 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005863 if (fp != NULL)
5864 {
5865 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005866 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005867 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005868
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005869 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005870 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005871}
5872
Bram Moolenaare38eab22019-12-05 21:50:01 +01005873#endif // FEAT_EVAL