blob: 602d3b79e1e50826e91c55617fb707f5f037b503 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
526 fp->uf_flags = FC_CFUNC;
527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
622function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623{
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643}
644
645/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200647 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
652get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657{
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664#define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200666 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100675 char_u *heredoc_trimmed = NULL;
676
Bram Moolenaar20677332021-06-06 17:02:53 +0200677 ga_init2(&heredoc_ga, 1, 500);
678
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
723 vim_free(*line_to_free);
724 if (eap->getline == NULL)
725 theline = getcmdline(':', 0L, indent, getline_options);
726 else
727 theline = eap->getline(':', eap->cookie, indent,
728 getline_options);
729 *line_to_free = theline;
730 }
731 if (KeyTyped)
732 lines_left = Rows - 1;
733 if (theline == NULL)
734 {
735 // Use the start of the function for the line number.
736 SOURCING_LNUM = sourcing_lnum_top;
737 if (skip_until != NULL)
738 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200739 else if (nesting_inline[nesting])
740 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100741 else if (eap->cmdidx == CMD_def)
742 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100743 else
744 emsg(_("E126: Missing :endfunction"));
745 goto theend;
746 }
747
748 // Detect line continuation: SOURCING_LNUM increased more than one.
749 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
750 if (SOURCING_LNUM < sourcing_lnum_off)
751 sourcing_lnum_off -= SOURCING_LNUM;
752 else
753 sourcing_lnum_off = 0;
754
755 if (skip_until != NULL)
756 {
757 // Don't check for ":endfunc"/":enddef" between
758 // * ":append" and "."
759 // * ":python <<EOF" and "EOF"
760 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
761 if (heredoc_trimmed == NULL
762 || (is_heredoc && skipwhite(theline) == theline)
763 || STRNCMP(theline, heredoc_trimmed,
764 STRLEN(heredoc_trimmed)) == 0)
765 {
766 if (heredoc_trimmed == NULL)
767 p = theline;
768 else if (is_heredoc)
769 p = skipwhite(theline) == theline
770 ? theline : theline + STRLEN(heredoc_trimmed);
771 else
772 p = theline + STRLEN(heredoc_trimmed);
773 if (STRCMP(p, skip_until) == 0)
774 {
775 VIM_CLEAR(skip_until);
776 VIM_CLEAR(heredoc_trimmed);
777 getline_options = vim9_function
778 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
779 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200780
781 if (heredoc_concat_len > 0)
782 {
783 // Replace the starting line with all the concatenated
784 // lines.
785 ga_concat(&heredoc_ga, theline);
786 vim_free(((char_u **)(newlines->ga_data))[
787 heredoc_concat_len - 1]);
788 ((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1] = heredoc_ga.ga_data;
790 ga_init(&heredoc_ga);
791 heredoc_concat_len = 0;
792 theline += STRLEN(theline); // skip the "EOF"
793 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 }
795 }
796 }
797 else
798 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200799 int c;
800 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100801
802 // skip ':' and blanks
803 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
804 ;
805
806 // Check for "endfunction", "enddef" or "}".
807 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200808 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100809 ? *p == '}'
810 : (checkforcmd(&p, nesting_def[nesting]
811 ? "enddef" : "endfunction", 4)
812 && *p != ':'))
813 {
814 if (nesting-- == 0)
815 {
816 char_u *nextcmd = NULL;
817
818 if (*p == '|' || *p == '}')
819 nextcmd = p + 1;
820 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
821 nextcmd = line_arg;
822 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100823 && (vim9_function || p_verbose > 0))
824 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200825 SOURCING_LNUM = sourcing_lnum_top
826 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100827 if (eap->cmdidx == CMD_def)
828 semsg(_(e_text_found_after_enddef_str), p);
829 else
830 give_warning2((char_u *)
831 _("W22: Text found after :endfunction: %s"),
832 p, TRUE);
833 }
834 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100835 {
836 // Another command follows. If the line came from "eap"
837 // we can simply point into it, otherwise we need to
838 // change "eap->cmdlinep".
839 eap->nextcmd = nextcmd;
840 if (*line_to_free != NULL)
841 {
842 vim_free(*eap->cmdlinep);
843 *eap->cmdlinep = *line_to_free;
844 *line_to_free = NULL;
845 }
846 }
847 break;
848 }
849 }
850
851 // Check for mismatched "endfunc" or "enddef".
852 // We don't check for "def" inside "func" thus we also can't check
853 // for "enddef".
854 // We continue to find the end of the function, although we might
855 // not find it.
856 else if (nesting_def[nesting])
857 {
858 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
859 emsg(_(e_mismatched_endfunction));
860 }
861 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
862 emsg(_(e_mismatched_enddef));
863
864 // Increase indent inside "if", "while", "for" and "try", decrease
865 // at "end".
866 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
867 indent -= 2;
868 else if (STRNCMP(p, "if", 2) == 0
869 || STRNCMP(p, "wh", 2) == 0
870 || STRNCMP(p, "for", 3) == 0
871 || STRNCMP(p, "try", 3) == 0)
872 indent += 2;
873
874 // Check for defining a function inside this function.
875 // Only recognize "def" inside "def", not inside "function",
876 // For backwards compatibility, see Test_function_python().
877 c = *p;
878 if (is_function_cmd(&p)
879 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
880 {
881 if (*p == '!')
882 p = skipwhite(p + 1);
883 p += eval_fname_script(p);
884 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
885 NULL, NULL));
886 if (*skipwhite(p) == '(')
887 {
888 if (nesting == MAX_FUNC_NESTING - 1)
889 emsg(_(e_function_nesting_too_deep));
890 else
891 {
892 ++nesting;
893 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200894 nesting_inline[nesting] = FALSE;
895 indent += 2;
896 }
897 }
898 }
899
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200900 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200901 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200902 // Not a comment line: check for nested inline function.
903 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200904 while (end > p && VIM_ISWHITE(*end))
905 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200906 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200907 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200908 int is_block;
909
910 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200911 --end;
912 while (end > p && VIM_ISWHITE(*end))
913 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200914 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
915 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200916 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200917 char_u *s = p;
918
919 // check for line starting with "au" for :autocmd or
920 // "com" for :command, these can use a {} block
921 is_block = checkforcmd_noparen(&s, "autocmd", 2)
922 || checkforcmd_noparen(&s, "command", 3);
923 }
924
925 if (is_block)
926 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting == MAX_FUNC_NESTING - 1)
928 emsg(_(e_function_nesting_too_deep));
929 else
930 {
931 ++nesting;
932 nesting_def[nesting] = TRUE;
933 nesting_inline[nesting] = TRUE;
934 indent += 2;
935 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100936 }
937 }
938 }
939
940 // Check for ":append", ":change", ":insert". Not for :def.
941 p = skip_range(p, FALSE, NULL);
942 if (!vim9_function
943 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
944 || (p[0] == 'c'
945 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
946 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
947 && (STRNCMP(&p[3], "nge", 3) != 0
948 || !ASCII_ISALPHA(p[6])))))))
949 || (p[0] == 'i'
950 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
951 && (!ASCII_ISALPHA(p[2])
952 || (p[2] == 's'
953 && (!ASCII_ISALPHA(p[3])
954 || p[3] == 'e'))))))))
955 skip_until = vim_strsave((char_u *)".");
956
957 // Check for ":python <<EOF", ":tcl <<EOF", etc.
958 arg = skipwhite(skiptowhite(p));
959 if (arg[0] == '<' && arg[1] =='<'
960 && ((p[0] == 'p' && p[1] == 'y'
961 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
962 || ((p[2] == '3' || p[2] == 'x')
963 && !ASCII_ISALPHA(p[3]))))
964 || (p[0] == 'p' && p[1] == 'e'
965 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
966 || (p[0] == 't' && p[1] == 'c'
967 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
968 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
969 && !ASCII_ISALPHA(p[3]))
970 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
971 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
972 || (p[0] == 'm' && p[1] == 'z'
973 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
974 ))
975 {
976 // ":python <<" continues until a dot, like ":append"
977 p = skipwhite(arg + 2);
978 if (STRNCMP(p, "trim", 4) == 0)
979 {
980 // Ignore leading white space.
981 p = skipwhite(p + 4);
982 heredoc_trimmed = vim_strnsave(theline,
983 skipwhite(theline) - theline);
984 }
985 if (*p == NUL)
986 skip_until = vim_strsave((char_u *)".");
987 else
988 skip_until = vim_strnsave(p, skiptowhite(p) - p);
989 getline_options = GETLINE_NONE;
990 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200991 if (eap->cmdidx == CMD_def)
992 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 }
994
995 // Check for ":cmd v =<< [trim] EOF"
996 // and ":cmd [a, b] =<< [trim] EOF"
997 // and "lines =<< [trim] EOF" for Vim9
998 // Where "cmd" can be "let", "var", "final" or "const".
999 arg = skipwhite(skiptowhite(p));
1000 if (*arg == '[')
1001 arg = vim_strchr(arg, ']');
1002 if (arg != NULL)
1003 {
1004 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1005 && arg[1] == '<' && arg[2] =='<');
1006
1007 if (!found)
1008 // skip over the argument after "cmd"
1009 arg = skipwhite(skiptowhite(arg));
1010 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1011 && (checkforcmd(&p, "let", 2)
1012 || checkforcmd(&p, "var", 3)
1013 || checkforcmd(&p, "final", 5)
1014 || checkforcmd(&p, "const", 5))))
1015 {
1016 p = skipwhite(arg + 3);
1017 if (STRNCMP(p, "trim", 4) == 0)
1018 {
1019 // Ignore leading white space.
1020 p = skipwhite(p + 4);
1021 heredoc_trimmed = vim_strnsave(theline,
1022 skipwhite(theline) - theline);
1023 }
1024 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1025 getline_options = GETLINE_NONE;
1026 is_heredoc = TRUE;
1027 }
1028 }
1029 }
1030
1031 // Add the line to the function.
1032 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1033 goto theend;
1034
Bram Moolenaar20677332021-06-06 17:02:53 +02001035 if (heredoc_concat_len > 0)
1036 {
1037 // For a :def function "python << EOF" concatenats all the lines,
1038 // to be used for the instruction later.
1039 ga_concat(&heredoc_ga, theline);
1040 ga_concat(&heredoc_ga, (char_u *)"\n");
1041 p = vim_strsave((char_u *)"");
1042 }
1043 else
1044 {
1045 // Copy the line to newly allocated memory. get_one_sourceline()
1046 // allocates 250 bytes per line, this saves 80% on average. The
1047 // cost is an extra alloc/free.
1048 p = vim_strsave(theline);
1049 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001050 if (p == NULL)
1051 goto theend;
1052 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1053
1054 // Add NULL lines for continuation lines, so that the line count is
1055 // equal to the index in the growarray.
1056 while (sourcing_lnum_off-- > 0)
1057 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1058
1059 // Check for end of eap->arg.
1060 if (line_arg != NULL && *line_arg == NUL)
1061 line_arg = NULL;
1062 }
1063
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001064 // Return OK when no error was detected.
1065 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001066 ret = OK;
1067
1068theend:
1069 vim_free(skip_until);
1070 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001071 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001072 need_wait_return |= saved_wait_return;
1073 return ret;
1074}
1075
1076/*
1077 * Handle the body of a lambda. *arg points to the "{", process statements
1078 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001079 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 * When successful "rettv" is set to a funcref.
1081 */
1082 static int
1083lambda_function_body(
1084 char_u **arg,
1085 typval_T *rettv,
1086 evalarg_T *evalarg,
1087 garray_T *newargs,
1088 garray_T *argtypes,
1089 int varargs,
1090 garray_T *default_args,
1091 char_u *ret_type)
1092{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001093 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001094 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001095 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001096 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001097 exarg_T eap;
1098 garray_T newlines;
1099 char_u *cmdline = NULL;
1100 int ret = FAIL;
1101 char_u *line_to_free = NULL;
1102 partial_T *pt;
1103 char_u *name;
1104 int lnum_save = -1;
1105 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1106
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001107 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1108 {
1109 semsg(_(e_trailing_arg), *arg + 1);
1110 return FAIL;
1111 }
1112
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001113 CLEAR_FIELD(eap);
1114 eap.cmdidx = CMD_block;
1115 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001116 eap.cmdlinep = &cmdline;
1117 eap.skip = !evaluate;
1118 if (evalarg->eval_cctx != NULL)
1119 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1120 else
1121 {
1122 eap.getline = evalarg->eval_getline;
1123 eap.cookie = evalarg->eval_cookie;
1124 }
1125
1126 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1127 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001128 {
1129 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001130 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001131 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001132
1133 // When inside a lambda must add the function lines to evalarg.eval_ga.
1134 evalarg->eval_break_count += newlines.ga_len;
1135 if (gap->ga_itemsize > 0)
1136 {
1137 int idx;
1138 char_u *last;
1139 size_t plen;
1140 char_u *pnl;
1141
1142 for (idx = 0; idx < newlines.ga_len; ++idx)
1143 {
1144 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1145
Bram Moolenaarecb66452021-05-18 15:09:18 +02001146 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001147 goto erret;
1148
1149 // Going to concatenate the lines after parsing. For an empty or
1150 // comment line use an empty string.
1151 // Insert NL characters at the start of each line, the string will
1152 // be split again later in .get_lambda_tv().
1153 if (*p == NUL || vim9_comment_start(p))
1154 p = (char_u *)"";
1155 plen = STRLEN(p);
1156 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1157 if (pnl != NULL)
1158 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001159 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1160 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001161 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001162 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001163 goto erret;
1164 if (cmdline != NULL)
1165 // more is following after the "}", which was skipped
1166 last = cmdline;
1167 else
1168 // nothing is following the "}"
1169 last = (char_u *)"}";
1170 plen = STRLEN(last);
1171 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1172 if (pnl != NULL)
1173 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001174 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1175 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001176 }
1177
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 if (cmdline != NULL)
1179 {
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 Moolenaar7a6eaa02021-03-21 20:53:29 +01001208 ufunc->uf_refcount = 1;
1209 ufunc->uf_args = *newargs;
1210 newargs->ga_data = NULL;
1211 ufunc->uf_def_args = *default_args;
1212 default_args->ga_data = NULL;
1213 ufunc->uf_func_type = &t_func_any;
1214
1215 // error messages are for the first function line
1216 lnum_save = SOURCING_LNUM;
1217 SOURCING_LNUM = sourcing_lnum_top;
1218
1219 // parse argument types
1220 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1221 {
1222 SOURCING_LNUM = lnum_save;
1223 goto erret;
1224 }
1225
1226 // parse the return type, if any
1227 if (parse_return_type(ufunc, ret_type) == FAIL)
1228 goto erret;
1229
1230 pt = ALLOC_CLEAR_ONE(partial_T);
1231 if (pt == NULL)
1232 goto erret;
1233 pt->pt_func = ufunc;
1234 pt->pt_refcount = 1;
1235
1236 ufunc->uf_lines = newlines;
1237 newlines.ga_data = NULL;
1238 if (sandbox)
1239 ufunc->uf_flags |= FC_SANDBOX;
1240 if (!ASCII_ISUPPER(*ufunc->uf_name))
1241 ufunc->uf_flags |= FC_VIM9;
1242 ufunc->uf_script_ctx = current_sctx;
1243 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1244 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1245 set_function_type(ufunc);
1246
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001247 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1248
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001249 rettv->vval.v_partial = pt;
1250 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001251 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001252 ret = OK;
1253
1254erret:
1255 if (lnum_save >= 0)
1256 SOURCING_LNUM = lnum_save;
1257 vim_free(line_to_free);
1258 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001259 if (newargs != NULL)
1260 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001261 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001262 if (ufunc != NULL)
1263 {
1264 func_clear(ufunc, TRUE);
1265 func_free(ufunc, TRUE);
1266 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001267 return ret;
1268}
1269
1270/*
1271 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001272 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001273 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1275 */
1276 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001277get_lambda_tv(
1278 char_u **arg,
1279 typval_T *rettv,
1280 int types_optional,
1281 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001282{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001283 int evaluate = evalarg != NULL
1284 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 garray_T newargs;
1286 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001287 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001288 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001289 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001290 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001291 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001293 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001294 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001295 char_u *s;
1296 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001297 int *old_eval_lavars = eval_lavars_used;
1298 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001299 char_u *tofree1 = NULL;
1300 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001301 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001302 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001303 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001304
1305 if (equal_arrow && !in_vim9script())
1306 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001307
1308 ga_init(&newargs);
1309 ga_init(&newlines);
1310
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001311 // First, check if this is really a lambda expression. "->" or "=>" must
1312 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001313 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001314 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001315 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001316 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001317 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001318 {
1319 if (types_optional)
1320 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001321 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001322 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001323
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001324 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001325 if (evaluate)
1326 pnewargs = &newargs;
1327 else
1328 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001329 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001330 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001331 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001332 &varargs, &default_args,
1333 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001334 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001335 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001336 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001337 {
1338 if (types_optional)
1339 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001340 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001341 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001342 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001343 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001344
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001345 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1346 if (ret_type != NULL)
1347 {
1348 ret_type = vim_strsave(ret_type);
1349 tofree2 = ret_type;
1350 }
1351
Bram Moolenaare38eab22019-12-05 21:50:01 +01001352 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001353 if (evaluate)
1354 eval_lavars_used = &eval_lavars;
1355
Bram Moolenaar65c44152020-12-24 15:14:01 +01001356 *arg = skipwhite_and_linebreak(*arg, evalarg);
1357
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001358 // Recognize "{" as the start of a function body.
1359 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001360 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001361 if (evalarg == NULL)
1362 // cannot happen?
1363 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001364 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1365 types_optional ? &argtypes : NULL, varargs,
1366 &default_args, ret_type) == FAIL)
1367 goto errret;
1368 goto theend;
1369 }
1370 if (default_args.ga_len > 0)
1371 {
1372 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001373 goto errret;
1374 }
1375
Bram Moolenaare38eab22019-12-05 21:50:01 +01001376 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001377 start = *arg;
1378 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379 if (ret == FAIL)
1380 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001381 if (evalarg != NULL)
1382 {
1383 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001384 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001385 evalarg->eval_tofree = NULL;
1386 }
1387
Bram Moolenaar65c44152020-12-24 15:14:01 +01001388 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001389 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001390 *arg = skipwhite_and_linebreak(*arg, evalarg);
1391 if (**arg != '}')
1392 {
1393 semsg(_("E451: Expected }: %s"), *arg);
1394 goto errret;
1395 }
1396 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001398
1399 if (evaluate)
1400 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001401 int len;
1402 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001403 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001404 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001405 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001406
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001407 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408 if (fp == NULL)
1409 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001410 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001411 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001412 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001413 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001414
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1416 if (ga_grow(&newlines, 1) == FAIL)
1417 goto errret;
1418
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001419 // If there are line breaks, we need to split up the string.
1420 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001421 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001422 line_end = end;
1423
1424 // Add "return " before the expression (or the first line).
1425 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001426 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001427 if (p == NULL)
1428 goto errret;
1429 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1430 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001431 vim_strncpy(p + 7, start, line_end - start);
1432
1433 if (line_end != end)
1434 {
1435 // Add more lines, split by line breaks. Thus is used when a
1436 // lambda with { cmds } is encountered.
1437 while (*line_end == '\n')
1438 {
1439 if (ga_grow(&newlines, 1) == FAIL)
1440 goto errret;
1441 start = line_end + 1;
1442 line_end = vim_strchr(start, '\n');
1443 if (line_end == NULL)
1444 line_end = end;
1445 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1446 vim_strnsave(start, line_end - start);
1447 }
1448 }
1449
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001450 if (strstr((char *)p + 7, "a:") == NULL)
1451 // No a: variables are used for sure.
1452 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453
1454 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001455 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001457 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001458 if (types_optional)
1459 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001460 if (parse_argument_types(fp, &argtypes,
1461 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001462 goto errret;
1463 if (ret_type != NULL)
1464 {
1465 fp->uf_ret_type = parse_type(&ret_type,
1466 &fp->uf_type_list, TRUE);
1467 if (fp->uf_ret_type == NULL)
1468 goto errret;
1469 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001470 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001471 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001472 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001473
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001475 if (current_funccal != NULL && eval_lavars)
1476 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001477 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001478 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001479 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001480 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481
1482#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483 if (prof_def_func())
1484 func_do_profile(fp);
1485#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001486 if (sandbox)
1487 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001488 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001489 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1490 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001491 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001493 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001494 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001495
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001496 function_using_block_scopes(fp, evalarg->eval_cstack);
1497
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001498 pt->pt_func = fp;
1499 pt->pt_refcount = 1;
1500 rettv->vval.v_partial = pt;
1501 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001502
1503 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001504 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001506theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001507 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001508 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001509 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001510 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001511 vim_free(tofree1);
1512 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001513 if (types_optional)
1514 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001515
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 return OK;
1517
1518errret:
1519 ga_clear_strings(&newargs);
1520 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001521 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001522 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001523 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001524 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001525 if (fp != NULL)
1526 vim_free(fp->uf_arg_types);
1527 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001529 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001530 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001531 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001532 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001533 vim_free(tofree1);
1534 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001535 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001536 return FAIL;
1537}
1538
1539/*
1540 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1541 * name it contains, otherwise return "name".
1542 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1543 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001544 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1545 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001546 */
1547 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001548deref_func_name(
1549 char_u *name,
1550 int *lenp,
1551 partial_T **partialp,
1552 type_T **type,
1553 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554{
1555 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001556 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001557 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001558 char_u *s = NULL;
1559 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001560 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561
1562 if (partialp != NULL)
1563 *partialp = NULL;
1564
1565 cc = name[*lenp];
1566 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001567
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001568 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001570 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001572 tv = &v->di_tv;
1573 }
1574 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1575 {
1576 imported_T *import;
1577 char_u *p = name;
1578 int len = *lenp;
1579
1580 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001581 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001582 p = name + 2;
1583 len -= 2;
1584 }
1585 import = find_imported(p, len, NULL);
1586
1587 // imported variable from another script
1588 if (import != NULL)
1589 {
1590 if (import->imp_funcname != NULL)
1591 {
1592 s = import->imp_funcname;
1593 *lenp = (int)STRLEN(s);
1594 return s;
1595 }
1596 // TODO: what if (import->imp_flags & IMP_FLAGS_STAR)
1597 {
1598 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1599 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1600 + import->imp_var_vals_idx;
1601 tv = sv->sv_tv;
1602 if (type != NULL)
1603 *type = sv->sv_type;
1604 did_type = TRUE;
1605 }
1606 }
1607 }
1608
1609 if (tv != NULL)
1610 {
1611 if (tv->v_type == VAR_FUNC)
1612 {
1613 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001614 {
1615 *lenp = 0;
1616 return (char_u *)""; // just in case
1617 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001618 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001619 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001622 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001624 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001625
1626 if (pt == NULL)
1627 {
1628 *lenp = 0;
1629 return (char_u *)""; // just in case
1630 }
1631 if (partialp != NULL)
1632 *partialp = pt;
1633 s = partial_name(pt);
1634 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636
1637 if (s != NULL)
1638 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001639 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001640 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001641 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001642
1643 if (sv != NULL)
1644 *type = sv->sv_type;
1645 }
1646 return s;
1647 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648 }
1649
1650 return name;
1651}
1652
1653/*
1654 * Give an error message with a function name. Handle <SNR> things.
1655 * "ermsg" is to be passed without translation, use N_() instead of _().
1656 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001657 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658emsg_funcname(char *ermsg, char_u *name)
1659{
1660 char_u *p;
1661
1662 if (*name == K_SPECIAL)
1663 p = concat_str((char_u *)"<SNR>", name + 3);
1664 else
1665 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001666 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001667 if (p != name)
1668 vim_free(p);
1669}
1670
1671/*
1672 * Allocate a variable for the result of a function.
1673 * Return OK or FAIL.
1674 */
1675 int
1676get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001677 char_u *name, // name of the function
1678 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001680 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001681 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001682 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683{
1684 char_u *argp;
1685 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001686 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1687 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001688 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689
1690 /*
1691 * Get the arguments.
1692 */
1693 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001694 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1695 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001697 // skip the '(' or ',' and possibly line breaks
1698 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1699
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700 if (*argp == ')' || *argp == ',' || *argp == NUL)
1701 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001702 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703 {
1704 ret = FAIL;
1705 break;
1706 }
1707 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001708 // The comma should come right after the argument, but this wasn't
1709 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001710 if (vim9script)
1711 {
1712 if (*argp != ',' && *skipwhite(argp) == ',')
1713 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001714 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001715 ret = FAIL;
1716 break;
1717 }
1718 }
1719 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001720 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721 if (*argp != ',')
1722 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001723 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1724 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001725 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001726 ret = FAIL;
1727 break;
1728 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001729 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001730 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731 if (*argp == ')')
1732 ++argp;
1733 else
1734 ret = FAIL;
1735
1736 if (ret == OK)
1737 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001738 int i = 0;
1739 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740
1741 if (get_vim_var_nr(VV_TESTING))
1742 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001743 // Prepare for calling test_garbagecollect_now(), need to know
1744 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 if (funcargs.ga_itemsize == 0)
1746 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1747 for (i = 0; i < argcount; ++i)
1748 if (ga_grow(&funcargs, 1) == OK)
1749 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1750 &argvars[i];
1751 }
1752
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001753 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001754 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001755 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001756 // An error in a builtin function does not return FAIL, but we do
1757 // want to abort further processing if an error was given.
1758 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001759 clear_tv(rettv);
1760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761
1762 funcargs.ga_len -= i;
1763 }
1764 else if (!aborting())
1765 {
1766 if (argcount == MAX_FUNC_ARGS)
1767 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1768 else
1769 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1770 }
1771
1772 while (--argcount >= 0)
1773 clear_tv(&argvars[argcount]);
1774
Bram Moolenaar8294d492020-08-10 22:40:56 +02001775 if (in_vim9script())
1776 *arg = argp;
1777 else
1778 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001779 return ret;
1780}
1781
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001782/*
1783 * Return TRUE if "p" starts with "<SID>" or "s:".
1784 * Only works if eval_fname_script() returned non-zero for "p"!
1785 */
1786 static int
1787eval_fname_sid(char_u *p)
1788{
1789 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1790}
1791
1792/*
1793 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1794 * Change <SNR>123_name() to K_SNR 123_name().
1795 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1796 * (slow).
1797 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001798 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1800{
1801 int llen;
1802 char_u *fname;
1803 int i;
1804
1805 llen = eval_fname_script(name);
1806 if (llen > 0)
1807 {
1808 fname_buf[0] = K_SPECIAL;
1809 fname_buf[1] = KS_EXTRA;
1810 fname_buf[2] = (int)KE_SNR;
1811 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001812 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001814 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001815 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816 else
1817 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001818 sprintf((char *)fname_buf + 3, "%ld_",
1819 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 i = (int)STRLEN(fname_buf);
1821 }
1822 }
1823 if (i + STRLEN(name + llen) < FLEN_FIXED)
1824 {
1825 STRCPY(fname_buf + i, name + llen);
1826 fname = fname_buf;
1827 }
1828 else
1829 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001830 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001832 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 else
1834 {
1835 *tofree = fname;
1836 mch_memmove(fname, fname_buf, (size_t)i);
1837 STRCPY(fname + i, name + llen);
1838 }
1839 }
1840 }
1841 else
1842 fname = name;
1843 return fname;
1844}
1845
1846/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001847 * Find a function "name" in script "sid".
1848 */
1849 static ufunc_T *
1850find_func_with_sid(char_u *name, int sid)
1851{
1852 hashitem_T *hi;
1853 char_u buffer[200];
1854
1855 buffer[0] = K_SPECIAL;
1856 buffer[1] = KS_EXTRA;
1857 buffer[2] = (int)KE_SNR;
1858 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1859 (long)sid, name);
1860 hi = hash_find(&func_hashtab, buffer);
1861 if (!HASHITEM_EMPTY(hi))
1862 return HI2UF(hi);
1863
1864 return NULL;
1865}
1866
1867/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001869 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870 * Return NULL for unknown function.
1871 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001872 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001873find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001874{
1875 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001876 ufunc_T *func;
1877 imported_T *imported;
1878
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001879 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001880 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001881 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001882 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001883 int find_script_local = in_vim9script()
1884 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001885
Bram Moolenaar95006e32020-08-29 17:47:08 +02001886 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001887 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001888 // Find script-local function before global one.
1889 func = find_func_with_sid(name, current_sctx.sc_sid);
1890 if (func != NULL)
1891 return func;
1892 }
1893
Bram Moolenaarefa94442020-08-08 22:16:00 +02001894 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001895 && name[1] == KS_EXTRA
1896 && name[2] == KE_SNR)
1897 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001898 // Caller changes s: to <SNR>99_name.
1899
1900 after_script = name + 3;
1901 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001902 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001903 ++after_script;
1904 else
1905 after_script = NULL;
1906 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001907 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001908 {
1909 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001910 if (after_script != NULL && sid != current_sctx.sc_sid)
1911 imported = find_imported_in_script(after_script, 0, sid);
1912 else
1913 imported = find_imported(after_script == NULL
1914 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001915 if (imported != NULL && imported->imp_funcname != NULL)
1916 {
1917 hi = hash_find(&func_hashtab, imported->imp_funcname);
1918 if (!HASHITEM_EMPTY(hi))
1919 return HI2UF(hi);
1920 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001921 }
1922 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001923
Bram Moolenaara26b9702020-04-18 19:53:28 +02001924 hi = hash_find(&func_hashtab,
1925 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001926 if (!HASHITEM_EMPTY(hi))
1927 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001928
1929 return NULL;
1930}
1931
1932/*
1933 * Find a function by name, return pointer to it in ufuncs.
1934 * "cctx" is passed in a :def function to find imported functions.
1935 * Return NULL for unknown or dead function.
1936 */
1937 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001938find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001939{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001940 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001941
1942 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1943 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944 return NULL;
1945}
1946
1947/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001948 * Return TRUE if "ufunc" is a global function.
1949 */
1950 int
1951func_is_global(ufunc_T *ufunc)
1952{
1953 return ufunc->uf_name[0] != K_SPECIAL;
1954}
1955
1956/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001957 * Copy the function name of "fp" to buffer "buf".
1958 * "buf" must be able to hold the function name plus three bytes.
1959 * Takes care of script-local function names.
1960 */
1961 static void
1962cat_func_name(char_u *buf, ufunc_T *fp)
1963{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001964 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965 {
1966 STRCPY(buf, "<SNR>");
1967 STRCAT(buf, fp->uf_name + 3);
1968 }
1969 else
1970 STRCPY(buf, fp->uf_name);
1971}
1972
1973/*
1974 * Add a number variable "name" to dict "dp" with value "nr".
1975 */
1976 static void
1977add_nr_var(
1978 dict_T *dp,
1979 dictitem_T *v,
1980 char *name,
1981 varnumber_T nr)
1982{
1983 STRCPY(v->di_key, name);
1984 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1985 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1986 v->di_tv.v_type = VAR_NUMBER;
1987 v->di_tv.v_lock = VAR_FIXED;
1988 v->di_tv.vval.v_number = nr;
1989}
1990
1991/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001992 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001993 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001994 static void
1995free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001996{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001997 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001998
1999 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2000 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002001 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002002
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002003 // When garbage collecting a funccall_T may be freed before the
2004 // function that references it, clear its uf_scoped field.
2005 // The function may have been redefined and point to another
2006 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002007 if (fp != NULL && fp->uf_scoped == fc)
2008 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002009 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002010 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002011
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002012 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002013 vim_free(fc);
2014}
2015
2016/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002017 * Free "fc" and what it contains.
2018 * Can be called only when "fc" is kept beyond the period of it called,
2019 * i.e. after cleanup_function_call(fc).
2020 */
2021 static void
2022free_funccal_contents(funccall_T *fc)
2023{
2024 listitem_T *li;
2025
2026 // Free all l: variables.
2027 vars_clear(&fc->l_vars.dv_hashtab);
2028
2029 // Free all a: variables.
2030 vars_clear(&fc->l_avars.dv_hashtab);
2031
2032 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002033 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002034 clear_tv(&li->li_tv);
2035
2036 free_funccal(fc);
2037}
2038
2039/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002040 * Handle the last part of returning from a function: free the local hashtable.
2041 * Unless it is still in use by a closure.
2042 */
2043 static void
2044cleanup_function_call(funccall_T *fc)
2045{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002046 int may_free_fc = fc->fc_refcount <= 0;
2047 int free_fc = TRUE;
2048
Bram Moolenaar6914c642017-04-01 21:21:30 +02002049 current_funccal = fc->caller;
2050
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002051 // Free all l: variables if not referred.
2052 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2053 vars_clear(&fc->l_vars.dv_hashtab);
2054 else
2055 free_fc = FALSE;
2056
2057 // If the a:000 list and the l: and a: dicts are not referenced and
2058 // there is no closure using it, we can free the funccall_T and what's
2059 // in it.
2060 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2061 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002062 else
2063 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002064 int todo;
2065 hashitem_T *hi;
2066 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002067
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002068 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002069
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002070 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002071 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2072 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2073 {
2074 if (!HASHITEM_EMPTY(hi))
2075 {
2076 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002077 di = HI2DI(hi);
2078 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002079 }
2080 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002081 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002082
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002083 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2084 fc->l_varlist.lv_first = NULL;
2085 else
2086 {
2087 listitem_T *li;
2088
2089 free_fc = FALSE;
2090
2091 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002092 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002093 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002094 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002095
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002096 if (free_fc)
2097 free_funccal(fc);
2098 else
2099 {
2100 static int made_copy = 0;
2101
2102 // "fc" is still in use. This can happen when returning "a:000",
2103 // assigning "l:" to a global variable or defining a closure.
2104 // Link "fc" in the list for garbage collection later.
2105 fc->caller = previous_funccal;
2106 previous_funccal = fc;
2107
2108 if (want_garbage_collect)
2109 // If garbage collector is ready, clear count.
2110 made_copy = 0;
2111 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002112 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002113 // We have made a lot of copies, worth 4 Mbyte. This can happen
2114 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002115 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002116 // too much memory.
2117 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002118 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002119 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002120 }
2121}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002122
2123/*
2124 * There are two kinds of function names:
2125 * 1. ordinary names, function defined with :function or :def
2126 * 2. numbered functions and lambdas
2127 * For the first we only count the name stored in func_hashtab as a reference,
2128 * using function() does not count as a reference, because the function is
2129 * looked up by name.
2130 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002131 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002132func_name_refcount(char_u *name)
2133{
2134 return isdigit(*name) || *name == '<';
2135}
2136
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002137/*
2138 * Unreference "fc": decrement the reference count and free it when it
2139 * becomes zero. "fp" is detached from "fc".
2140 * When "force" is TRUE we are exiting.
2141 */
2142 static void
2143funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2144{
2145 funccall_T **pfc;
2146 int i;
2147
2148 if (fc == NULL)
2149 return;
2150
2151 if (--fc->fc_refcount <= 0 && (force || (
2152 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2153 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2154 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2155 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2156 {
2157 if (fc == *pfc)
2158 {
2159 *pfc = fc->caller;
2160 free_funccal_contents(fc);
2161 return;
2162 }
2163 }
2164 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2165 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2166 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2167}
2168
2169/*
2170 * Remove the function from the function hashtable. If the function was
2171 * deleted while it still has references this was already done.
2172 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2173 */
2174 static int
2175func_remove(ufunc_T *fp)
2176{
2177 hashitem_T *hi;
2178
2179 // Return if it was already virtually deleted.
2180 if (fp->uf_flags & FC_DEAD)
2181 return FALSE;
2182
2183 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2184 if (!HASHITEM_EMPTY(hi))
2185 {
2186 // When there is a def-function index do not actually remove the
2187 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002188 // Do remove it when it's a copy.
2189 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002190 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002191 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002192 return FALSE;
2193 }
2194 hash_remove(&func_hashtab, hi);
2195 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002196 return TRUE;
2197 }
2198 return FALSE;
2199}
2200
2201 static void
2202func_clear_items(ufunc_T *fp)
2203{
2204 ga_clear_strings(&(fp->uf_args));
2205 ga_clear_strings(&(fp->uf_def_args));
2206 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002207 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002208 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002209 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002210 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002211
2212 // Increment the refcount of this function to avoid it being freed
2213 // recursively when the partial is freed.
2214 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002215 partial_unref(fp->uf_partial);
2216 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002217 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002218
2219#ifdef FEAT_LUA
2220 if (fp->uf_cb_free != NULL)
2221 {
2222 fp->uf_cb_free(fp->uf_cb_state);
2223 fp->uf_cb_free = NULL;
2224 }
2225
2226 fp->uf_cb_state = NULL;
2227 fp->uf_cb = NULL;
2228#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002229#ifdef FEAT_PROFILE
2230 VIM_CLEAR(fp->uf_tml_count);
2231 VIM_CLEAR(fp->uf_tml_total);
2232 VIM_CLEAR(fp->uf_tml_self);
2233#endif
2234}
2235
2236/*
2237 * Free all things that a function contains. Does not free the function
2238 * itself, use func_free() for that.
2239 * When "force" is TRUE we are exiting.
2240 */
2241 static void
2242func_clear(ufunc_T *fp, int force)
2243{
2244 if (fp->uf_cleared)
2245 return;
2246 fp->uf_cleared = TRUE;
2247
2248 // clear this function
2249 func_clear_items(fp);
2250 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002251 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002252}
2253
2254/*
2255 * Free a function and remove it from the list of functions. Does not free
2256 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002257 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002258 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002259 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002260 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002261func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002262{
2263 // Only remove it when not done already, otherwise we would remove a newer
2264 // version of the function with the same name.
2265 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2266 func_remove(fp);
2267
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002268 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002269 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002270 if (fp->uf_dfunc_idx > 0)
2271 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002272 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002273 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002274 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002275 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002276 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002277}
2278
2279/*
2280 * Free all things that a function contains and free the function itself.
2281 * When "force" is TRUE we are exiting.
2282 */
2283 static void
2284func_clear_free(ufunc_T *fp, int force)
2285{
2286 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002287 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2288 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002289 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002290 else
2291 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002292}
2293
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002294/*
2295 * Copy already defined function "lambda" to a new function with name "global".
2296 * This is for when a compiled function defines a global function.
2297 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002298 int
2299copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002300{
2301 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002302 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002303
2304 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002305 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002306 semsg(_(e_lambda_function_not_found_str), lambda);
2307 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002308 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002309
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002310 fp = find_func(global, TRUE, NULL);
2311 if (fp != NULL)
2312 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002313 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002314 semsg(_(e_funcexts), global);
2315 return FAIL;
2316 }
2317
2318 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2319 if (fp == NULL)
2320 return FAIL;
2321
2322 fp->uf_varargs = ufunc->uf_varargs;
2323 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2324 fp->uf_def_status = ufunc->uf_def_status;
2325 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2326 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2327 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2328 == FAIL
2329 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2330 goto failed;
2331
2332 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2333 : vim_strsave(ufunc->uf_name_exp);
2334 if (ufunc->uf_arg_types != NULL)
2335 {
2336 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2337 if (fp->uf_arg_types == NULL)
2338 goto failed;
2339 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2340 sizeof(type_T *) * fp->uf_args.ga_len);
2341 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002342 if (ufunc->uf_va_name != NULL)
2343 {
2344 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2345 if (fp->uf_va_name == NULL)
2346 goto failed;
2347 }
2348 fp->uf_ret_type = ufunc->uf_ret_type;
2349
2350 fp->uf_refcount = 1;
2351 STRCPY(fp->uf_name, global);
2352 hash_add(&func_hashtab, UF2HIKEY(fp));
2353
2354 // the referenced dfunc_T is now used one more time
2355 link_def_function(fp);
2356
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002357 // Create a partial to store the context of the function where it was
2358 // instantiated. Only needs to be done once. Do this on the original
2359 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002360 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2361 {
2362 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2363
2364 if (pt == NULL)
2365 goto failed;
2366 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002367 {
2368 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002369 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002370 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002371 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002372 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002373 }
2374
2375 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002376
2377failed:
2378 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002379 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002380}
2381
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002382static int funcdepth = 0;
2383
2384/*
2385 * Increment the function call depth count.
2386 * Return FAIL when going over 'maxfuncdepth'.
2387 * Otherwise return OK, must call funcdepth_decrement() later!
2388 */
2389 int
2390funcdepth_increment(void)
2391{
2392 if (funcdepth >= p_mfd)
2393 {
2394 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2395 return FAIL;
2396 }
2397 ++funcdepth;
2398 return OK;
2399}
2400
2401 void
2402funcdepth_decrement(void)
2403{
2404 --funcdepth;
2405}
2406
2407/*
2408 * Get the current function call depth.
2409 */
2410 int
2411funcdepth_get(void)
2412{
2413 return funcdepth;
2414}
2415
2416/*
2417 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002418 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002419 * times as funcdepth_increment().
2420 */
2421 void
2422funcdepth_restore(int depth)
2423{
2424 funcdepth = depth;
2425}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002426
2427/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002428 * Call a user function.
2429 */
2430 static void
2431call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002432 ufunc_T *fp, // pointer to function
2433 int argcount, // nr of args
2434 typval_T *argvars, // arguments
2435 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002436 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002437 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002439 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002440 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002441 funccall_T *fc;
2442 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002443 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002445 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 int i;
2447 int ai;
2448 int islambda = FALSE;
2449 char_u numbuf[NUMBUFLEN];
2450 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002451 typval_T *tv_to_free[MAX_FUNC_ARGS];
2452 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002454 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002456 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457
Bram Moolenaarb2049902021-01-24 12:53:53 +01002458#ifdef FEAT_PROFILE
2459 CLEAR_FIELD(profile_info);
2460#endif
2461
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002462 // If depth of calling is getting too high, don't execute the function.
2463 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002465 rettv->v_type = VAR_NUMBER;
2466 rettv->vval.v_number = -1;
2467 return;
2468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469
Bram Moolenaare38eab22019-12-05 21:50:01 +01002470 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002472 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002473 if (fc == NULL)
2474 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 fc->caller = current_funccal;
2476 current_funccal = fc;
2477 fc->func = fp;
2478 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002480 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2482 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002483 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002484 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002485 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002487 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002488 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002489#ifdef FEAT_PROFILE
2490 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2491#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002492 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002493#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002494 if (do_profiling == PROF_YES)
2495 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002496#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002497 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002498 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002499#ifdef FEAT_PROFILE
2500 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002501 || (caller != NULL && caller->uf_profiling)))
2502 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002503#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002504 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002505 free_funccal(fc);
2506 return;
2507 }
2508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2510 islambda = TRUE;
2511
2512 /*
2513 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2514 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2515 * each argument variable and saves a lot of time.
2516 */
2517 /*
2518 * Init l: variables.
2519 */
2520 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2521 if (selfdict != NULL)
2522 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002523 // Set l:self to "selfdict". Use "name" to avoid a warning from
2524 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 v = &fc->fixvar[fixvar_idx++].var;
2526 name = v->di_key;
2527 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002528 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2530 v->di_tv.v_type = VAR_DICT;
2531 v->di_tv.v_lock = 0;
2532 v->di_tv.vval.v_dict = selfdict;
2533 ++selfdict->dv_refcount;
2534 }
2535
2536 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002537 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002538 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 * Set a:000 to a list with room for the "..." arguments.
2540 */
2541 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002542 if ((fp->uf_flags & FC_NOARGS) == 0)
2543 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002544 (varnumber_T)(argcount >= fp->uf_args.ga_len
2545 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002546 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002547 if ((fp->uf_flags & FC_NOARGS) == 0)
2548 {
2549 // Use "name" to avoid a warning from some compiler that checks the
2550 // destination size.
2551 v = &fc->fixvar[fixvar_idx++].var;
2552 name = v->di_key;
2553 STRCPY(name, "000");
2554 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2555 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2556 v->di_tv.v_type = VAR_LIST;
2557 v->di_tv.v_lock = VAR_FIXED;
2558 v->di_tv.vval.v_list = &fc->l_varlist;
2559 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002560 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2562 fc->l_varlist.lv_lock = VAR_FIXED;
2563
2564 /*
2565 * Set a:firstline to "firstline" and a:lastline to "lastline".
2566 * Set a:name to named arguments.
2567 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002568 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002570 if ((fp->uf_flags & FC_NOARGS) == 0)
2571 {
2572 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002573 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002574 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002575 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002576 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002577 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 {
2579 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002580 typval_T def_rettv;
2581 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582
2583 ai = i - fp->uf_args.ga_len;
2584 if (ai < 0)
2585 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002586 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 name = FUNCARG(fp, i);
2588 if (islambda)
2589 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002590
2591 // evaluate named argument default expression
2592 isdefault = ai + fp->uf_def_args.ga_len >= 0
2593 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2594 && argvars[i].vval.v_number == VVAL_NONE));
2595 if (isdefault)
2596 {
2597 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002598
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002599 def_rettv.v_type = VAR_NUMBER;
2600 def_rettv.vval.v_number = -1;
2601
2602 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2603 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002604 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002605 {
2606 default_arg_err = 1;
2607 break;
2608 }
2609 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 }
2611 else
2612 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002613 if ((fp->uf_flags & FC_NOARGS) != 0)
2614 // Bail out if no a: arguments used (in lambda).
2615 break;
2616
Bram Moolenaare38eab22019-12-05 21:50:01 +01002617 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 sprintf((char *)numbuf, "%d", ai + 1);
2619 name = numbuf;
2620 }
2621 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2622 {
2623 v = &fc->fixvar[fixvar_idx++].var;
2624 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002625 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 }
2627 else
2628 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002629 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 if (v == NULL)
2631 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002632 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002635 // Note: the values are copied directly to avoid alloc/free.
2636 // "argvars" must have VAR_FIXED for v_lock.
2637 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 v->di_tv.v_lock = VAR_FIXED;
2639
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002640 if (isdefault)
2641 // Need to free this later, no matter where it's stored.
2642 tv_to_free[tv_to_free_len++] = &v->di_tv;
2643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 if (addlocal)
2645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // Named arguments should be accessed without the "a:" prefix in
2647 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002648 copy_tv(&v->di_tv, &v->di_tv);
2649 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002651 else
2652 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653
2654 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2655 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002656 listitem_T *li = &fc->l_listitems[ai];
2657
2658 li->li_tv = argvars[i];
2659 li->li_tv.v_lock = VAR_FIXED;
2660 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 }
2662 }
2663
Bram Moolenaare38eab22019-12-05 21:50:01 +01002664 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002666
2667 if (fp->uf_flags & FC_SANDBOX)
2668 {
2669 using_sandbox = TRUE;
2670 ++sandbox;
2671 }
2672
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002673 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002674 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002675 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002677 ++no_wait_return;
2678 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002680 smsg(_("calling %s"), SOURCING_NAME);
2681 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002683 char_u buf[MSG_BUF_LEN];
2684 char_u numbuf2[NUMBUFLEN];
2685 char_u *tofree;
2686 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002688 msg_puts("(");
2689 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002691 if (i > 0)
2692 msg_puts(", ");
2693 if (argvars[i].v_type == VAR_NUMBER)
2694 msg_outnum((long)argvars[i].vval.v_number);
2695 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002697 // Do not want errors such as E724 here.
2698 ++emsg_off;
2699 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2700 --emsg_off;
2701 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002703 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002705 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2706 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002708 msg_puts((char *)s);
2709 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 }
2711 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002713 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002715 msg_puts("\n"); // don't overwrite this either
2716
2717 verbose_leave_scroll();
2718 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 }
2720#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002721 if (do_profiling == PROF_YES)
2722 profile_may_start_func(&profile_info, fp,
2723 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724#endif
2725
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002726 save_current_sctx = current_sctx;
2727 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 save_did_emsg = did_emsg;
2729 did_emsg = FALSE;
2730
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002731 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2732 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002733 else if (islambda)
2734 {
2735 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2736
2737 // A Lambda always has the command "return {expr}". It is much faster
2738 // to evaluate {expr} directly.
2739 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002740 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002741 --ex_nesting_level;
2742 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002743 else
2744 // call do_cmdline() to execute the lines
2745 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2747
2748 --RedrawingDisabled;
2749
Bram Moolenaare38eab22019-12-05 21:50:01 +01002750 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2752 {
2753 clear_tv(rettv);
2754 rettv->v_type = VAR_NUMBER;
2755 rettv->vval.v_number = -1;
2756 }
2757
2758#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002759 if (do_profiling == PROF_YES)
2760 {
2761 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2762
2763 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2764 profile_may_end_func(&profile_info, fp, caller);
2765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766#endif
2767
Bram Moolenaare38eab22019-12-05 21:50:01 +01002768 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 if (p_verbose >= 12)
2770 {
2771 ++no_wait_return;
2772 verbose_enter_scroll();
2773
2774 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002775 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002777 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 (long)fc->rettv->vval.v_number);
2779 else
2780 {
2781 char_u buf[MSG_BUF_LEN];
2782 char_u numbuf2[NUMBUFLEN];
2783 char_u *tofree;
2784 char_u *s;
2785
Bram Moolenaare38eab22019-12-05 21:50:01 +01002786 // The value may be very long. Skip the middle part, so that we
2787 // have some idea how it starts and ends. smsg() would always
2788 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789 ++emsg_off;
2790 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2791 --emsg_off;
2792 if (s != NULL)
2793 {
2794 if (vim_strsize(s) > MSG_BUF_CLEN)
2795 {
2796 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2797 s = buf;
2798 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002799 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 vim_free(tofree);
2801 }
2802 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002803 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804
2805 verbose_leave_scroll();
2806 --no_wait_return;
2807 }
2808
Bram Moolenaare31ee862020-01-07 20:59:34 +01002809 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002810 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002811 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812#ifdef FEAT_PROFILE
2813 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002814 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002816 if (using_sandbox)
2817 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002819 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 {
2821 ++no_wait_return;
2822 verbose_enter_scroll();
2823
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002825 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826
2827 verbose_leave_scroll();
2828 --no_wait_return;
2829 }
2830
2831 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002832 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002833 for (i = 0; i < tv_to_free_len; ++i)
2834 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002835 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836}
2837
2838/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002839 * Check the argument count for user function "fp".
2840 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2841 */
2842 int
2843check_user_func_argcount(ufunc_T *fp, int argcount)
2844{
2845 int regular_args = fp->uf_args.ga_len;
2846
2847 if (argcount < regular_args - fp->uf_def_args.ga_len)
2848 return FCERR_TOOFEW;
2849 else if (!has_varargs(fp) && argcount > regular_args)
2850 return FCERR_TOOMANY;
2851 return FCERR_UNKNOWN;
2852}
2853
2854/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002856 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 int
2858call_user_func_check(
2859 ufunc_T *fp,
2860 int argcount,
2861 typval_T *argvars,
2862 typval_T *rettv,
2863 funcexe_T *funcexe,
2864 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002865{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002866 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002867
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002868 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2869 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002870 error = check_user_func_argcount(fp, argcount);
2871 if (error != FCERR_UNKNOWN)
2872 return error;
2873 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002874 error = FCERR_DICT;
2875 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002876 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002877 int did_save_redo = FALSE;
2878 save_redo_T save_redo;
2879
2880 /*
2881 * Call the user function.
2882 * Save and restore search patterns, script variables and
2883 * redo buffer.
2884 */
2885 save_search_patterns();
2886 if (!ins_compl_active())
2887 {
2888 saveRedobuff(&save_redo);
2889 did_save_redo = TRUE;
2890 }
2891 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002892 call_user_func(fp, argcount, argvars, rettv, funcexe,
2893 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002894 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2895 // Function was unreferenced while being used, free it now.
2896 func_clear_free(fp, FALSE);
2897 if (did_save_redo)
2898 restoreRedobuff(&save_redo);
2899 restore_search_patterns();
2900 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002901 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002903}
2904
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002905static funccal_entry_T *funccal_stack = NULL;
2906
2907/*
2908 * Save the current function call pointer, and set it to NULL.
2909 * Used when executing autocommands and for ":source".
2910 */
2911 void
2912save_funccal(funccal_entry_T *entry)
2913{
2914 entry->top_funccal = current_funccal;
2915 entry->next = funccal_stack;
2916 funccal_stack = entry;
2917 current_funccal = NULL;
2918}
2919
2920 void
2921restore_funccal(void)
2922{
2923 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002924 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002925 else
2926 {
2927 current_funccal = funccal_stack->top_funccal;
2928 funccal_stack = funccal_stack->next;
2929 }
2930}
2931
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002932 funccall_T *
2933get_current_funccal(void)
2934{
2935 return current_funccal;
2936}
2937
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002938/*
2939 * Mark all functions of script "sid" as deleted.
2940 */
2941 void
2942delete_script_functions(int sid)
2943{
2944 hashitem_T *hi;
2945 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002946 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002947 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002948 size_t len;
2949
2950 buf[0] = K_SPECIAL;
2951 buf[1] = KS_EXTRA;
2952 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002953 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002954 len = STRLEN(buf);
2955
Bram Moolenaarce658352020-07-31 23:47:12 +02002956 while (todo > 0)
2957 {
2958 todo = func_hashtab.ht_used;
2959 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2960 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002961 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002962 fp = HI2UF(hi);
2963 if (STRNCMP(fp->uf_name, buf, len) == 0)
2964 {
2965 int changed = func_hashtab.ht_changed;
2966
2967 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002968
2969 if (fp->uf_calls > 0)
2970 {
2971 // Function is executing, don't free it but do remove
2972 // it from the hashtable.
2973 if (func_remove(fp))
2974 fp->uf_refcount--;
2975 }
2976 else
2977 {
2978 func_clear(fp, TRUE);
2979 // When clearing a function another function can be
2980 // cleared as a side effect. When that happens start
2981 // over.
2982 if (changed != func_hashtab.ht_changed)
2983 break;
2984 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002985 }
2986 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002987 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002988 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002989}
2990
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991#if defined(EXITFREE) || defined(PROTO)
2992 void
2993free_all_functions(void)
2994{
2995 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002996 ufunc_T *fp;
2997 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002998 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002999 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000
Bram Moolenaare38eab22019-12-05 21:50:01 +01003001 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003002 while (current_funccal != NULL)
3003 {
3004 clear_tv(current_funccal->rettv);
3005 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003006 if (current_funccal == NULL && funccal_stack != NULL)
3007 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003008 }
3009
Bram Moolenaare38eab22019-12-05 21:50:01 +01003010 // First clear what the functions contain. Since this may lower the
3011 // reference count of a function, it may also free a function and change
3012 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003013 while (todo > 0)
3014 {
3015 todo = func_hashtab.ht_used;
3016 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3017 if (!HASHITEM_EMPTY(hi))
3018 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003019 // clear the def function index now
3020 fp = HI2UF(hi);
3021 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003022 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023
Bram Moolenaare38eab22019-12-05 21:50:01 +01003024 // Only free functions that are not refcounted, those are
3025 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003026 if (func_name_refcount(fp->uf_name))
3027 ++skipped;
3028 else
3029 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003030 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003031 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003032 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003033 {
3034 skipped = 0;
3035 break;
3036 }
3037 }
3038 --todo;
3039 }
3040 }
3041
Bram Moolenaare38eab22019-12-05 21:50:01 +01003042 // Now actually free the functions. Need to start all over every time,
3043 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003044 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003045 while (func_hashtab.ht_used > skipped)
3046 {
3047 todo = func_hashtab.ht_used;
3048 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 if (!HASHITEM_EMPTY(hi))
3050 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003051 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003052 // Only free functions that are not refcounted, those are
3053 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003054 fp = HI2UF(hi);
3055 if (func_name_refcount(fp->uf_name))
3056 ++skipped;
3057 else
3058 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003059 if (func_free(fp, FALSE) == OK)
3060 {
3061 skipped = 0;
3062 break;
3063 }
3064 // did not actually free it
3065 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003066 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003067 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003068 }
3069 if (skipped == 0)
3070 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071
3072 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073}
3074#endif
3075
3076/*
3077 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003078 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079 * "len" is the length of "name", or -1 for NUL terminated.
3080 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003081 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082builtin_function(char_u *name, int len)
3083{
3084 char_u *p;
3085
Bram Moolenaara26b9702020-04-18 19:53:28 +02003086 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 return FALSE;
3088 p = vim_strchr(name, AUTOLOAD_CHAR);
3089 return p == NULL || (len > 0 && p > name + len);
3090}
3091
3092 int
3093func_call(
3094 char_u *name,
3095 typval_T *args,
3096 partial_T *partial,
3097 dict_T *selfdict,
3098 typval_T *rettv)
3099{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003100 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 listitem_T *item;
3102 typval_T argv[MAX_FUNC_ARGS + 1];
3103 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003104 int r = 0;
3105
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003106 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003107 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 {
3109 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3110 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003111 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 break;
3113 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003114 // Make a copy of each argument. This is needed to be able to set
3115 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 copy_tv(&item->li_tv, &argv[argc++]);
3117 }
3118
3119 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003120 {
3121 funcexe_T funcexe;
3122
Bram Moolenaara80faa82020-04-12 19:37:17 +02003123 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003124 funcexe.firstline = curwin->w_cursor.lnum;
3125 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003126 funcexe.evaluate = TRUE;
3127 funcexe.partial = partial;
3128 funcexe.selfdict = selfdict;
3129 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3130 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131
Bram Moolenaare38eab22019-12-05 21:50:01 +01003132 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133 while (argc > 0)
3134 clear_tv(&argv[--argc]);
3135
3136 return r;
3137}
3138
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003139static int callback_depth = 0;
3140
3141 int
3142get_callback_depth(void)
3143{
3144 return callback_depth;
3145}
3146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003148 * Invoke call_func() with a callback.
3149 */
3150 int
3151call_callback(
3152 callback_T *callback,
3153 int len, // length of "name" or -1 to use strlen()
3154 typval_T *rettv, // return value goes here
3155 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003156 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003157 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003158{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003159 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003160 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003161
Bram Moolenaara80faa82020-04-12 19:37:17 +02003162 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003163 funcexe.evaluate = TRUE;
3164 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003165 ++callback_depth;
3166 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3167 --callback_depth;
3168 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003169}
3170
3171/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003172 * Give an error message for the result of a function.
3173 * Nothing if "error" is FCERR_NONE.
3174 */
3175 void
3176user_func_error(int error, char_u *name)
3177{
3178 switch (error)
3179 {
3180 case FCERR_UNKNOWN:
3181 emsg_funcname(e_unknownfunc, name);
3182 break;
3183 case FCERR_NOTMETHOD:
3184 emsg_funcname(
3185 N_("E276: Cannot use function as a method: %s"), name);
3186 break;
3187 case FCERR_DELETED:
3188 emsg_funcname(N_(e_func_deleted), name);
3189 break;
3190 case FCERR_TOOMANY:
3191 emsg_funcname((char *)e_toomanyarg, name);
3192 break;
3193 case FCERR_TOOFEW:
3194 emsg_funcname((char *)e_toofewarg, name);
3195 break;
3196 case FCERR_SCRIPT:
3197 emsg_funcname(
3198 N_("E120: Using <SID> not in a script context: %s"), name);
3199 break;
3200 case FCERR_DICT:
3201 emsg_funcname(
3202 N_("E725: Calling dict function without Dictionary: %s"),
3203 name);
3204 break;
3205 }
3206}
3207
3208/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003210 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 * Return FAIL when the function can't be called, OK otherwise.
3212 * Also returns OK when an error was encountered while executing the function.
3213 */
3214 int
3215call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003216 char_u *funcname, // name of the function
3217 int len, // length of "name" or -1 to use strlen()
3218 typval_T *rettv, // return value goes here
3219 int argcount_in, // number of "argvars"
3220 typval_T *argvars_in, // vars for arguments, must have "argcount"
3221 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003222 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223{
3224 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003225 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003227 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 char_u fname_buf[FLEN_FIXED + 1];
3229 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003230 char_u *fname = NULL;
3231 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 int argcount = argcount_in;
3233 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003234 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003235 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3236 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003238 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003239 partial_T *partial = funcexe->partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003240 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003242 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3243 // even when call_func() returns FAIL.
3244 rettv->v_type = VAR_UNKNOWN;
3245
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003246 if (partial != NULL)
3247 fp = partial->pt_func;
3248 if (fp == NULL)
3249 {
3250 // Make a copy of the name, if it comes from a funcref variable it
3251 // could be changed or deleted in the called function.
3252 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3253 if (name == NULL)
3254 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003256 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3257 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003259 if (funcexe->doesrange != NULL)
3260 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261
3262 if (partial != NULL)
3263 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003264 // When the function has a partial with a dict and there is a dict
3265 // argument, use the dict argument. That is backwards compatible.
3266 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003267 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003269 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 {
3271 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003272 {
3273 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3274 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003275 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003276 goto theend;
3277 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003279 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 for (i = 0; i < argcount_in; ++i)
3281 argv[i + argv_clear] = argvars_in[i];
3282 argvars = argv;
3283 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003284
Bram Moolenaar22f85d02021-07-04 23:29:30 +02003285 if (funcexe->check_type != NULL
3286 && funcexe->check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003287 {
3288 // Now funcexe->check_type is missing the added arguments, make
3289 // a copy of the type with the correction.
3290 check_type = *funcexe->check_type;
3291 funcexe->check_type = &check_type;
3292 check_type.tt_argcount += partial->pt_argc;
3293 check_type.tt_min_argcount += partial->pt_argc;
3294 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003295 }
3296 }
3297
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003298 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3299 {
3300 // Check that the argument types are OK for the types of the funcref.
3301 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003302 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003303 error = FCERR_OTHER;
3304 }
3305
Bram Moolenaaref140542019-12-31 21:27:13 +01003306 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 {
3308 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003309 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310
Bram Moolenaar333894b2020-08-01 18:53:07 +02003311 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003312 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003313 {
3314 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003316 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317
Bram Moolenaare38eab22019-12-05 21:50:01 +01003318 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003320 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003322 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323 {
3324 /*
3325 * User defined function.
3326 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003327 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003328 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329
Bram Moolenaare38eab22019-12-05 21:50:01 +01003330 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 if (fp == NULL
3332 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003333 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334 && !aborting())
3335 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003336 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003337 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003339 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3341 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003342 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003343 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003345 if (fp == NULL)
3346 {
3347 char_u *p = untrans_function_name(rfname);
3348
3349 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003350 // Don't do this if the name starts with "s:".
3351 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003352 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003353 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003355 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003356 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003357#ifdef FEAT_LUA
3358 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3359 {
3360 cfunc_T cb = fp->uf_cb;
3361
3362 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3363 }
3364#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003365 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003367 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003368 // postponed filling in the arguments, do it now
3369 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003370 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003371
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003372 if (funcexe->basetv != NULL)
3373 {
3374 // Method call: base->Method()
3375 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3376 argv[0] = *funcexe->basetv;
3377 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003378 argvars = argv;
3379 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003380 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003381
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003382 error = call_user_func_check(fp, argcount, argvars, rettv,
3383 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 }
3385 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003386 else if (funcexe->basetv != NULL)
3387 {
3388 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003389 * expr->method(): Find the method name in the table, call its
3390 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003391 */
3392 error = call_internal_method(fname, argcount, argvars, rettv,
3393 funcexe->basetv);
3394 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395 else
3396 {
3397 /*
3398 * Find the function name in the table, call its implementation.
3399 */
3400 error = call_internal_func(fname, argcount, argvars, rettv);
3401 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003402
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 /*
3404 * The function call (or "FuncUndefined" autocommand sequence) might
3405 * have been aborted by an error, an interrupt, or an explicitly thrown
3406 * exception that has not been caught so far. This situation can be
3407 * tested for by calling aborting(). For an error in an internal
3408 * function or for the "E132" error in call_user_func(), however, the
3409 * throw point at which the "force_abort" flag (temporarily reset by
3410 * emsg()) is normally updated has not been reached yet. We need to
3411 * update that flag first to make aborting() reliable.
3412 */
3413 update_force_abort();
3414 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003415 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416 ret = OK;
3417
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003418theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 /*
3420 * Report an error unless the argument evaluation or function call has been
3421 * cancelled due to an aborting error, an interrupt, or an exception.
3422 */
3423 if (!aborting())
3424 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003425 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 }
3427
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003428 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003430 clear_tv(&argv[--argv_clear + argv_base]);
3431
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 vim_free(tofree);
3433 vim_free(name);
3434
3435 return ret;
3436}
3437
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003438 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003439printable_func_name(ufunc_T *fp)
3440{
3441 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3442}
3443
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003445 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446 */
3447 static void
3448list_func_head(ufunc_T *fp, int indent)
3449{
3450 int j;
3451
3452 msg_start();
3453 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003454 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003455 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003456 msg_puts("def ");
3457 else
3458 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 msg_putchar('(');
3461 for (j = 0; j < fp->uf_args.ga_len; ++j)
3462 {
3463 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003464 msg_puts(", ");
3465 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466 if (fp->uf_arg_types != NULL)
3467 {
3468 char *tofree;
3469
3470 msg_puts(": ");
3471 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3472 vim_free(tofree);
3473 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003474 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3475 {
3476 msg_puts(" = ");
3477 msg_puts(((char **)(fp->uf_def_args.ga_data))
3478 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480 }
3481 if (fp->uf_varargs)
3482 {
3483 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003484 msg_puts(", ");
3485 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003487 if (fp->uf_va_name != NULL)
3488 {
3489 if (j)
3490 msg_puts(", ");
3491 msg_puts("...");
3492 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003493 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003494 {
3495 char *tofree;
3496
3497 msg_puts(": ");
3498 msg_puts(type_name(fp->uf_va_type, &tofree));
3499 vim_free(tofree);
3500 }
3501 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003503
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003504 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003505 {
3506 if (fp->uf_ret_type != &t_void)
3507 {
3508 char *tofree;
3509
3510 msg_puts(": ");
3511 msg_puts(type_name(fp->uf_ret_type, &tofree));
3512 vim_free(tofree);
3513 }
3514 }
3515 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003516 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003517 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003518 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003520 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003521 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003522 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 msg_clr_eos();
3524 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003525 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526}
3527
3528/*
3529 * Get a function name, translating "<SID>" and "<SNR>".
3530 * Also handles a Funcref in a List or Dictionary.
3531 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003532 * Set "*is_global" to TRUE when the function must be global, unless
3533 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534 * flags:
3535 * TFN_INT: internal function name OK
3536 * TFN_QUIET: be quiet
3537 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003538 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 * Advances "pp" to just after the function name (if no error).
3540 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003541 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542trans_function_name(
3543 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003544 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003545 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003547 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003548 partial_T **partial, // return: partial of a FuncRef
3549 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550{
3551 char_u *name = NULL;
3552 char_u *start;
3553 char_u *end;
3554 int lead;
3555 char_u sid_buf[20];
3556 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003557 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003559 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003560 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561
3562 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003563 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 start = *pp;
3565
Bram Moolenaare38eab22019-12-05 21:50:01 +01003566 // Check for hard coded <SNR>: already translated function ID (from a user
3567 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3569 && (*pp)[2] == (int)KE_SNR)
3570 {
3571 *pp += 3;
3572 len = get_id_len(pp) + 3;
3573 return vim_strnsave(start, len);
3574 }
3575
Bram Moolenaare38eab22019-12-05 21:50:01 +01003576 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3577 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 lead = eval_fname_script(start);
3579 if (lead > 2)
3580 start += lead;
3581
Bram Moolenaare38eab22019-12-05 21:50:01 +01003582 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003583 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584 lead > 2 ? 0 : FNE_CHECK_START);
3585 if (end == start)
3586 {
3587 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003588 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 goto theend;
3590 }
3591 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3592 {
3593 /*
3594 * Report an invalid expression in braces, unless the expression
3595 * evaluation has been cancelled due to an aborting error, an
3596 * interrupt, or an exception.
3597 */
3598 if (!aborting())
3599 {
3600 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003601 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 }
3603 else
3604 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3605 goto theend;
3606 }
3607
3608 if (lv.ll_tv != NULL)
3609 {
3610 if (fdp != NULL)
3611 {
3612 fdp->fd_dict = lv.ll_dict;
3613 fdp->fd_newkey = lv.ll_newkey;
3614 lv.ll_newkey = NULL;
3615 fdp->fd_di = lv.ll_di;
3616 }
3617 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3618 {
3619 name = vim_strsave(lv.ll_tv->vval.v_string);
3620 *pp = end;
3621 }
3622 else if (lv.ll_tv->v_type == VAR_PARTIAL
3623 && lv.ll_tv->vval.v_partial != NULL)
3624 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003625 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003626 *pp = end;
3627 if (partial != NULL)
3628 *partial = lv.ll_tv->vval.v_partial;
3629 }
3630 else
3631 {
3632 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3633 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003634 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 else
3636 *pp = end;
3637 name = NULL;
3638 }
3639 goto theend;
3640 }
3641
3642 if (lv.ll_name == NULL)
3643 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003644 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 *pp = end;
3646 goto theend;
3647 }
3648
Bram Moolenaare38eab22019-12-05 21:50:01 +01003649 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 if (lv.ll_exp_name != NULL)
3651 {
3652 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003653 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654 flags & TFN_NO_AUTOLOAD);
3655 if (name == lv.ll_exp_name)
3656 name = NULL;
3657 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003658 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 {
3660 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003661 name = deref_func_name(*pp, &len, partial, type,
3662 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 if (name == *pp)
3664 name = NULL;
3665 }
3666 if (name != NULL)
3667 {
3668 name = vim_strsave(name);
3669 *pp = end;
3670 if (STRNCMP(name, "<SNR>", 5) == 0)
3671 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003672 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 name[0] = K_SPECIAL;
3674 name[1] = KS_EXTRA;
3675 name[2] = (int)KE_SNR;
3676 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3677 }
3678 goto theend;
3679 }
3680
3681 if (lv.ll_exp_name != NULL)
3682 {
3683 len = (int)STRLEN(lv.ll_exp_name);
3684 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3685 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3686 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003687 // When there was "s:" already or the name expanded to get a
3688 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 lv.ll_name += 2;
3690 len -= 2;
3691 lead = 2;
3692 }
3693 }
3694 else
3695 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003696 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003698 {
3699 if (is_global != NULL && lv.ll_name[0] == 'g')
3700 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 len = (int)(end - lv.ll_name);
3704 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003705 if (len <= 0)
3706 {
3707 if (!skip)
3708 emsg(_(e_function_name));
3709 goto theend;
3710 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003712 // In Vim9 script a user function is script-local by default, unless it
3713 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003714 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003715 if (vim9script)
3716 {
3717 char_u *p;
3718
3719 // SomeScript#func() is a global function.
3720 for (p = start; *p != NUL && *p != '('; ++p)
3721 if (*p == AUTOLOAD_CHAR)
3722 vim9script = FALSE;
3723 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003724
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 /*
3726 * Copy the function name to allocated memory.
3727 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3728 * Accept <SNR>123_name() outside a script.
3729 */
3730 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003731 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003732 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003734 if (!vim9script)
3735 lead = 3;
3736 if (vim9script || (lv.ll_exp_name != NULL
3737 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 || eval_fname_sid(*pp))
3739 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003740 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003741 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003743 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 goto theend;
3745 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003746 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003747 if (vim9script)
3748 extra = 3 + (int)STRLEN(sid_buf);
3749 else
3750 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 }
3752 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003753 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3754 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003756 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 start);
3758 goto theend;
3759 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003760 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 {
3762 char_u *cp = vim_strchr(lv.ll_name, ':');
3763
3764 if (cp != NULL && cp < end)
3765 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003766 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 goto theend;
3768 }
3769 }
3770
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003771 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 if (name != NULL)
3773 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003774 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775 {
3776 name[0] = K_SPECIAL;
3777 name[1] = KS_EXTRA;
3778 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003779 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 STRCPY(name + 3, sid_buf);
3781 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003782 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3783 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784 }
3785 *pp = end;
3786
3787theend:
3788 clear_lval(&lv);
3789 return name;
3790}
3791
3792/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003793 * Assuming "name" is the result of trans_function_name() and it was prefixed
3794 * to use the script-local name, return the unmodified name (points into
3795 * "name"). Otherwise return NULL.
3796 * This can be used to first search for a script-local function and fall back
3797 * to the global function if not found.
3798 */
3799 char_u *
3800untrans_function_name(char_u *name)
3801{
3802 char_u *p;
3803
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003804 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003805 {
3806 p = vim_strchr(name, '_');
3807 if (p != NULL)
3808 return p + 1;
3809 }
3810 return NULL;
3811}
3812
3813/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003814 * List functions. When "regmatch" is NULL all of then.
3815 * Otherwise functions matching "regmatch".
3816 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003817 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003818list_functions(regmatch_T *regmatch)
3819{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003820 int changed = func_hashtab.ht_changed;
3821 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003822 hashitem_T *hi;
3823
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003824 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003825 {
3826 if (!HASHITEM_EMPTY(hi))
3827 {
3828 ufunc_T *fp = HI2UF(hi);
3829
3830 --todo;
3831 if ((fp->uf_flags & FC_DEAD) == 0
3832 && (regmatch == NULL
3833 ? !message_filtered(fp->uf_name)
3834 && !func_name_refcount(fp->uf_name)
3835 : !isdigit(*fp->uf_name)
3836 && vim_regexec(regmatch, fp->uf_name, 0)))
3837 {
3838 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003839 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003840 {
3841 emsg(_("E454: function list was modified"));
3842 return;
3843 }
3844 }
3845 }
3846 }
3847}
3848
3849/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003850 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003851 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3852 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003853 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003855 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003856define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003858 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859 int j;
3860 int c;
3861 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003862 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003863 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 char_u *p;
3865 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003866 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 char_u *line_arg = NULL;
3868 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003869 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003870 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 garray_T newlines;
3872 int varargs = FALSE;
3873 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003874 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003875 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003876 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 dictitem_T *v;
3878 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003879 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003880 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003882 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003883 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003884 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885
3886 /*
3887 * ":function" without argument: list functions.
3888 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003889 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003890 {
3891 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003892 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003893 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003894 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 }
3896
3897 /*
3898 * ":function /pat": list functions matching pattern.
3899 */
3900 if (*eap->arg == '/')
3901 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003902 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003903 if (!eap->skip)
3904 {
3905 regmatch_T regmatch;
3906
3907 c = *p;
3908 *p = NUL;
3909 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3910 *p = c;
3911 if (regmatch.regprog != NULL)
3912 {
3913 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003914 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 vim_regfree(regmatch.regprog);
3916 }
3917 }
3918 if (*p == '/')
3919 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02003920 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003921 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 }
3923
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003924 ga_init(&newargs);
3925 ga_init(&argtypes);
3926 ga_init(&default_args);
3927
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003928 /*
3929 * Get the function name. There are these situations:
3930 * func normal function name
3931 * "name" == func, "fudi.fd_dict" == NULL
3932 * dict.func new dictionary entry
3933 * "name" == NULL, "fudi.fd_dict" set,
3934 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3935 * dict.func existing dict entry with a Funcref
3936 * "name" == func, "fudi.fd_dict" set,
3937 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3938 * dict.func existing dict entry that's not a Funcref
3939 * "name" == NULL, "fudi.fd_dict" set,
3940 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3941 * s:func script-local function name
3942 * g:func global function name, same as "func"
3943 */
3944 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003945 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003947 // nested function, argument is (args).
3948 paren = TRUE;
3949 CLEAR_FIELD(fudi);
3950 }
3951 else
3952 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003953 if (STRNCMP(p, "<lambda>", 8) == 0)
3954 {
3955 p += 8;
3956 (void)getdigits(&p);
3957 name = vim_strnsave(eap->arg, p - eap->arg);
3958 CLEAR_FIELD(fudi);
3959 }
3960 else
3961 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003962 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003963 paren = (vim_strchr(p, '(') != NULL);
3964 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003966 /*
3967 * Return on an invalid expression in braces, unless the expression
3968 * evaluation has been cancelled due to an aborting error, an
3969 * interrupt, or an exception.
3970 */
3971 if (!aborting())
3972 {
3973 if (!eap->skip && fudi.fd_newkey != NULL)
3974 semsg(_(e_dictkey), fudi.fd_newkey);
3975 vim_free(fudi.fd_newkey);
3976 return NULL;
3977 }
3978 else
3979 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 }
3982
Bram Moolenaare38eab22019-12-05 21:50:01 +01003983 // An error in a function call during evaluation of an expression in magic
3984 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 saved_did_emsg = did_emsg;
3986 did_emsg = FALSE;
3987
3988 /*
3989 * ":function func" with only function name: list function.
3990 */
3991 if (!paren)
3992 {
3993 if (!ends_excmd(*skipwhite(p)))
3994 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003995 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 goto ret_free;
3997 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02003998 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 if (eap->nextcmd != NULL)
4000 *p = NUL;
4001 if (!eap->skip && !got_int)
4002 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004003 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004004 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4005 {
4006 char_u *up = untrans_function_name(name);
4007
4008 // With Vim9 script the name was made script-local, if not
4009 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004010 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004011 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004012 }
4013
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 if (fp != NULL)
4015 {
4016 list_func_head(fp, TRUE);
4017 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4018 {
4019 if (FUNCLINE(fp, j) == NULL)
4020 continue;
4021 msg_putchar('\n');
4022 msg_outnum((long)(j + 1));
4023 if (j < 9)
4024 msg_putchar(' ');
4025 if (j < 99)
4026 msg_putchar(' ');
4027 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004028 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 ui_breakcheck();
4030 }
4031 if (!got_int)
4032 {
4033 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004034 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004035 msg_puts(" enddef");
4036 else
4037 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 }
4039 }
4040 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004041 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 }
4043 goto ret_free;
4044 }
4045
4046 /*
4047 * ":function name(arg1, arg2)" Define function.
4048 */
4049 p = skipwhite(p);
4050 if (*p != '(')
4051 {
4052 if (!eap->skip)
4053 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004054 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 goto ret_free;
4056 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004057 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 if (vim_strchr(p, '(') != NULL)
4059 p = vim_strchr(p, '(');
4060 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004062 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4063 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004064 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004065 goto ret_free;
4066 }
4067
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004068 // In Vim9 script only global functions can be redefined.
4069 if (vim9script && eap->forceit && !is_global)
4070 {
4071 emsg(_(e_nobang));
4072 goto ret_free;
4073 }
4074
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004075 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076
Bram Moolenaar04b12692020-05-04 23:24:44 +02004077 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004079 // Check the name of the function. Unless it's a dictionary function
4080 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 if (name != NULL)
4082 arg = name;
4083 else
4084 arg = fudi.fd_newkey;
4085 if (arg != NULL && (fudi.fd_di == NULL
4086 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4087 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4088 {
4089 if (*arg == K_SPECIAL)
4090 j = 3;
4091 else
4092 j = 0;
4093 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
4094 : eval_isnamec(arg[j])))
4095 ++j;
4096 if (arg[j] != NUL)
4097 emsg_funcname((char *)e_invarg2, arg);
4098 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004099 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004100 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004101 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 }
4103
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004104 // This may get more lines and make the pointers into the first line
4105 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004106 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004107 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004108 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004109 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004110 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004112 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004114 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004116 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004117 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004119 if (*p != ':')
4120 {
4121 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4122 p = skipwhite(p);
4123 }
4124 else if (!IS_WHITE_OR_NUL(p[1]))
4125 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004126 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004127 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004128 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004129 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004130 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004131 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004133 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004134 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004135 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004136 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004137 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004138 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004140 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004142 else
4143 // find extra arguments "range", "dict", "abort" and "closure"
4144 for (;;)
4145 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004146 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004147 p = skipwhite(p);
4148 if (STRNCMP(p, "range", 5) == 0)
4149 {
4150 flags |= FC_RANGE;
4151 p += 5;
4152 }
4153 else if (STRNCMP(p, "dict", 4) == 0)
4154 {
4155 flags |= FC_DICT;
4156 p += 4;
4157 }
4158 else if (STRNCMP(p, "abort", 5) == 0)
4159 {
4160 flags |= FC_ABORT;
4161 p += 5;
4162 }
4163 else if (STRNCMP(p, "closure", 7) == 0)
4164 {
4165 flags |= FC_CLOSURE;
4166 p += 7;
4167 if (current_funccal == NULL)
4168 {
4169 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4170 name == NULL ? (char_u *)"" : name);
4171 goto erret;
4172 }
4173 }
4174 else
4175 break;
4176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177
Bram Moolenaare38eab22019-12-05 21:50:01 +01004178 // When there is a line break use what follows for the function body.
4179 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180 if (*p == '\n')
4181 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004182 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004183 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4184 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004185 && !(VIM_ISWHITE(*whitep) && *p == '#'
4186 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004187 && !eap->skip
4188 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004189 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190
4191 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004192 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4193 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 */
4195 if (KeyTyped)
4196 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004197 // Check if the function already exists, don't let the user type the
4198 // whole function before telling him it doesn't work! For a script we
4199 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004200 if (!eap->skip && !eap->forceit)
4201 {
4202 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004203 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004204 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004205 emsg_funcname(e_funcexts, name);
4206 }
4207
4208 if (!eap->skip && did_emsg)
4209 goto erret;
4210
Bram Moolenaare38eab22019-12-05 21:50:01 +01004211 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 cmdline_row = msg_row;
4213 }
4214
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004215 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004216 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004217
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004218 // Do not define the function when getting the body fails and when
4219 // skipping.
4220 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4221 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222 goto erret;
4223
4224 /*
4225 * If there are no errors, add the function
4226 */
4227 if (fudi.fd_dict == NULL)
4228 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004229 hashtab_T *ht;
4230
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004231 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4233 {
4234 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4235 name);
4236 goto erret;
4237 }
4238
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004239 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004240 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004242 char_u *uname = untrans_function_name(name);
4243
4244 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4245 }
4246
4247 if (fp != NULL || import != NULL)
4248 {
4249 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004250
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004251 // Function can be replaced with "function!" and when sourcing the
4252 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004253 // A name that is used by an import can not be overruled.
4254 if (import != NULL
4255 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004256 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004257 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004259 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004260 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004261 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004262 else
4263 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 goto erret;
4265 }
4266 if (fp->uf_calls > 0)
4267 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004268 emsg_funcname(
4269 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 name);
4271 goto erret;
4272 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004273 if (fp->uf_refcount > 1)
4274 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004275 // This function is referenced somewhere, don't redefine it but
4276 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004277 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004278 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004279 fp = NULL;
4280 overwrite = TRUE;
4281 }
4282 else
4283 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004284 char_u *exp_name = fp->uf_name_exp;
4285
4286 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004287 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004288 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004289 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004290 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004291 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004292#ifdef FEAT_PROFILE
4293 fp->uf_profiling = FALSE;
4294 fp->uf_prof_initialized = FALSE;
4295#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004296 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004297 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298 }
4299 }
4300 else
4301 {
4302 char numbuf[20];
4303
4304 fp = NULL;
4305 if (fudi.fd_newkey == NULL && !eap->forceit)
4306 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004307 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 goto erret;
4309 }
4310 if (fudi.fd_di == NULL)
4311 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004312 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004313 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 goto erret;
4315 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004316 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004317 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 goto erret;
4319
Bram Moolenaare38eab22019-12-05 21:50:01 +01004320 // Give the function a sequential number. Can only be used with a
4321 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 vim_free(name);
4323 sprintf(numbuf, "%d", ++func_nr);
4324 name = vim_strsave((char_u *)numbuf);
4325 if (name == NULL)
4326 goto erret;
4327 }
4328
4329 if (fp == NULL)
4330 {
4331 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4332 {
4333 int slen, plen;
4334 char_u *scriptname;
4335
Bram Moolenaare38eab22019-12-05 21:50:01 +01004336 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004338 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004339 {
4340 scriptname = autoload_name(name);
4341 if (scriptname != NULL)
4342 {
4343 p = vim_strchr(scriptname, '/');
4344 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004345 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004347 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348 j = OK;
4349 vim_free(scriptname);
4350 }
4351 }
4352 if (j == FAIL)
4353 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004354 linenr_T save_lnum = SOURCING_LNUM;
4355
4356 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004357 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004358 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359 goto erret;
4360 }
4361 }
4362
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004363 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004364 if (fp == NULL)
4365 goto erret;
4366
4367 if (fudi.fd_dict != NULL)
4368 {
4369 if (fudi.fd_di == NULL)
4370 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004371 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4373 if (fudi.fd_di == NULL)
4374 {
4375 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004376 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 goto erret;
4378 }
4379 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4380 {
4381 vim_free(fudi.fd_di);
4382 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004383 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 goto erret;
4385 }
4386 }
4387 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004388 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389 clear_tv(&fudi.fd_di->di_tv);
4390 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392
Bram Moolenaare38eab22019-12-05 21:50:01 +01004393 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 flags |= FC_DICT;
4395 }
4396
Bram Moolenaare38eab22019-12-05 21:50:01 +01004397 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004398 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004399 if (overwrite)
4400 {
4401 hi = hash_find(&func_hashtab, name);
4402 hi->hi_key = UF2HIKEY(fp);
4403 }
4404 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 {
4406 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004407 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 goto erret;
4409 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004410 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 }
4412 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004413 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004414 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004415 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004416
4417 if (eap->cmdidx == CMD_def)
4418 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004419 int lnum_save = SOURCING_LNUM;
4420 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004421
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004422 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004423
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004424 // error messages are for the first function line
4425 SOURCING_LNUM = sourcing_lnum_top;
4426
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004427 // The function may use script variables from the context.
4428 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004429
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004430 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004431 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004432 SOURCING_LNUM = lnum_save;
4433 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004434 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004435 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004436
4437 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004438 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004439 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004440 SOURCING_LNUM = lnum_save;
4441 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004442 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004443 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004444 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004445 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004446 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004447
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004449 if ((flags & FC_CLOSURE) != 0)
4450 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004451 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004452 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004453 }
4454 else
4455 fp->uf_scoped = NULL;
4456
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458 if (prof_def_func())
4459 func_do_profile(fp);
4460#endif
4461 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004462 if (sandbox)
4463 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004464 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004465 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 fp->uf_flags = flags;
4467 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004468 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004469 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004470 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004471 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004472 if (is_export)
4473 {
4474 fp->uf_flags |= FC_EXPORT;
4475 // let ex_export() know the export worked.
4476 is_export = FALSE;
4477 }
4478
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004479 if (eap->cmdidx == CMD_def)
4480 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004481 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4482 // :func does not use Vim9 script syntax, even in a Vim9 script file
4483 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004484
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 goto ret_free;
4486
4487erret:
4488 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004489 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004490 if (fp != NULL)
4491 {
4492 ga_init(&fp->uf_args);
4493 ga_init(&fp->uf_def_args);
4494 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495errret_2:
4496 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004497 if (fp != NULL)
4498 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004500 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004501 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004503 if (name != name_arg)
4504 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004505 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004507
4508 return fp;
4509}
4510
4511/*
4512 * ":function"
4513 */
4514 void
4515ex_function(exarg_T *eap)
4516{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004517 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004518}
4519
4520/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004521 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004522 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004523 */
4524 void
4525ex_defcompile(exarg_T *eap UNUSED)
4526{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004527 long todo = (long)func_hashtab.ht_used;
4528 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004529 hashitem_T *hi;
4530 ufunc_T *ufunc;
4531
4532 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4533 {
4534 if (!HASHITEM_EMPTY(hi))
4535 {
4536 --todo;
4537 ufunc = HI2UF(hi);
4538 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004539 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4540 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004541 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004542 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004543
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004544 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004545 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004546 // a function has been added or removed, need to start over
4547 todo = (long)func_hashtab.ht_used;
4548 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004549 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004550 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004551 }
4552 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004553 }
4554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555}
4556
4557/*
4558 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4559 * Return 2 if "p" starts with "s:".
4560 * Return 0 otherwise.
4561 */
4562 int
4563eval_fname_script(char_u *p)
4564{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004565 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4566 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4568 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4569 return 5;
4570 if (p[0] == 's' && p[1] == ':')
4571 return 2;
4572 return 0;
4573}
4574
4575 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004576translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577{
4578 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004579 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004580 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004581}
4582
4583/*
4584 * Return TRUE when "ufunc" has old-style "..." varargs
4585 * or named varargs "...name: type".
4586 */
4587 int
4588has_varargs(ufunc_T *ufunc)
4589{
4590 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591}
4592
4593/*
4594 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004595 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 */
4597 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004598function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599{
4600 char_u *nm = name;
4601 char_u *p;
4602 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004603 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004604 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004605
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004606 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4607 if (no_deref)
4608 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004609 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610 nm = skipwhite(nm);
4611
Bram Moolenaare38eab22019-12-05 21:50:01 +01004612 // Only accept "funcname", "funcname ", "funcname (..." and
4613 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004615 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616 vim_free(p);
4617 return n;
4618}
4619
Bram Moolenaar113e1072019-01-20 15:30:40 +01004620#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004621 char_u *
4622get_expanded_name(char_u *name, int check)
4623{
4624 char_u *nm = name;
4625 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004626 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004628 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004629 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004631 if (p != NULL && *nm == NUL
4632 && (!check || translated_function_exists(p, is_global)))
4633 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634
4635 vim_free(p);
4636 return NULL;
4637}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004638#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004640/*
4641 * Function given to ExpandGeneric() to obtain the list of user defined
4642 * function names.
4643 */
4644 char_u *
4645get_user_func_name(expand_T *xp, int idx)
4646{
4647 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004648 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649 static hashitem_T *hi;
4650 ufunc_T *fp;
4651
4652 if (idx == 0)
4653 {
4654 done = 0;
4655 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004656 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004657 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004658 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659 {
4660 if (done++ > 0)
4661 ++hi;
4662 while (HASHITEM_EMPTY(hi))
4663 ++hi;
4664 fp = HI2UF(hi);
4665
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004666 // don't show dead, dict and lambda functions
4667 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004668 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004669 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670
4671 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004672 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673
4674 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004675 if (xp->xp_context != EXPAND_USER_FUNC
4676 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004677 {
4678 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004679 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 STRCAT(IObuff, ")");
4681 }
4682 return IObuff;
4683 }
4684 return NULL;
4685}
4686
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687/*
4688 * ":delfunction {name}"
4689 */
4690 void
4691ex_delfunction(exarg_T *eap)
4692{
4693 ufunc_T *fp = NULL;
4694 char_u *p;
4695 char_u *name;
4696 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004697 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698
4699 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004700 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4701 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 vim_free(fudi.fd_newkey);
4703 if (name == NULL)
4704 {
4705 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004706 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 return;
4708 }
4709 if (!ends_excmd(*skipwhite(p)))
4710 {
4711 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004712 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713 return;
4714 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004715 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004716 if (eap->nextcmd != NULL)
4717 *p = NUL;
4718
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004719 if (isdigit(*name) && fudi.fd_dict == NULL)
4720 {
4721 if (!eap->skip)
4722 semsg(_(e_invarg2), eap->arg);
4723 vim_free(name);
4724 return;
4725 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004727 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728 vim_free(name);
4729
4730 if (!eap->skip)
4731 {
4732 if (fp == NULL)
4733 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004734 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004735 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004736 return;
4737 }
4738 if (fp->uf_calls > 0)
4739 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004740 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004741 return;
4742 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004743 if (fp->uf_flags & FC_VIM9)
4744 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004745 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004746 return;
4747 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748
4749 if (fudi.fd_dict != NULL)
4750 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004751 // Delete the dict item that refers to the function, it will
4752 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004753 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4754 }
4755 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004756 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004757 // A normal function (not a numbered function or lambda) has a
4758 // refcount of 1 for the entry in the hashtable. When deleting
4759 // it and the refcount is more than one, it should be kept.
4760 // A numbered function and lambda should be kept if the refcount is
4761 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004762 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004763 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004764 // Function is still referenced somewhere. Don't free it but
4765 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004766 if (func_remove(fp))
4767 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004768 }
4769 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004770 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004771 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772 }
4773}
4774
4775/*
4776 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004777 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 */
4779 void
4780func_unref(char_u *name)
4781{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004782 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004784 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004786 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004787 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004790 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004791#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004792 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004794 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004795}
4796
4797/*
4798 * Unreference a Function: decrement the reference count and free it when it
4799 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004800 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004801 */
4802 void
4803func_ptr_unref(ufunc_T *fp)
4804{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004805 if (fp != NULL && (--fp->uf_refcount <= 0
4806 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4807 && fp->uf_partial->pt_refcount <= 1
4808 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004809 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004810 // Only delete it when it's not being used. Otherwise it's done
4811 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004812 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004813 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814 }
4815}
4816
4817/*
4818 * Count a reference to a Function.
4819 */
4820 void
4821func_ref(char_u *name)
4822{
4823 ufunc_T *fp;
4824
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004825 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004827 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004828 if (fp != NULL)
4829 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004830 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004831 // Only give an error for a numbered function.
4832 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004833 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004834}
4835
4836/*
4837 * Count a reference to a Function.
4838 */
4839 void
4840func_ptr_ref(ufunc_T *fp)
4841{
4842 if (fp != NULL)
4843 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844}
4845
4846/*
4847 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4848 * referenced from anywhere that is in use.
4849 */
4850 static int
4851can_free_funccal(funccall_T *fc, int copyID)
4852{
4853 return (fc->l_varlist.lv_copyID != copyID
4854 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004855 && fc->l_avars.dv_copyID != copyID
4856 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857}
4858
4859/*
4860 * ":return [expr]"
4861 */
4862 void
4863ex_return(exarg_T *eap)
4864{
4865 char_u *arg = eap->arg;
4866 typval_T rettv;
4867 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004868 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869
4870 if (current_funccal == NULL)
4871 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004872 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873 return;
4874 }
4875
Bram Moolenaar844fb642021-10-23 13:32:30 +01004876 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004877 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4878
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879 if (eap->skip)
4880 ++emsg_skip;
4881
4882 eap->nextcmd = NULL;
4883 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004884 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885 {
4886 if (!eap->skip)
4887 returning = do_return(eap, FALSE, TRUE, &rettv);
4888 else
4889 clear_tv(&rettv);
4890 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004891 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 else if (!eap->skip)
4893 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004894 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004895 update_force_abort();
4896
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004897 /*
4898 * Return unless the expression evaluation has been cancelled due to an
4899 * aborting error, an interrupt, or an exception.
4900 */
4901 if (!aborting())
4902 returning = do_return(eap, FALSE, TRUE, NULL);
4903 }
4904
Bram Moolenaare38eab22019-12-05 21:50:01 +01004905 // When skipping or the return gets pending, advance to the next command
4906 // in this line (!returning). Otherwise, ignore the rest of the line.
4907 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 if (returning)
4909 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004910 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02004911 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912
4913 if (eap->skip)
4914 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004915 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916}
4917
4918/*
4919 * ":1,25call func(arg1, arg2)" function call.
4920 */
4921 void
4922ex_call(exarg_T *eap)
4923{
4924 char_u *arg = eap->arg;
4925 char_u *startarg;
4926 char_u *name;
4927 char_u *tofree;
4928 int len;
4929 typval_T rettv;
4930 linenr_T lnum;
4931 int doesrange;
4932 int failed = FALSE;
4933 funcdict_T fudi;
4934 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004935 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004936 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937
Bram Moolenaare6b53242020-07-01 17:28:33 +02004938 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939 if (eap->skip)
4940 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004941 // trans_function_name() doesn't work well when skipping, use eval0()
4942 // instead to skip to any following command, e.g. for:
4943 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004944 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004945 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 clear_tv(&rettv);
4947 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004948 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949 return;
4950 }
4951
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004952 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4953 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004954 if (fudi.fd_newkey != NULL)
4955 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004956 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004957 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004958 vim_free(fudi.fd_newkey);
4959 }
4960 if (tofree == NULL)
4961 return;
4962
Bram Moolenaare38eab22019-12-05 21:50:01 +01004963 // Increase refcount on dictionary, it could get deleted when evaluating
4964 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965 if (fudi.fd_dict != NULL)
4966 ++fudi.fd_dict->dv_refcount;
4967
Bram Moolenaare38eab22019-12-05 21:50:01 +01004968 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4969 // contents. For VAR_PARTIAL get its partial, unless we already have one
4970 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004972 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4973 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974
Bram Moolenaare38eab22019-12-05 21:50:01 +01004975 // Skip white space to allow ":call func ()". Not good, but required for
4976 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978 if (*startarg != '(')
4979 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004980 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004981 goto end;
4982 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02004983 if (in_vim9script() && startarg > arg)
4984 {
4985 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
4986 goto end;
4987 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988
4989 /*
4990 * When skipping, evaluate the function once, to find the end of the
4991 * arguments.
4992 * When the function takes a range, this is discovered after the first
4993 * call, and the loop is broken.
4994 */
4995 if (eap->skip)
4996 {
4997 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004998 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004999 }
5000 else
5001 lnum = eap->line1;
5002 for ( ; lnum <= eap->line2; ++lnum)
5003 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005004 funcexe_T funcexe;
5005
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005006 if (!eap->skip && eap->addr_count > 0)
5007 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005008 if (lnum > curbuf->b_ml.ml_line_count)
5009 {
5010 // If the function deleted lines or switched to another buffer
5011 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005012 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005013 break;
5014 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005015 curwin->w_cursor.lnum = lnum;
5016 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005018 }
5019 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005020
Bram Moolenaara80faa82020-04-12 19:37:17 +02005021 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005022 funcexe.firstline = eap->line1;
5023 funcexe.lastline = eap->line2;
5024 funcexe.doesrange = &doesrange;
5025 funcexe.evaluate = !eap->skip;
5026 funcexe.partial = partial;
5027 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005028 funcexe.check_type = type;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005029 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005030 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031 {
5032 failed = TRUE;
5033 break;
5034 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005035 if (has_watchexpr())
5036 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005038 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005039 if (handle_subscript(&arg, &rettv,
5040 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 {
5042 failed = TRUE;
5043 break;
5044 }
5045
5046 clear_tv(&rettv);
5047 if (doesrange || eap->skip)
5048 break;
5049
Bram Moolenaare38eab22019-12-05 21:50:01 +01005050 // Stop when immediately aborting on error, or when an interrupt
5051 // occurred or an exception was thrown but not caught.
5052 // get_func_tv() returned OK, so that the check for trailing
5053 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005054 if (aborting())
5055 break;
5056 }
5057 if (eap->skip)
5058 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005059 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060
Bram Moolenaar1d341892021-09-18 15:25:52 +02005061 // When inside :try we need to check for following "| catch" or "| endtry".
5062 // Not when there was an error, but do check if an exception was thrown.
5063 if ((!aborting() || did_throw)
5064 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005066 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005067 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005068 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005069 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005070 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005071 {
5072 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005073 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005074 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005075 }
5076 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005077 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005078 }
5079
5080end:
5081 dict_unref(fudi.fd_dict);
5082 vim_free(tofree);
5083}
5084
5085/*
5086 * Return from a function. Possibly makes the return pending. Also called
5087 * for a pending return at the ":endtry" or after returning from an extra
5088 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5089 * when called due to a ":return" command. "rettv" may point to a typval_T
5090 * with the return rettv. Returns TRUE when the return can be carried out,
5091 * FALSE when the return gets pending.
5092 */
5093 int
5094do_return(
5095 exarg_T *eap,
5096 int reanimate,
5097 int is_cmd,
5098 void *rettv)
5099{
5100 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005101 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102
5103 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005104 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005105 current_funccal->returned = FALSE;
5106
5107 /*
5108 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5109 * not in its finally clause (which then is to be executed next) is found.
5110 * In this case, make the ":return" pending for execution at the ":endtry".
5111 * Otherwise, return normally.
5112 */
5113 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5114 if (idx >= 0)
5115 {
5116 cstack->cs_pending[idx] = CSTP_RETURN;
5117
5118 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005119 // A pending return again gets pending. "rettv" points to an
5120 // allocated variable with the rettv of the original ":return"'s
5121 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122 cstack->cs_rettv[idx] = rettv;
5123 else
5124 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005125 // When undoing a return in order to make it pending, get the stored
5126 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127 if (reanimate)
5128 rettv = current_funccal->rettv;
5129
5130 if (rettv != NULL)
5131 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005132 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005133 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5134 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5135 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005136 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137 }
5138 else
5139 cstack->cs_rettv[idx] = NULL;
5140
5141 if (reanimate)
5142 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005143 // The pending return value could be overwritten by a ":return"
5144 // without argument in a finally clause; reset the default
5145 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146 current_funccal->rettv->v_type = VAR_NUMBER;
5147 current_funccal->rettv->vval.v_number = 0;
5148 }
5149 }
5150 report_make_pending(CSTP_RETURN, rettv);
5151 }
5152 else
5153 {
5154 current_funccal->returned = TRUE;
5155
Bram Moolenaare38eab22019-12-05 21:50:01 +01005156 // If the return is carried out now, store the return value. For
5157 // a return immediately after reanimation, the value is already
5158 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159 if (!reanimate && rettv != NULL)
5160 {
5161 clear_tv(current_funccal->rettv);
5162 *current_funccal->rettv = *(typval_T *)rettv;
5163 if (!is_cmd)
5164 vim_free(rettv);
5165 }
5166 }
5167
5168 return idx < 0;
5169}
5170
5171/*
5172 * Free the variable with a pending return value.
5173 */
5174 void
5175discard_pending_return(void *rettv)
5176{
5177 free_tv((typval_T *)rettv);
5178}
5179
5180/*
5181 * Generate a return command for producing the value of "rettv". The result
5182 * is an allocated string. Used by report_pending() for verbose messages.
5183 */
5184 char_u *
5185get_return_cmd(void *rettv)
5186{
5187 char_u *s = NULL;
5188 char_u *tofree = NULL;
5189 char_u numbuf[NUMBUFLEN];
5190
5191 if (rettv != NULL)
5192 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5193 if (s == NULL)
5194 s = (char_u *)"";
5195
5196 STRCPY(IObuff, ":return ");
5197 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5198 if (STRLEN(s) + 8 >= IOSIZE)
5199 STRCPY(IObuff + IOSIZE - 4, "...");
5200 vim_free(tofree);
5201 return vim_strsave(IObuff);
5202}
5203
5204/*
5205 * Get next function line.
5206 * Called by do_cmdline() to get the next line.
5207 * Returns allocated string, or NULL for end of function.
5208 */
5209 char_u *
5210get_func_line(
5211 int c UNUSED,
5212 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005213 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005214 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215{
5216 funccall_T *fcp = (funccall_T *)cookie;
5217 ufunc_T *fp = fcp->func;
5218 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005219 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005220
Bram Moolenaare38eab22019-12-05 21:50:01 +01005221 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005222 if (fcp->dbg_tick != debug_tick)
5223 {
5224 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005225 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005226 fcp->dbg_tick = debug_tick;
5227 }
5228#ifdef FEAT_PROFILE
5229 if (do_profiling == PROF_YES)
5230 func_line_end(cookie);
5231#endif
5232
5233 gap = &fp->uf_lines;
5234 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5235 || fcp->returned)
5236 retval = NULL;
5237 else
5238 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005239 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005240 while (fcp->linenr < gap->ga_len
5241 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5242 ++fcp->linenr;
5243 if (fcp->linenr >= gap->ga_len)
5244 retval = NULL;
5245 else
5246 {
5247 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005248 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249#ifdef FEAT_PROFILE
5250 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005251 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005252#endif
5253 }
5254 }
5255
Bram Moolenaare38eab22019-12-05 21:50:01 +01005256 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005257 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005259 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005260 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005261 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005262 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005263 fcp->dbg_tick = debug_tick;
5264 }
5265
5266 return retval;
5267}
5268
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005269/*
5270 * Return TRUE if the currently active function should be ended, because a
5271 * return was encountered or an error occurred. Used inside a ":while".
5272 */
5273 int
5274func_has_ended(void *cookie)
5275{
5276 funccall_T *fcp = (funccall_T *)cookie;
5277
Bram Moolenaare38eab22019-12-05 21:50:01 +01005278 // Ignore the "abort" flag if the abortion behavior has been changed due to
5279 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005280 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5281 || fcp->returned);
5282}
5283
5284/*
5285 * return TRUE if cookie indicates a function which "abort"s on errors.
5286 */
5287 int
5288func_has_abort(
5289 void *cookie)
5290{
5291 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5292}
5293
5294
5295/*
5296 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5297 * Don't do this when "Func" is already a partial that was bound
5298 * explicitly (pt_auto is FALSE).
5299 * Changes "rettv" in-place.
5300 * Returns the updated "selfdict_in".
5301 */
5302 dict_T *
5303make_partial(dict_T *selfdict_in, typval_T *rettv)
5304{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005305 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005306 char_u *tofree = NULL;
5307 ufunc_T *fp;
5308 char_u fname_buf[FLEN_FIXED + 1];
5309 int error;
5310 dict_T *selfdict = selfdict_in;
5311
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005312 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5313 fp = rettv->vval.v_partial->pt_func;
5314 else
5315 {
5316 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5317 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005318 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005319 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005320 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005321 vim_free(tofree);
5322 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005323
5324 if (fp != NULL && (fp->uf_flags & FC_DICT))
5325 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005326 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005327
5328 if (pt != NULL)
5329 {
5330 pt->pt_refcount = 1;
5331 pt->pt_dict = selfdict;
5332 pt->pt_auto = TRUE;
5333 selfdict = NULL;
5334 if (rettv->v_type == VAR_FUNC)
5335 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005336 // Just a function: Take over the function name and use
5337 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338 pt->pt_name = rettv->vval.v_string;
5339 }
5340 else
5341 {
5342 partial_T *ret_pt = rettv->vval.v_partial;
5343 int i;
5344
Bram Moolenaare38eab22019-12-05 21:50:01 +01005345 // Partial: copy the function name, use selfdict and copy
5346 // args. Can't take over name or args, the partial might
5347 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005348 if (ret_pt->pt_name != NULL)
5349 {
5350 pt->pt_name = vim_strsave(ret_pt->pt_name);
5351 func_ref(pt->pt_name);
5352 }
5353 else
5354 {
5355 pt->pt_func = ret_pt->pt_func;
5356 func_ptr_ref(pt->pt_func);
5357 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358 if (ret_pt->pt_argc > 0)
5359 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005360 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005361 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005362 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005363 pt->pt_argc = 0;
5364 else
5365 {
5366 pt->pt_argc = ret_pt->pt_argc;
5367 for (i = 0; i < pt->pt_argc; i++)
5368 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5369 }
5370 }
5371 partial_unref(ret_pt);
5372 }
5373 rettv->v_type = VAR_PARTIAL;
5374 rettv->vval.v_partial = pt;
5375 }
5376 }
5377 return selfdict;
5378}
5379
5380/*
5381 * Return the name of the executed function.
5382 */
5383 char_u *
5384func_name(void *cookie)
5385{
5386 return ((funccall_T *)cookie)->func->uf_name;
5387}
5388
5389/*
5390 * Return the address holding the next breakpoint line for a funccall cookie.
5391 */
5392 linenr_T *
5393func_breakpoint(void *cookie)
5394{
5395 return &((funccall_T *)cookie)->breakpoint;
5396}
5397
5398/*
5399 * Return the address holding the debug tick for a funccall cookie.
5400 */
5401 int *
5402func_dbg_tick(void *cookie)
5403{
5404 return &((funccall_T *)cookie)->dbg_tick;
5405}
5406
5407/*
5408 * Return the nesting level for a funccall cookie.
5409 */
5410 int
5411func_level(void *cookie)
5412{
5413 return ((funccall_T *)cookie)->level;
5414}
5415
5416/*
5417 * Return TRUE when a function was ended by a ":return" command.
5418 */
5419 int
5420current_func_returned(void)
5421{
5422 return current_funccal->returned;
5423}
5424
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005425 int
5426free_unref_funccal(int copyID, int testing)
5427{
5428 int did_free = FALSE;
5429 int did_free_funccal = FALSE;
5430 funccall_T *fc, **pfc;
5431
5432 for (pfc = &previous_funccal; *pfc != NULL; )
5433 {
5434 if (can_free_funccal(*pfc, copyID))
5435 {
5436 fc = *pfc;
5437 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005438 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439 did_free = TRUE;
5440 did_free_funccal = TRUE;
5441 }
5442 else
5443 pfc = &(*pfc)->caller;
5444 }
5445 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005446 // When a funccal was freed some more items might be garbage
5447 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005448 (void)garbage_collect(testing);
5449
5450 return did_free;
5451}
5452
5453/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005454 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005455 */
5456 static funccall_T *
5457get_funccal(void)
5458{
5459 int i;
5460 funccall_T *funccal;
5461 funccall_T *temp_funccal;
5462
5463 funccal = current_funccal;
5464 if (debug_backtrace_level > 0)
5465 {
5466 for (i = 0; i < debug_backtrace_level; i++)
5467 {
5468 temp_funccal = funccal->caller;
5469 if (temp_funccal)
5470 funccal = temp_funccal;
5471 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005472 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005473 debug_backtrace_level = i;
5474 }
5475 }
5476 return funccal;
5477}
5478
5479/*
5480 * Return the hashtable used for local variables in the current funccal.
5481 * Return NULL if there is no current funccal.
5482 */
5483 hashtab_T *
5484get_funccal_local_ht()
5485{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005486 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487 return NULL;
5488 return &get_funccal()->l_vars.dv_hashtab;
5489}
5490
5491/*
5492 * Return the l: scope variable.
5493 * Return NULL if there is no current funccal.
5494 */
5495 dictitem_T *
5496get_funccal_local_var()
5497{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005498 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499 return NULL;
5500 return &get_funccal()->l_vars_var;
5501}
5502
5503/*
5504 * Return the hashtable used for argument in the current funccal.
5505 * Return NULL if there is no current funccal.
5506 */
5507 hashtab_T *
5508get_funccal_args_ht()
5509{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005510 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005511 return NULL;
5512 return &get_funccal()->l_avars.dv_hashtab;
5513}
5514
5515/*
5516 * Return the a: scope variable.
5517 * Return NULL if there is no current funccal.
5518 */
5519 dictitem_T *
5520get_funccal_args_var()
5521{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005522 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005523 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005524 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525}
5526
5527/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005528 * List function variables, if there is a function.
5529 */
5530 void
5531list_func_vars(int *first)
5532{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005533 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005534 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005535 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005536}
5537
5538/*
5539 * If "ht" is the hashtable for local variables in the current funccal, return
5540 * the dict that contains it.
5541 * Otherwise return NULL.
5542 */
5543 dict_T *
5544get_current_funccal_dict(hashtab_T *ht)
5545{
5546 if (current_funccal != NULL
5547 && ht == &current_funccal->l_vars.dv_hashtab)
5548 return &current_funccal->l_vars;
5549 return NULL;
5550}
5551
5552/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005553 * Search hashitem in parent scope.
5554 */
5555 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005556find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005557{
5558 funccall_T *old_current_funccal = current_funccal;
5559 hashtab_T *ht;
5560 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005561 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005562
5563 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5564 return NULL;
5565
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005566 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005567 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005568 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005569 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005570 ht = find_var_ht(name, &varname);
5571 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005572 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005573 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005574 if (!HASHITEM_EMPTY(hi))
5575 {
5576 *pht = ht;
5577 break;
5578 }
5579 }
5580 if (current_funccal == current_funccal->func->uf_scoped)
5581 break;
5582 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005583 }
5584 current_funccal = old_current_funccal;
5585
5586 return hi;
5587}
5588
5589/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005590 * Search variable in parent scope.
5591 */
5592 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005593find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005594{
5595 dictitem_T *v = NULL;
5596 funccall_T *old_current_funccal = current_funccal;
5597 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005598 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005599
5600 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5601 return NULL;
5602
Bram Moolenaare38eab22019-12-05 21:50:01 +01005603 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005604 current_funccal = current_funccal->func->uf_scoped;
5605 while (current_funccal)
5606 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005607 ht = find_var_ht(name, &varname);
5608 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005609 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005610 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005611 if (v != NULL)
5612 break;
5613 }
5614 if (current_funccal == current_funccal->func->uf_scoped)
5615 break;
5616 current_funccal = current_funccal->func->uf_scoped;
5617 }
5618 current_funccal = old_current_funccal;
5619
5620 return v;
5621}
5622
5623/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005624 * Set "copyID + 1" in previous_funccal and callers.
5625 */
5626 int
5627set_ref_in_previous_funccal(int copyID)
5628{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005629 funccall_T *fc;
5630
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005631 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005632 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005633 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005634 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5635 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5636 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5637 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005638 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005639 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005640}
5641
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005642 static int
5643set_ref_in_funccal(funccall_T *fc, int copyID)
5644{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005645 if (fc->fc_copyID != copyID)
5646 {
5647 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005648 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5649 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5650 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5651 || set_ref_in_func(NULL, fc->func, copyID))
5652 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005653 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005654 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005655}
5656
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005657/*
5658 * Set "copyID" in all local vars and arguments in the call stack.
5659 */
5660 int
5661set_ref_in_call_stack(int copyID)
5662{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005663 funccall_T *fc;
5664 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005665
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005666 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5667 if (set_ref_in_funccal(fc, copyID))
5668 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005669
5670 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005671 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5672 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5673 if (set_ref_in_funccal(fc, copyID))
5674 return TRUE;
5675 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005676}
5677
5678/*
5679 * Set "copyID" in all functions available by name.
5680 */
5681 int
5682set_ref_in_functions(int copyID)
5683{
5684 int todo;
5685 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005686 ufunc_T *fp;
5687
5688 todo = (int)func_hashtab.ht_used;
5689 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005690 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005691 if (!HASHITEM_EMPTY(hi))
5692 {
5693 --todo;
5694 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005695 if (!func_name_refcount(fp->uf_name)
5696 && set_ref_in_func(NULL, fp, copyID))
5697 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005698 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005699 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005700 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005701}
5702
5703/*
5704 * Set "copyID" in all function arguments.
5705 */
5706 int
5707set_ref_in_func_args(int copyID)
5708{
5709 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005710
5711 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005712 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5713 copyID, NULL, NULL))
5714 return TRUE;
5715 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005716}
5717
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005718/*
5719 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005720 * Returns TRUE if setting references failed somehow.
5721 */
5722 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005723set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005724{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005725 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005726 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005727 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005728 char_u fname_buf[FLEN_FIXED + 1];
5729 char_u *tofree = NULL;
5730 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005731 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005732
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005733 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005734 return FALSE;
5735
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005736 if (fp_in == NULL)
5737 {
5738 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005739 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005740 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005741 if (fp != NULL)
5742 {
5743 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005744 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005745 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005746
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005747 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005748 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005749}
5750
Bram Moolenaare38eab22019-12-05 21:50:01 +01005751#endif // FEAT_EVAL