blob: 5f35f35eed0d405e06e861e8f5ba5c46d3670847 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000526 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
622function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623{
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643}
644
645/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200647 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
652get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657{
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664#define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200666 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100675 char_u *heredoc_trimmed = NULL;
676
Bram Moolenaar20677332021-06-06 17:02:53 +0200677 ga_init2(&heredoc_ga, 1, 500);
678
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
723 vim_free(*line_to_free);
724 if (eap->getline == NULL)
725 theline = getcmdline(':', 0L, indent, getline_options);
726 else
727 theline = eap->getline(':', eap->cookie, indent,
728 getline_options);
729 *line_to_free = theline;
730 }
731 if (KeyTyped)
732 lines_left = Rows - 1;
733 if (theline == NULL)
734 {
735 // Use the start of the function for the line number.
736 SOURCING_LNUM = sourcing_lnum_top;
737 if (skip_until != NULL)
738 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200739 else if (nesting_inline[nesting])
740 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100741 else if (eap->cmdidx == CMD_def)
742 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100743 else
744 emsg(_("E126: Missing :endfunction"));
745 goto theend;
746 }
747
748 // Detect line continuation: SOURCING_LNUM increased more than one.
749 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
750 if (SOURCING_LNUM < sourcing_lnum_off)
751 sourcing_lnum_off -= SOURCING_LNUM;
752 else
753 sourcing_lnum_off = 0;
754
755 if (skip_until != NULL)
756 {
757 // Don't check for ":endfunc"/":enddef" between
758 // * ":append" and "."
759 // * ":python <<EOF" and "EOF"
760 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
761 if (heredoc_trimmed == NULL
762 || (is_heredoc && skipwhite(theline) == theline)
763 || STRNCMP(theline, heredoc_trimmed,
764 STRLEN(heredoc_trimmed)) == 0)
765 {
766 if (heredoc_trimmed == NULL)
767 p = theline;
768 else if (is_heredoc)
769 p = skipwhite(theline) == theline
770 ? theline : theline + STRLEN(heredoc_trimmed);
771 else
772 p = theline + STRLEN(heredoc_trimmed);
773 if (STRCMP(p, skip_until) == 0)
774 {
775 VIM_CLEAR(skip_until);
776 VIM_CLEAR(heredoc_trimmed);
777 getline_options = vim9_function
778 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
779 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200780
781 if (heredoc_concat_len > 0)
782 {
783 // Replace the starting line with all the concatenated
784 // lines.
785 ga_concat(&heredoc_ga, theline);
786 vim_free(((char_u **)(newlines->ga_data))[
787 heredoc_concat_len - 1]);
788 ((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1] = heredoc_ga.ga_data;
790 ga_init(&heredoc_ga);
791 heredoc_concat_len = 0;
792 theline += STRLEN(theline); // skip the "EOF"
793 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 }
795 }
796 }
797 else
798 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200799 int c;
800 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100801
802 // skip ':' and blanks
803 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
804 ;
805
806 // Check for "endfunction", "enddef" or "}".
807 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200808 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100809 ? *p == '}'
810 : (checkforcmd(&p, nesting_def[nesting]
811 ? "enddef" : "endfunction", 4)
812 && *p != ':'))
813 {
814 if (nesting-- == 0)
815 {
816 char_u *nextcmd = NULL;
817
818 if (*p == '|' || *p == '}')
819 nextcmd = p + 1;
820 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
821 nextcmd = line_arg;
822 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100823 && (vim9_function || p_verbose > 0))
824 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200825 SOURCING_LNUM = sourcing_lnum_top
826 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100827 if (eap->cmdidx == CMD_def)
828 semsg(_(e_text_found_after_enddef_str), p);
829 else
830 give_warning2((char_u *)
831 _("W22: Text found after :endfunction: %s"),
832 p, TRUE);
833 }
834 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100835 {
836 // Another command follows. If the line came from "eap"
837 // we can simply point into it, otherwise we need to
838 // change "eap->cmdlinep".
839 eap->nextcmd = nextcmd;
840 if (*line_to_free != NULL)
841 {
842 vim_free(*eap->cmdlinep);
843 *eap->cmdlinep = *line_to_free;
844 *line_to_free = NULL;
845 }
846 }
847 break;
848 }
849 }
850
851 // Check for mismatched "endfunc" or "enddef".
852 // We don't check for "def" inside "func" thus we also can't check
853 // for "enddef".
854 // We continue to find the end of the function, although we might
855 // not find it.
856 else if (nesting_def[nesting])
857 {
858 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
859 emsg(_(e_mismatched_endfunction));
860 }
861 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
862 emsg(_(e_mismatched_enddef));
863
864 // Increase indent inside "if", "while", "for" and "try", decrease
865 // at "end".
866 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
867 indent -= 2;
868 else if (STRNCMP(p, "if", 2) == 0
869 || STRNCMP(p, "wh", 2) == 0
870 || STRNCMP(p, "for", 3) == 0
871 || STRNCMP(p, "try", 3) == 0)
872 indent += 2;
873
874 // Check for defining a function inside this function.
875 // Only recognize "def" inside "def", not inside "function",
876 // For backwards compatibility, see Test_function_python().
877 c = *p;
878 if (is_function_cmd(&p)
879 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
880 {
881 if (*p == '!')
882 p = skipwhite(p + 1);
883 p += eval_fname_script(p);
884 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
885 NULL, NULL));
886 if (*skipwhite(p) == '(')
887 {
888 if (nesting == MAX_FUNC_NESTING - 1)
889 emsg(_(e_function_nesting_too_deep));
890 else
891 {
892 ++nesting;
893 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200894 nesting_inline[nesting] = FALSE;
895 indent += 2;
896 }
897 }
898 }
899
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200900 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200901 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200902 // Not a comment line: check for nested inline function.
903 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200904 while (end > p && VIM_ISWHITE(*end))
905 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200906 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200907 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200908 int is_block;
909
910 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200911 --end;
912 while (end > p && VIM_ISWHITE(*end))
913 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200914 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
915 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200916 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200917 char_u *s = p;
918
919 // check for line starting with "au" for :autocmd or
920 // "com" for :command, these can use a {} block
921 is_block = checkforcmd_noparen(&s, "autocmd", 2)
922 || checkforcmd_noparen(&s, "command", 3);
923 }
924
925 if (is_block)
926 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting == MAX_FUNC_NESTING - 1)
928 emsg(_(e_function_nesting_too_deep));
929 else
930 {
931 ++nesting;
932 nesting_def[nesting] = TRUE;
933 nesting_inline[nesting] = TRUE;
934 indent += 2;
935 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100936 }
937 }
938 }
939
940 // Check for ":append", ":change", ":insert". Not for :def.
941 p = skip_range(p, FALSE, NULL);
942 if (!vim9_function
943 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
944 || (p[0] == 'c'
945 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
946 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
947 && (STRNCMP(&p[3], "nge", 3) != 0
948 || !ASCII_ISALPHA(p[6])))))))
949 || (p[0] == 'i'
950 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
951 && (!ASCII_ISALPHA(p[2])
952 || (p[2] == 's'
953 && (!ASCII_ISALPHA(p[3])
954 || p[3] == 'e'))))))))
955 skip_until = vim_strsave((char_u *)".");
956
957 // Check for ":python <<EOF", ":tcl <<EOF", etc.
958 arg = skipwhite(skiptowhite(p));
959 if (arg[0] == '<' && arg[1] =='<'
960 && ((p[0] == 'p' && p[1] == 'y'
961 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
962 || ((p[2] == '3' || p[2] == 'x')
963 && !ASCII_ISALPHA(p[3]))))
964 || (p[0] == 'p' && p[1] == 'e'
965 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
966 || (p[0] == 't' && p[1] == 'c'
967 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
968 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
969 && !ASCII_ISALPHA(p[3]))
970 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
971 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
972 || (p[0] == 'm' && p[1] == 'z'
973 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
974 ))
975 {
976 // ":python <<" continues until a dot, like ":append"
977 p = skipwhite(arg + 2);
978 if (STRNCMP(p, "trim", 4) == 0)
979 {
980 // Ignore leading white space.
981 p = skipwhite(p + 4);
982 heredoc_trimmed = vim_strnsave(theline,
983 skipwhite(theline) - theline);
984 }
985 if (*p == NUL)
986 skip_until = vim_strsave((char_u *)".");
987 else
988 skip_until = vim_strnsave(p, skiptowhite(p) - p);
989 getline_options = GETLINE_NONE;
990 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200991 if (eap->cmdidx == CMD_def)
992 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 }
994
995 // Check for ":cmd v =<< [trim] EOF"
996 // and ":cmd [a, b] =<< [trim] EOF"
997 // and "lines =<< [trim] EOF" for Vim9
998 // Where "cmd" can be "let", "var", "final" or "const".
999 arg = skipwhite(skiptowhite(p));
1000 if (*arg == '[')
1001 arg = vim_strchr(arg, ']');
1002 if (arg != NULL)
1003 {
1004 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1005 && arg[1] == '<' && arg[2] =='<');
1006
1007 if (!found)
1008 // skip over the argument after "cmd"
1009 arg = skipwhite(skiptowhite(arg));
1010 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1011 && (checkforcmd(&p, "let", 2)
1012 || checkforcmd(&p, "var", 3)
1013 || checkforcmd(&p, "final", 5)
1014 || checkforcmd(&p, "const", 5))))
1015 {
1016 p = skipwhite(arg + 3);
1017 if (STRNCMP(p, "trim", 4) == 0)
1018 {
1019 // Ignore leading white space.
1020 p = skipwhite(p + 4);
1021 heredoc_trimmed = vim_strnsave(theline,
1022 skipwhite(theline) - theline);
1023 }
1024 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1025 getline_options = GETLINE_NONE;
1026 is_heredoc = TRUE;
1027 }
1028 }
1029 }
1030
1031 // Add the line to the function.
1032 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1033 goto theend;
1034
Bram Moolenaar20677332021-06-06 17:02:53 +02001035 if (heredoc_concat_len > 0)
1036 {
1037 // For a :def function "python << EOF" concatenats all the lines,
1038 // to be used for the instruction later.
1039 ga_concat(&heredoc_ga, theline);
1040 ga_concat(&heredoc_ga, (char_u *)"\n");
1041 p = vim_strsave((char_u *)"");
1042 }
1043 else
1044 {
1045 // Copy the line to newly allocated memory. get_one_sourceline()
1046 // allocates 250 bytes per line, this saves 80% on average. The
1047 // cost is an extra alloc/free.
1048 p = vim_strsave(theline);
1049 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001050 if (p == NULL)
1051 goto theend;
1052 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1053
1054 // Add NULL lines for continuation lines, so that the line count is
1055 // equal to the index in the growarray.
1056 while (sourcing_lnum_off-- > 0)
1057 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1058
1059 // Check for end of eap->arg.
1060 if (line_arg != NULL && *line_arg == NUL)
1061 line_arg = NULL;
1062 }
1063
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001064 // Return OK when no error was detected.
1065 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001066 ret = OK;
1067
1068theend:
1069 vim_free(skip_until);
1070 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001071 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001072 need_wait_return |= saved_wait_return;
1073 return ret;
1074}
1075
1076/*
1077 * Handle the body of a lambda. *arg points to the "{", process statements
1078 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001079 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 * When successful "rettv" is set to a funcref.
1081 */
1082 static int
1083lambda_function_body(
1084 char_u **arg,
1085 typval_T *rettv,
1086 evalarg_T *evalarg,
1087 garray_T *newargs,
1088 garray_T *argtypes,
1089 int varargs,
1090 garray_T *default_args,
1091 char_u *ret_type)
1092{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001093 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001094 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001095 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001096 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001097 exarg_T eap;
1098 garray_T newlines;
1099 char_u *cmdline = NULL;
1100 int ret = FAIL;
1101 char_u *line_to_free = NULL;
1102 partial_T *pt;
1103 char_u *name;
1104 int lnum_save = -1;
1105 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1106
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001107 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1108 {
1109 semsg(_(e_trailing_arg), *arg + 1);
1110 return FAIL;
1111 }
1112
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001113 CLEAR_FIELD(eap);
1114 eap.cmdidx = CMD_block;
1115 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001116 eap.cmdlinep = &cmdline;
1117 eap.skip = !evaluate;
1118 if (evalarg->eval_cctx != NULL)
1119 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1120 else
1121 {
1122 eap.getline = evalarg->eval_getline;
1123 eap.cookie = evalarg->eval_cookie;
1124 }
1125
1126 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1127 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001128 {
1129 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001130 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001131 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001132
1133 // When inside a lambda must add the function lines to evalarg.eval_ga.
1134 evalarg->eval_break_count += newlines.ga_len;
1135 if (gap->ga_itemsize > 0)
1136 {
1137 int idx;
1138 char_u *last;
1139 size_t plen;
1140 char_u *pnl;
1141
1142 for (idx = 0; idx < newlines.ga_len; ++idx)
1143 {
1144 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1145
Bram Moolenaarecb66452021-05-18 15:09:18 +02001146 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001147 goto erret;
1148
1149 // Going to concatenate the lines after parsing. For an empty or
1150 // comment line use an empty string.
1151 // Insert NL characters at the start of each line, the string will
1152 // be split again later in .get_lambda_tv().
1153 if (*p == NUL || vim9_comment_start(p))
1154 p = (char_u *)"";
1155 plen = STRLEN(p);
1156 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1157 if (pnl != NULL)
1158 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001159 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1160 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001161 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001162 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001163 goto erret;
1164 if (cmdline != NULL)
1165 // more is following after the "}", which was skipped
1166 last = cmdline;
1167 else
1168 // nothing is following the "}"
1169 last = (char_u *)"}";
1170 plen = STRLEN(last);
1171 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1172 if (pnl != NULL)
1173 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001174 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1175 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001176 }
1177
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 if (cmdline != NULL)
1179 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001180 garray_T *tfgap = &evalarg->eval_tofree_ga;
1181
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001182 // Something comes after the "}".
1183 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001184
1185 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001186 if (ga_grow(tfgap, 1) == OK)
1187 {
1188 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1189 evalarg->eval_using_cmdline = TRUE;
1190 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001191 }
1192 else
1193 *arg = (char_u *)"";
1194
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001195 if (!evaluate)
1196 {
1197 ret = OK;
1198 goto erret;
1199 }
1200
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001201 name = get_lambda_name();
1202 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1203 if (ufunc == NULL)
1204 goto erret;
1205 set_ufunc_name(ufunc, name);
1206 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001207 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001208 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 ufunc->uf_refcount = 1;
1210 ufunc->uf_args = *newargs;
1211 newargs->ga_data = NULL;
1212 ufunc->uf_def_args = *default_args;
1213 default_args->ga_data = NULL;
1214 ufunc->uf_func_type = &t_func_any;
1215
1216 // error messages are for the first function line
1217 lnum_save = SOURCING_LNUM;
1218 SOURCING_LNUM = sourcing_lnum_top;
1219
1220 // parse argument types
1221 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1222 {
1223 SOURCING_LNUM = lnum_save;
1224 goto erret;
1225 }
1226
1227 // parse the return type, if any
1228 if (parse_return_type(ufunc, ret_type) == FAIL)
1229 goto erret;
1230
1231 pt = ALLOC_CLEAR_ONE(partial_T);
1232 if (pt == NULL)
1233 goto erret;
1234 pt->pt_func = ufunc;
1235 pt->pt_refcount = 1;
1236
1237 ufunc->uf_lines = newlines;
1238 newlines.ga_data = NULL;
1239 if (sandbox)
1240 ufunc->uf_flags |= FC_SANDBOX;
1241 if (!ASCII_ISUPPER(*ufunc->uf_name))
1242 ufunc->uf_flags |= FC_VIM9;
1243 ufunc->uf_script_ctx = current_sctx;
1244 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1245 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1246 set_function_type(ufunc);
1247
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001248 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1249
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001250 rettv->vval.v_partial = pt;
1251 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001252 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001253 ret = OK;
1254
1255erret:
1256 if (lnum_save >= 0)
1257 SOURCING_LNUM = lnum_save;
1258 vim_free(line_to_free);
1259 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001260 if (newargs != NULL)
1261 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001263 if (ufunc != NULL)
1264 {
1265 func_clear(ufunc, TRUE);
1266 func_free(ufunc, TRUE);
1267 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001268 return ret;
1269}
1270
1271/*
1272 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001273 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001274 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001275 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1276 */
1277 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001278get_lambda_tv(
1279 char_u **arg,
1280 typval_T *rettv,
1281 int types_optional,
1282 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001284 int evaluate = evalarg != NULL
1285 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286 garray_T newargs;
1287 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001288 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001289 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001290 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001292 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001294 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001296 char_u *s;
1297 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001298 int *old_eval_lavars = eval_lavars_used;
1299 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001300 char_u *tofree1 = NULL;
1301 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001302 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001303 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001304 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001305
1306 if (equal_arrow && !in_vim9script())
1307 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001308
1309 ga_init(&newargs);
1310 ga_init(&newlines);
1311
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001312 // First, check if this is really a lambda expression. "->" or "=>" must
1313 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001314 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001315 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001316 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001317 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001318 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001319 {
1320 if (types_optional)
1321 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001322 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001323 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001325 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001326 if (evaluate)
1327 pnewargs = &newargs;
1328 else
1329 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001330 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001331 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001332 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001333 &varargs, &default_args,
1334 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001336 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001337 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001338 {
1339 if (types_optional)
1340 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001341 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001342 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001343 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001344 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001345
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001346 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1347 if (ret_type != NULL)
1348 {
1349 ret_type = vim_strsave(ret_type);
1350 tofree2 = ret_type;
1351 }
1352
Bram Moolenaare38eab22019-12-05 21:50:01 +01001353 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001354 if (evaluate)
1355 eval_lavars_used = &eval_lavars;
1356
Bram Moolenaar65c44152020-12-24 15:14:01 +01001357 *arg = skipwhite_and_linebreak(*arg, evalarg);
1358
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001359 // Recognize "{" as the start of a function body.
1360 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001361 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001362 if (evalarg == NULL)
1363 // cannot happen?
1364 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001365 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1366 types_optional ? &argtypes : NULL, varargs,
1367 &default_args, ret_type) == FAIL)
1368 goto errret;
1369 goto theend;
1370 }
1371 if (default_args.ga_len > 0)
1372 {
1373 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001374 goto errret;
1375 }
1376
Bram Moolenaare38eab22019-12-05 21:50:01 +01001377 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001378 start = *arg;
1379 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380 if (ret == FAIL)
1381 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001382 if (evalarg != NULL)
1383 {
1384 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001385 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001386 evalarg->eval_tofree = NULL;
1387 }
1388
Bram Moolenaar65c44152020-12-24 15:14:01 +01001389 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001390 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001391 *arg = skipwhite_and_linebreak(*arg, evalarg);
1392 if (**arg != '}')
1393 {
1394 semsg(_("E451: Expected }: %s"), *arg);
1395 goto errret;
1396 }
1397 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399
1400 if (evaluate)
1401 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001402 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001403 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001404 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001405 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001406 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001407
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001408 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409 if (fp == NULL)
1410 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001411 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001412 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001413 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001414 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1417 if (ga_grow(&newlines, 1) == FAIL)
1418 goto errret;
1419
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001420 // If there are line breaks, we need to split up the string.
1421 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001422 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001423 line_end = end;
1424
1425 // Add "return " before the expression (or the first line).
1426 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001427 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001428 if (p == NULL)
1429 goto errret;
1430 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1431 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001432 vim_strncpy(p + 7, start, line_end - start);
1433
1434 if (line_end != end)
1435 {
1436 // Add more lines, split by line breaks. Thus is used when a
1437 // lambda with { cmds } is encountered.
1438 while (*line_end == '\n')
1439 {
1440 if (ga_grow(&newlines, 1) == FAIL)
1441 goto errret;
1442 start = line_end + 1;
1443 line_end = vim_strchr(start, '\n');
1444 if (line_end == NULL)
1445 line_end = end;
1446 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1447 vim_strnsave(start, line_end - start);
1448 }
1449 }
1450
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001451 if (strstr((char *)p + 7, "a:") == NULL)
1452 // No a: variables are used for sure.
1453 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454
1455 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001456 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001458 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001459 if (types_optional)
1460 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001461 if (parse_argument_types(fp, &argtypes,
1462 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001463 goto errret;
1464 if (ret_type != NULL)
1465 {
1466 fp->uf_ret_type = parse_type(&ret_type,
1467 &fp->uf_type_list, TRUE);
1468 if (fp->uf_ret_type == NULL)
1469 goto errret;
1470 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001471 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001472 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001473 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001474
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001476 if (current_funccal != NULL && eval_lavars)
1477 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001478 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001479 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001480 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001481 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482
1483#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484 if (prof_def_func())
1485 func_do_profile(fp);
1486#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001487 if (sandbox)
1488 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001489 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001490 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1491 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001492 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001493 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001494 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001495 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001497 function_using_block_scopes(fp, evalarg->eval_cstack);
1498
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001499 pt->pt_func = fp;
1500 pt->pt_refcount = 1;
1501 rettv->vval.v_partial = pt;
1502 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001503
1504 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001507theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001508 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001509 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001510 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001511 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001512 vim_free(tofree1);
1513 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001514 if (types_optional)
1515 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001516
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 return OK;
1518
1519errret:
1520 ga_clear_strings(&newargs);
1521 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001522 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001523 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001524 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001525 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001526 if (fp != NULL)
1527 vim_free(fp->uf_arg_types);
1528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001530 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001531 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001532 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001533 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001534 vim_free(tofree1);
1535 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001536 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 return FAIL;
1538}
1539
1540/*
1541 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1542 * name it contains, otherwise return "name".
1543 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1544 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001545 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1546 * type of the variable.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001547 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 */
1549 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001550deref_func_name(
1551 char_u *name,
1552 int *lenp,
1553 partial_T **partialp,
1554 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001555 int no_autoload,
1556 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001557{
1558 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001559 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001561 char_u *s = NULL;
1562 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001563 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564
1565 if (partialp != NULL)
1566 *partialp = NULL;
1567
1568 cc = name[*lenp];
1569 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001570
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001571 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001573 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001575 tv = &v->di_tv;
1576 }
1577 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1578 {
1579 imported_T *import;
1580 char_u *p = name;
1581 int len = *lenp;
1582
1583 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001585 p = name + 2;
1586 len -= 2;
1587 }
1588 import = find_imported(p, len, NULL);
1589
1590 // imported variable from another script
1591 if (import != NULL)
1592 {
1593 if (import->imp_funcname != NULL)
1594 {
1595 s = import->imp_funcname;
1596 *lenp = (int)STRLEN(s);
1597 return s;
1598 }
1599 // TODO: what if (import->imp_flags & IMP_FLAGS_STAR)
1600 {
1601 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1602 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1603 + import->imp_var_vals_idx;
1604 tv = sv->sv_tv;
1605 if (type != NULL)
1606 *type = sv->sv_type;
1607 did_type = TRUE;
1608 }
1609 }
1610 }
1611
1612 if (tv != NULL)
1613 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001614 if (found_var != NULL)
1615 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001616 if (tv->v_type == VAR_FUNC)
1617 {
1618 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001619 {
1620 *lenp = 0;
1621 return (char_u *)""; // just in case
1622 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001623 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001624 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001627 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001629 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001630
1631 if (pt == NULL)
1632 {
1633 *lenp = 0;
1634 return (char_u *)""; // just in case
1635 }
1636 if (partialp != NULL)
1637 *partialp = pt;
1638 s = partial_name(pt);
1639 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001641
1642 if (s != NULL)
1643 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001644 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001645 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001646 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001647
1648 if (sv != NULL)
1649 *type = sv->sv_type;
1650 }
1651 return s;
1652 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653 }
1654
1655 return name;
1656}
1657
1658/*
1659 * Give an error message with a function name. Handle <SNR> things.
1660 * "ermsg" is to be passed without translation, use N_() instead of _().
1661 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001662 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001663emsg_funcname(char *ermsg, char_u *name)
1664{
1665 char_u *p;
1666
1667 if (*name == K_SPECIAL)
1668 p = concat_str((char_u *)"<SNR>", name + 3);
1669 else
1670 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001671 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672 if (p != name)
1673 vim_free(p);
1674}
1675
1676/*
1677 * Allocate a variable for the result of a function.
1678 * Return OK or FAIL.
1679 */
1680 int
1681get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001682 char_u *name, // name of the function
1683 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001685 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001686 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001687 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688{
1689 char_u *argp;
1690 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001691 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1692 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001693 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694
1695 /*
1696 * Get the arguments.
1697 */
1698 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001699 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1700 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001702 // skip the '(' or ',' and possibly line breaks
1703 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1704
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 if (*argp == ')' || *argp == ',' || *argp == NUL)
1706 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001707 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 {
1709 ret = FAIL;
1710 break;
1711 }
1712 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001713 // The comma should come right after the argument, but this wasn't
1714 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001715 if (vim9script)
1716 {
1717 if (*argp != ',' && *skipwhite(argp) == ',')
1718 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001719 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001720 ret = FAIL;
1721 break;
1722 }
1723 }
1724 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001725 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 if (*argp != ',')
1727 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001728 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1729 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001730 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001731 ret = FAIL;
1732 break;
1733 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001735 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736 if (*argp == ')')
1737 ++argp;
1738 else
1739 ret = FAIL;
1740
1741 if (ret == OK)
1742 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001743 int i = 0;
1744 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745
1746 if (get_vim_var_nr(VV_TESTING))
1747 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001748 // Prepare for calling test_garbagecollect_now(), need to know
1749 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 if (funcargs.ga_itemsize == 0)
1751 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1752 for (i = 0; i < argcount; ++i)
1753 if (ga_grow(&funcargs, 1) == OK)
1754 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1755 &argvars[i];
1756 }
1757
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001758 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001759 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001760 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001761 // An error in a builtin function does not return FAIL, but we do
1762 // want to abort further processing if an error was given.
1763 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001764 clear_tv(rettv);
1765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001766
1767 funcargs.ga_len -= i;
1768 }
1769 else if (!aborting())
1770 {
1771 if (argcount == MAX_FUNC_ARGS)
1772 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1773 else
1774 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1775 }
1776
1777 while (--argcount >= 0)
1778 clear_tv(&argvars[argcount]);
1779
Bram Moolenaar8294d492020-08-10 22:40:56 +02001780 if (in_vim9script())
1781 *arg = argp;
1782 else
1783 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784 return ret;
1785}
1786
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787/*
1788 * Return TRUE if "p" starts with "<SID>" or "s:".
1789 * Only works if eval_fname_script() returned non-zero for "p"!
1790 */
1791 static int
1792eval_fname_sid(char_u *p)
1793{
1794 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1795}
1796
1797/*
1798 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1799 * Change <SNR>123_name() to K_SNR 123_name().
1800 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1801 * (slow).
1802 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001803 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1805{
1806 int llen;
1807 char_u *fname;
1808 int i;
1809
1810 llen = eval_fname_script(name);
1811 if (llen > 0)
1812 {
1813 fname_buf[0] = K_SPECIAL;
1814 fname_buf[1] = KS_EXTRA;
1815 fname_buf[2] = (int)KE_SNR;
1816 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001817 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001819 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001820 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821 else
1822 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001823 sprintf((char *)fname_buf + 3, "%ld_",
1824 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825 i = (int)STRLEN(fname_buf);
1826 }
1827 }
1828 if (i + STRLEN(name + llen) < FLEN_FIXED)
1829 {
1830 STRCPY(fname_buf + i, name + llen);
1831 fname = fname_buf;
1832 }
1833 else
1834 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001835 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001837 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 else
1839 {
1840 *tofree = fname;
1841 mch_memmove(fname, fname_buf, (size_t)i);
1842 STRCPY(fname + i, name + llen);
1843 }
1844 }
1845 }
1846 else
1847 fname = name;
1848 return fname;
1849}
1850
1851/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001852 * Find a function "name" in script "sid".
1853 */
1854 static ufunc_T *
1855find_func_with_sid(char_u *name, int sid)
1856{
1857 hashitem_T *hi;
1858 char_u buffer[200];
1859
1860 buffer[0] = K_SPECIAL;
1861 buffer[1] = KS_EXTRA;
1862 buffer[2] = (int)KE_SNR;
1863 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1864 (long)sid, name);
1865 hi = hash_find(&func_hashtab, buffer);
1866 if (!HASHITEM_EMPTY(hi))
1867 return HI2UF(hi);
1868
1869 return NULL;
1870}
1871
1872/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001874 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875 * Return NULL for unknown function.
1876 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001877 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001878find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001879{
1880 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 ufunc_T *func;
1882 imported_T *imported;
1883
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001884 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001885 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001886 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001887 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001888 int find_script_local = in_vim9script()
1889 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001890
Bram Moolenaar95006e32020-08-29 17:47:08 +02001891 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001892 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001893 // Find script-local function before global one.
1894 func = find_func_with_sid(name, current_sctx.sc_sid);
1895 if (func != NULL)
1896 return func;
1897 }
1898
Bram Moolenaarefa94442020-08-08 22:16:00 +02001899 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001900 && name[1] == KS_EXTRA
1901 && name[2] == KE_SNR)
1902 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001903 // Caller changes s: to <SNR>99_name.
1904
1905 after_script = name + 3;
1906 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001907 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001908 ++after_script;
1909 else
1910 after_script = NULL;
1911 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001912 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001913 {
1914 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001915 if (after_script != NULL && sid != current_sctx.sc_sid)
1916 imported = find_imported_in_script(after_script, 0, sid);
1917 else
1918 imported = find_imported(after_script == NULL
1919 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001920 if (imported != NULL && imported->imp_funcname != NULL)
1921 {
1922 hi = hash_find(&func_hashtab, imported->imp_funcname);
1923 if (!HASHITEM_EMPTY(hi))
1924 return HI2UF(hi);
1925 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001926 }
1927 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001928
Bram Moolenaara26b9702020-04-18 19:53:28 +02001929 hi = hash_find(&func_hashtab,
1930 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001931 if (!HASHITEM_EMPTY(hi))
1932 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001933
1934 return NULL;
1935}
1936
1937/*
1938 * Find a function by name, return pointer to it in ufuncs.
1939 * "cctx" is passed in a :def function to find imported functions.
1940 * Return NULL for unknown or dead function.
1941 */
1942 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001943find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001944{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001945 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001946
1947 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1948 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001949 return NULL;
1950}
1951
1952/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001953 * Return TRUE if "ufunc" is a global function.
1954 */
1955 int
1956func_is_global(ufunc_T *ufunc)
1957{
1958 return ufunc->uf_name[0] != K_SPECIAL;
1959}
1960
1961/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001962 * Copy the function name of "fp" to buffer "buf".
1963 * "buf" must be able to hold the function name plus three bytes.
1964 * Takes care of script-local function names.
1965 */
1966 static void
1967cat_func_name(char_u *buf, ufunc_T *fp)
1968{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001969 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001970 {
1971 STRCPY(buf, "<SNR>");
1972 STRCAT(buf, fp->uf_name + 3);
1973 }
1974 else
1975 STRCPY(buf, fp->uf_name);
1976}
1977
1978/*
1979 * Add a number variable "name" to dict "dp" with value "nr".
1980 */
1981 static void
1982add_nr_var(
1983 dict_T *dp,
1984 dictitem_T *v,
1985 char *name,
1986 varnumber_T nr)
1987{
1988 STRCPY(v->di_key, name);
1989 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1990 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1991 v->di_tv.v_type = VAR_NUMBER;
1992 v->di_tv.v_lock = VAR_FIXED;
1993 v->di_tv.vval.v_number = nr;
1994}
1995
1996/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001997 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001998 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001999 static void
2000free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002001{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002002 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002003
2004 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2005 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002006 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002007
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002008 // When garbage collecting a funccall_T may be freed before the
2009 // function that references it, clear its uf_scoped field.
2010 // The function may have been redefined and point to another
2011 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002012 if (fp != NULL && fp->uf_scoped == fc)
2013 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002014 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002015 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002017 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 vim_free(fc);
2019}
2020
2021/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002022 * Free "fc" and what it contains.
2023 * Can be called only when "fc" is kept beyond the period of it called,
2024 * i.e. after cleanup_function_call(fc).
2025 */
2026 static void
2027free_funccal_contents(funccall_T *fc)
2028{
2029 listitem_T *li;
2030
2031 // Free all l: variables.
2032 vars_clear(&fc->l_vars.dv_hashtab);
2033
2034 // Free all a: variables.
2035 vars_clear(&fc->l_avars.dv_hashtab);
2036
2037 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002038 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002039 clear_tv(&li->li_tv);
2040
2041 free_funccal(fc);
2042}
2043
2044/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002045 * Handle the last part of returning from a function: free the local hashtable.
2046 * Unless it is still in use by a closure.
2047 */
2048 static void
2049cleanup_function_call(funccall_T *fc)
2050{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002051 int may_free_fc = fc->fc_refcount <= 0;
2052 int free_fc = TRUE;
2053
Bram Moolenaar6914c642017-04-01 21:21:30 +02002054 current_funccal = fc->caller;
2055
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002056 // Free all l: variables if not referred.
2057 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2058 vars_clear(&fc->l_vars.dv_hashtab);
2059 else
2060 free_fc = FALSE;
2061
2062 // If the a:000 list and the l: and a: dicts are not referenced and
2063 // there is no closure using it, we can free the funccall_T and what's
2064 // in it.
2065 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2066 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002067 else
2068 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002069 int todo;
2070 hashitem_T *hi;
2071 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002072
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002073 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002074
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002075 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002076 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2077 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2078 {
2079 if (!HASHITEM_EMPTY(hi))
2080 {
2081 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002082 di = HI2DI(hi);
2083 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002084 }
2085 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002086 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002087
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002088 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2089 fc->l_varlist.lv_first = NULL;
2090 else
2091 {
2092 listitem_T *li;
2093
2094 free_fc = FALSE;
2095
2096 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002097 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002098 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002099 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002100
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002101 if (free_fc)
2102 free_funccal(fc);
2103 else
2104 {
2105 static int made_copy = 0;
2106
2107 // "fc" is still in use. This can happen when returning "a:000",
2108 // assigning "l:" to a global variable or defining a closure.
2109 // Link "fc" in the list for garbage collection later.
2110 fc->caller = previous_funccal;
2111 previous_funccal = fc;
2112
2113 if (want_garbage_collect)
2114 // If garbage collector is ready, clear count.
2115 made_copy = 0;
2116 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002117 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002118 // We have made a lot of copies, worth 4 Mbyte. This can happen
2119 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002120 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002121 // too much memory.
2122 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002123 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002124 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002125 }
2126}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002127
2128/*
2129 * There are two kinds of function names:
2130 * 1. ordinary names, function defined with :function or :def
2131 * 2. numbered functions and lambdas
2132 * For the first we only count the name stored in func_hashtab as a reference,
2133 * using function() does not count as a reference, because the function is
2134 * looked up by name.
2135 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002136 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002137func_name_refcount(char_u *name)
2138{
2139 return isdigit(*name) || *name == '<';
2140}
2141
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002142/*
2143 * Unreference "fc": decrement the reference count and free it when it
2144 * becomes zero. "fp" is detached from "fc".
2145 * When "force" is TRUE we are exiting.
2146 */
2147 static void
2148funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2149{
2150 funccall_T **pfc;
2151 int i;
2152
2153 if (fc == NULL)
2154 return;
2155
2156 if (--fc->fc_refcount <= 0 && (force || (
2157 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2158 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2159 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2160 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2161 {
2162 if (fc == *pfc)
2163 {
2164 *pfc = fc->caller;
2165 free_funccal_contents(fc);
2166 return;
2167 }
2168 }
2169 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2170 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2171 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2172}
2173
2174/*
2175 * Remove the function from the function hashtable. If the function was
2176 * deleted while it still has references this was already done.
2177 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2178 */
2179 static int
2180func_remove(ufunc_T *fp)
2181{
2182 hashitem_T *hi;
2183
2184 // Return if it was already virtually deleted.
2185 if (fp->uf_flags & FC_DEAD)
2186 return FALSE;
2187
2188 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2189 if (!HASHITEM_EMPTY(hi))
2190 {
2191 // When there is a def-function index do not actually remove the
2192 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002193 // Do remove it when it's a copy.
2194 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002195 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002196 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002197 return FALSE;
2198 }
2199 hash_remove(&func_hashtab, hi);
2200 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002201 return TRUE;
2202 }
2203 return FALSE;
2204}
2205
2206 static void
2207func_clear_items(ufunc_T *fp)
2208{
2209 ga_clear_strings(&(fp->uf_args));
2210 ga_clear_strings(&(fp->uf_def_args));
2211 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002212 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002213 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002214 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002215 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002216
2217 // Increment the refcount of this function to avoid it being freed
2218 // recursively when the partial is freed.
2219 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002220 partial_unref(fp->uf_partial);
2221 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002222 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002223
2224#ifdef FEAT_LUA
2225 if (fp->uf_cb_free != NULL)
2226 {
2227 fp->uf_cb_free(fp->uf_cb_state);
2228 fp->uf_cb_free = NULL;
2229 }
2230
2231 fp->uf_cb_state = NULL;
2232 fp->uf_cb = NULL;
2233#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002234#ifdef FEAT_PROFILE
2235 VIM_CLEAR(fp->uf_tml_count);
2236 VIM_CLEAR(fp->uf_tml_total);
2237 VIM_CLEAR(fp->uf_tml_self);
2238#endif
2239}
2240
2241/*
2242 * Free all things that a function contains. Does not free the function
2243 * itself, use func_free() for that.
2244 * When "force" is TRUE we are exiting.
2245 */
2246 static void
2247func_clear(ufunc_T *fp, int force)
2248{
2249 if (fp->uf_cleared)
2250 return;
2251 fp->uf_cleared = TRUE;
2252
2253 // clear this function
2254 func_clear_items(fp);
2255 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002256 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002257}
2258
2259/*
2260 * Free a function and remove it from the list of functions. Does not free
2261 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002262 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002263 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002264 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002265 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002266func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002267{
2268 // Only remove it when not done already, otherwise we would remove a newer
2269 // version of the function with the same name.
2270 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2271 func_remove(fp);
2272
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002273 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002274 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002275 if (fp->uf_dfunc_idx > 0)
2276 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002277 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002278 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002279 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002280 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002281 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002282}
2283
2284/*
2285 * Free all things that a function contains and free the function itself.
2286 * When "force" is TRUE we are exiting.
2287 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002288 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002289func_clear_free(ufunc_T *fp, int force)
2290{
2291 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002292 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2293 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002294 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002295 else
2296 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002297}
2298
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002299/*
2300 * Copy already defined function "lambda" to a new function with name "global".
2301 * This is for when a compiled function defines a global function.
2302 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002303 int
2304copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002305{
2306 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002307 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002308
2309 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002310 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002311 semsg(_(e_lambda_function_not_found_str), lambda);
2312 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002313 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002314
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002315 fp = find_func(global, TRUE, NULL);
2316 if (fp != NULL)
2317 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002318 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002319 semsg(_(e_funcexts), global);
2320 return FAIL;
2321 }
2322
2323 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2324 if (fp == NULL)
2325 return FAIL;
2326
2327 fp->uf_varargs = ufunc->uf_varargs;
2328 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2329 fp->uf_def_status = ufunc->uf_def_status;
2330 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2331 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2332 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2333 == FAIL
2334 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2335 goto failed;
2336
2337 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2338 : vim_strsave(ufunc->uf_name_exp);
2339 if (ufunc->uf_arg_types != NULL)
2340 {
2341 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2342 if (fp->uf_arg_types == NULL)
2343 goto failed;
2344 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2345 sizeof(type_T *) * fp->uf_args.ga_len);
2346 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002347 if (ufunc->uf_va_name != NULL)
2348 {
2349 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2350 if (fp->uf_va_name == NULL)
2351 goto failed;
2352 }
2353 fp->uf_ret_type = ufunc->uf_ret_type;
2354
2355 fp->uf_refcount = 1;
2356 STRCPY(fp->uf_name, global);
2357 hash_add(&func_hashtab, UF2HIKEY(fp));
2358
2359 // the referenced dfunc_T is now used one more time
2360 link_def_function(fp);
2361
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002362 // Create a partial to store the context of the function where it was
2363 // instantiated. Only needs to be done once. Do this on the original
2364 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002365 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2366 {
2367 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2368
2369 if (pt == NULL)
2370 goto failed;
2371 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002372 {
2373 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002374 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002375 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002376 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002377 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002378 }
2379
2380 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002381
2382failed:
2383 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002384 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002385}
2386
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002387static int funcdepth = 0;
2388
2389/*
2390 * Increment the function call depth count.
2391 * Return FAIL when going over 'maxfuncdepth'.
2392 * Otherwise return OK, must call funcdepth_decrement() later!
2393 */
2394 int
2395funcdepth_increment(void)
2396{
2397 if (funcdepth >= p_mfd)
2398 {
2399 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2400 return FAIL;
2401 }
2402 ++funcdepth;
2403 return OK;
2404}
2405
2406 void
2407funcdepth_decrement(void)
2408{
2409 --funcdepth;
2410}
2411
2412/*
2413 * Get the current function call depth.
2414 */
2415 int
2416funcdepth_get(void)
2417{
2418 return funcdepth;
2419}
2420
2421/*
2422 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002423 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002424 * times as funcdepth_increment().
2425 */
2426 void
2427funcdepth_restore(int depth)
2428{
2429 funcdepth = depth;
2430}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002431
2432/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 * Call a user function.
2434 */
2435 static void
2436call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002437 ufunc_T *fp, // pointer to function
2438 int argcount, // nr of args
2439 typval_T *argvars, // arguments
2440 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002441 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002442 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002444 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002445 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 funccall_T *fc;
2447 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002448 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002450 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451 int i;
2452 int ai;
2453 int islambda = FALSE;
2454 char_u numbuf[NUMBUFLEN];
2455 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002456 typval_T *tv_to_free[MAX_FUNC_ARGS];
2457 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002459 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002461 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002462
Bram Moolenaarb2049902021-01-24 12:53:53 +01002463#ifdef FEAT_PROFILE
2464 CLEAR_FIELD(profile_info);
2465#endif
2466
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002467 // If depth of calling is getting too high, don't execute the function.
2468 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 rettv->v_type = VAR_NUMBER;
2471 rettv->vval.v_number = -1;
2472 return;
2473 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474
Bram Moolenaare38eab22019-12-05 21:50:01 +01002475 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002477 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002478 if (fc == NULL)
2479 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 fc->caller = current_funccal;
2481 current_funccal = fc;
2482 fc->func = fp;
2483 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002485 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2487 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002488 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002489 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002490 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002492 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002493 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002494#ifdef FEAT_PROFILE
2495 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2496#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002497 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002498#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002499 if (do_profiling == PROF_YES)
2500 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002501#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002502 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002503 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002504#ifdef FEAT_PROFILE
2505 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002506 || (caller != NULL && caller->uf_profiling)))
2507 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002508#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002509 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 free_funccal(fc);
2511 return;
2512 }
2513
Bram Moolenaar38453522021-11-28 22:00:12 +00002514 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515
2516 /*
2517 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2518 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2519 * each argument variable and saves a lot of time.
2520 */
2521 /*
2522 * Init l: variables.
2523 */
2524 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2525 if (selfdict != NULL)
2526 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002527 // Set l:self to "selfdict". Use "name" to avoid a warning from
2528 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 v = &fc->fixvar[fixvar_idx++].var;
2530 name = v->di_key;
2531 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002532 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2534 v->di_tv.v_type = VAR_DICT;
2535 v->di_tv.v_lock = 0;
2536 v->di_tv.vval.v_dict = selfdict;
2537 ++selfdict->dv_refcount;
2538 }
2539
2540 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002541 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002542 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 * Set a:000 to a list with room for the "..." arguments.
2544 */
2545 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002546 if ((fp->uf_flags & FC_NOARGS) == 0)
2547 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002548 (varnumber_T)(argcount >= fp->uf_args.ga_len
2549 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002550 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002551 if ((fp->uf_flags & FC_NOARGS) == 0)
2552 {
2553 // Use "name" to avoid a warning from some compiler that checks the
2554 // destination size.
2555 v = &fc->fixvar[fixvar_idx++].var;
2556 name = v->di_key;
2557 STRCPY(name, "000");
2558 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2559 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2560 v->di_tv.v_type = VAR_LIST;
2561 v->di_tv.v_lock = VAR_FIXED;
2562 v->di_tv.vval.v_list = &fc->l_varlist;
2563 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002564 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002565 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2566 fc->l_varlist.lv_lock = VAR_FIXED;
2567
2568 /*
2569 * Set a:firstline to "firstline" and a:lastline to "lastline".
2570 * Set a:name to named arguments.
2571 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002572 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002574 if ((fp->uf_flags & FC_NOARGS) == 0)
2575 {
2576 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002577 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002578 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002579 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002580 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002581 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582 {
2583 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002584 typval_T def_rettv;
2585 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586
2587 ai = i - fp->uf_args.ga_len;
2588 if (ai < 0)
2589 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002590 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002591 name = FUNCARG(fp, i);
2592 if (islambda)
2593 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002594
2595 // evaluate named argument default expression
2596 isdefault = ai + fp->uf_def_args.ga_len >= 0
2597 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2598 && argvars[i].vval.v_number == VVAL_NONE));
2599 if (isdefault)
2600 {
2601 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002602
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002603 def_rettv.v_type = VAR_NUMBER;
2604 def_rettv.vval.v_number = -1;
2605
2606 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2607 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002608 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002609 {
2610 default_arg_err = 1;
2611 break;
2612 }
2613 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002614 }
2615 else
2616 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002617 if ((fp->uf_flags & FC_NOARGS) != 0)
2618 // Bail out if no a: arguments used (in lambda).
2619 break;
2620
Bram Moolenaare38eab22019-12-05 21:50:01 +01002621 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 sprintf((char *)numbuf, "%d", ai + 1);
2623 name = numbuf;
2624 }
2625 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2626 {
2627 v = &fc->fixvar[fixvar_idx++].var;
2628 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002629 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 }
2631 else
2632 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002633 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 if (v == NULL)
2635 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002636 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002639 // Note: the values are copied directly to avoid alloc/free.
2640 // "argvars" must have VAR_FIXED for v_lock.
2641 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 v->di_tv.v_lock = VAR_FIXED;
2643
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002644 if (isdefault)
2645 // Need to free this later, no matter where it's stored.
2646 tv_to_free[tv_to_free_len++] = &v->di_tv;
2647
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648 if (addlocal)
2649 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002650 // Named arguments should be accessed without the "a:" prefix in
2651 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002652 copy_tv(&v->di_tv, &v->di_tv);
2653 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002654 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002655 else
2656 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657
2658 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2659 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002660 listitem_T *li = &fc->l_listitems[ai];
2661
2662 li->li_tv = argvars[i];
2663 li->li_tv.v_lock = VAR_FIXED;
2664 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 }
2666 }
2667
Bram Moolenaare38eab22019-12-05 21:50:01 +01002668 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002670
2671 if (fp->uf_flags & FC_SANDBOX)
2672 {
2673 using_sandbox = TRUE;
2674 ++sandbox;
2675 }
2676
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002677 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002678 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002679 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002681 ++no_wait_return;
2682 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002684 smsg(_("calling %s"), SOURCING_NAME);
2685 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002687 char_u buf[MSG_BUF_LEN];
2688 char_u numbuf2[NUMBUFLEN];
2689 char_u *tofree;
2690 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002692 msg_puts("(");
2693 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002695 if (i > 0)
2696 msg_puts(", ");
2697 if (argvars[i].v_type == VAR_NUMBER)
2698 msg_outnum((long)argvars[i].vval.v_number);
2699 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002701 // Do not want errors such as E724 here.
2702 ++emsg_off;
2703 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2704 --emsg_off;
2705 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002707 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002709 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2710 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002712 msg_puts((char *)s);
2713 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 }
2715 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002717 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002719 msg_puts("\n"); // don't overwrite this either
2720
2721 verbose_leave_scroll();
2722 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 }
2724#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002725 if (do_profiling == PROF_YES)
2726 profile_may_start_func(&profile_info, fp,
2727 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728#endif
2729
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002730 save_current_sctx = current_sctx;
2731 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 save_did_emsg = did_emsg;
2733 did_emsg = FALSE;
2734
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002735 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2736 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002737 else if (islambda)
2738 {
2739 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2740
2741 // A Lambda always has the command "return {expr}". It is much faster
2742 // to evaluate {expr} directly.
2743 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002744 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002745 --ex_nesting_level;
2746 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002747 else
2748 // call do_cmdline() to execute the lines
2749 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2751
2752 --RedrawingDisabled;
2753
Bram Moolenaare38eab22019-12-05 21:50:01 +01002754 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2756 {
2757 clear_tv(rettv);
2758 rettv->v_type = VAR_NUMBER;
2759 rettv->vval.v_number = -1;
2760 }
2761
2762#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002763 if (do_profiling == PROF_YES)
2764 {
2765 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2766
2767 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2768 profile_may_end_func(&profile_info, fp, caller);
2769 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770#endif
2771
Bram Moolenaare38eab22019-12-05 21:50:01 +01002772 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 if (p_verbose >= 12)
2774 {
2775 ++no_wait_return;
2776 verbose_enter_scroll();
2777
2778 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002779 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002781 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 (long)fc->rettv->vval.v_number);
2783 else
2784 {
2785 char_u buf[MSG_BUF_LEN];
2786 char_u numbuf2[NUMBUFLEN];
2787 char_u *tofree;
2788 char_u *s;
2789
Bram Moolenaare38eab22019-12-05 21:50:01 +01002790 // The value may be very long. Skip the middle part, so that we
2791 // have some idea how it starts and ends. smsg() would always
2792 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793 ++emsg_off;
2794 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2795 --emsg_off;
2796 if (s != NULL)
2797 {
2798 if (vim_strsize(s) > MSG_BUF_CLEN)
2799 {
2800 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2801 s = buf;
2802 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002803 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 vim_free(tofree);
2805 }
2806 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002807 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808
2809 verbose_leave_scroll();
2810 --no_wait_return;
2811 }
2812
Bram Moolenaare31ee862020-01-07 20:59:34 +01002813 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002814 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002815 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816#ifdef FEAT_PROFILE
2817 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002818 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002820 if (using_sandbox)
2821 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002823 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 {
2825 ++no_wait_return;
2826 verbose_enter_scroll();
2827
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002828 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002829 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830
2831 verbose_leave_scroll();
2832 --no_wait_return;
2833 }
2834
2835 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002836 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002837 for (i = 0; i < tv_to_free_len; ++i)
2838 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002839 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840}
2841
2842/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002843 * Check the argument count for user function "fp".
2844 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2845 */
2846 int
2847check_user_func_argcount(ufunc_T *fp, int argcount)
2848{
2849 int regular_args = fp->uf_args.ga_len;
2850
2851 if (argcount < regular_args - fp->uf_def_args.ga_len)
2852 return FCERR_TOOFEW;
2853 else if (!has_varargs(fp) && argcount > regular_args)
2854 return FCERR_TOOMANY;
2855 return FCERR_UNKNOWN;
2856}
2857
2858/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002859 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002860 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002861 int
2862call_user_func_check(
2863 ufunc_T *fp,
2864 int argcount,
2865 typval_T *argvars,
2866 typval_T *rettv,
2867 funcexe_T *funcexe,
2868 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002869{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002870 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002871
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002872 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2873 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002874 error = check_user_func_argcount(fp, argcount);
2875 if (error != FCERR_UNKNOWN)
2876 return error;
2877 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002878 error = FCERR_DICT;
2879 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002880 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 int did_save_redo = FALSE;
2882 save_redo_T save_redo;
2883
2884 /*
2885 * Call the user function.
2886 * Save and restore search patterns, script variables and
2887 * redo buffer.
2888 */
2889 save_search_patterns();
2890 if (!ins_compl_active())
2891 {
2892 saveRedobuff(&save_redo);
2893 did_save_redo = TRUE;
2894 }
2895 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002896 call_user_func(fp, argcount, argvars, rettv, funcexe,
2897 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002898 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2899 // Function was unreferenced while being used, free it now.
2900 func_clear_free(fp, FALSE);
2901 if (did_save_redo)
2902 restoreRedobuff(&save_redo);
2903 restore_search_patterns();
2904 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002905 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002906 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002907}
2908
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002909static funccal_entry_T *funccal_stack = NULL;
2910
2911/*
2912 * Save the current function call pointer, and set it to NULL.
2913 * Used when executing autocommands and for ":source".
2914 */
2915 void
2916save_funccal(funccal_entry_T *entry)
2917{
2918 entry->top_funccal = current_funccal;
2919 entry->next = funccal_stack;
2920 funccal_stack = entry;
2921 current_funccal = NULL;
2922}
2923
2924 void
2925restore_funccal(void)
2926{
2927 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002928 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002929 else
2930 {
2931 current_funccal = funccal_stack->top_funccal;
2932 funccal_stack = funccal_stack->next;
2933 }
2934}
2935
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002936 funccall_T *
2937get_current_funccal(void)
2938{
2939 return current_funccal;
2940}
2941
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002942/*
2943 * Mark all functions of script "sid" as deleted.
2944 */
2945 void
2946delete_script_functions(int sid)
2947{
2948 hashitem_T *hi;
2949 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002950 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002951 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002952 size_t len;
2953
2954 buf[0] = K_SPECIAL;
2955 buf[1] = KS_EXTRA;
2956 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002957 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002958 len = STRLEN(buf);
2959
Bram Moolenaarce658352020-07-31 23:47:12 +02002960 while (todo > 0)
2961 {
2962 todo = func_hashtab.ht_used;
2963 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2964 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002965 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002966 fp = HI2UF(hi);
2967 if (STRNCMP(fp->uf_name, buf, len) == 0)
2968 {
2969 int changed = func_hashtab.ht_changed;
2970
2971 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002972
2973 if (fp->uf_calls > 0)
2974 {
2975 // Function is executing, don't free it but do remove
2976 // it from the hashtable.
2977 if (func_remove(fp))
2978 fp->uf_refcount--;
2979 }
2980 else
2981 {
2982 func_clear(fp, TRUE);
2983 // When clearing a function another function can be
2984 // cleared as a side effect. When that happens start
2985 // over.
2986 if (changed != func_hashtab.ht_changed)
2987 break;
2988 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002989 }
2990 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002991 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002992 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002993}
2994
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995#if defined(EXITFREE) || defined(PROTO)
2996 void
2997free_all_functions(void)
2998{
2999 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003000 ufunc_T *fp;
3001 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003002 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003003 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004
Bram Moolenaare38eab22019-12-05 21:50:01 +01003005 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003006 while (current_funccal != NULL)
3007 {
3008 clear_tv(current_funccal->rettv);
3009 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003010 if (current_funccal == NULL && funccal_stack != NULL)
3011 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003012 }
3013
Bram Moolenaare38eab22019-12-05 21:50:01 +01003014 // First clear what the functions contain. Since this may lower the
3015 // reference count of a function, it may also free a function and change
3016 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003017 while (todo > 0)
3018 {
3019 todo = func_hashtab.ht_used;
3020 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3021 if (!HASHITEM_EMPTY(hi))
3022 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 // clear the def function index now
3024 fp = HI2UF(hi);
3025 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003026 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003027
Bram Moolenaare38eab22019-12-05 21:50:01 +01003028 // Only free functions that are not refcounted, those are
3029 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003030 if (func_name_refcount(fp->uf_name))
3031 ++skipped;
3032 else
3033 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003034 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003035 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003036 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003037 {
3038 skipped = 0;
3039 break;
3040 }
3041 }
3042 --todo;
3043 }
3044 }
3045
Bram Moolenaare38eab22019-12-05 21:50:01 +01003046 // Now actually free the functions. Need to start all over every time,
3047 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003048 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003049 while (func_hashtab.ht_used > skipped)
3050 {
3051 todo = func_hashtab.ht_used;
3052 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 if (!HASHITEM_EMPTY(hi))
3054 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003055 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003056 // Only free functions that are not refcounted, those are
3057 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003058 fp = HI2UF(hi);
3059 if (func_name_refcount(fp->uf_name))
3060 ++skipped;
3061 else
3062 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003063 if (func_free(fp, FALSE) == OK)
3064 {
3065 skipped = 0;
3066 break;
3067 }
3068 // did not actually free it
3069 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003070 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003071 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003072 }
3073 if (skipped == 0)
3074 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003075
3076 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077}
3078#endif
3079
3080/*
3081 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003082 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003083 * "len" is the length of "name", or -1 for NUL terminated.
3084 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003085 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086builtin_function(char_u *name, int len)
3087{
3088 char_u *p;
3089
Bram Moolenaara26b9702020-04-18 19:53:28 +02003090 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 return FALSE;
3092 p = vim_strchr(name, AUTOLOAD_CHAR);
3093 return p == NULL || (len > 0 && p > name + len);
3094}
3095
3096 int
3097func_call(
3098 char_u *name,
3099 typval_T *args,
3100 partial_T *partial,
3101 dict_T *selfdict,
3102 typval_T *rettv)
3103{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003104 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003105 listitem_T *item;
3106 typval_T argv[MAX_FUNC_ARGS + 1];
3107 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 int r = 0;
3109
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003110 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003111 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 {
3113 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3114 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003115 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 break;
3117 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003118 // Make a copy of each argument. This is needed to be able to set
3119 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120 copy_tv(&item->li_tv, &argv[argc++]);
3121 }
3122
3123 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003124 {
3125 funcexe_T funcexe;
3126
Bram Moolenaara80faa82020-04-12 19:37:17 +02003127 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003128 funcexe.firstline = curwin->w_cursor.lnum;
3129 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003130 funcexe.evaluate = TRUE;
3131 funcexe.partial = partial;
3132 funcexe.selfdict = selfdict;
3133 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3134 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135
Bram Moolenaare38eab22019-12-05 21:50:01 +01003136 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003137 while (argc > 0)
3138 clear_tv(&argv[--argc]);
3139
3140 return r;
3141}
3142
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003143static int callback_depth = 0;
3144
3145 int
3146get_callback_depth(void)
3147{
3148 return callback_depth;
3149}
3150
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003152 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003153 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003154 */
3155 int
3156call_callback(
3157 callback_T *callback,
3158 int len, // length of "name" or -1 to use strlen()
3159 typval_T *rettv, // return value goes here
3160 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003161 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003162 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003163{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003164 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003165 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003166
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003167 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3168 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003169 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003170 funcexe.evaluate = TRUE;
3171 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003172 ++callback_depth;
3173 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3174 --callback_depth;
3175 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003176}
3177
3178/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003179 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003180 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003181 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3182 */
3183 varnumber_T
3184call_callback_retnr(
3185 callback_T *callback,
3186 int argcount, // number of "argvars"
3187 typval_T *argvars) // vars for arguments, must have "argcount"
3188 // PLUS ONE elements!
3189{
3190 typval_T rettv;
3191 varnumber_T retval;
3192
3193 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003194 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003195
3196 retval = tv_get_number_chk(&rettv, NULL);
3197 clear_tv(&rettv);
3198 return retval;
3199}
3200
3201/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 * Give an error message for the result of a function.
3203 * Nothing if "error" is FCERR_NONE.
3204 */
3205 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003206user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003207{
3208 switch (error)
3209 {
3210 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003211 if (funcexe->fe_found_var)
3212 semsg(_(e_not_callable_type_str), name);
3213 else
3214 emsg_funcname(e_unknownfunc, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003215 break;
3216 case FCERR_NOTMETHOD:
3217 emsg_funcname(
3218 N_("E276: Cannot use function as a method: %s"), name);
3219 break;
3220 case FCERR_DELETED:
3221 emsg_funcname(N_(e_func_deleted), name);
3222 break;
3223 case FCERR_TOOMANY:
3224 emsg_funcname((char *)e_toomanyarg, name);
3225 break;
3226 case FCERR_TOOFEW:
3227 emsg_funcname((char *)e_toofewarg, name);
3228 break;
3229 case FCERR_SCRIPT:
3230 emsg_funcname(
3231 N_("E120: Using <SID> not in a script context: %s"), name);
3232 break;
3233 case FCERR_DICT:
3234 emsg_funcname(
3235 N_("E725: Calling dict function without Dictionary: %s"),
3236 name);
3237 break;
3238 }
3239}
3240
3241/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003243 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244 * Return FAIL when the function can't be called, OK otherwise.
3245 * Also returns OK when an error was encountered while executing the function.
3246 */
3247 int
3248call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003249 char_u *funcname, // name of the function
3250 int len, // length of "name" or -1 to use strlen()
3251 typval_T *rettv, // return value goes here
3252 int argcount_in, // number of "argvars"
3253 typval_T *argvars_in, // vars for arguments, must have "argcount"
3254 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003255 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256{
3257 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003258 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003260 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 char_u fname_buf[FLEN_FIXED + 1];
3262 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003263 char_u *fname = NULL;
3264 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 int argcount = argcount_in;
3266 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003267 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003268 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3269 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003271 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003272 partial_T *partial = funcexe->partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003273 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003275 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3276 // even when call_func() returns FAIL.
3277 rettv->v_type = VAR_UNKNOWN;
3278
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003279 if (partial != NULL)
3280 fp = partial->pt_func;
3281 if (fp == NULL)
3282 {
3283 // Make a copy of the name, if it comes from a funcref variable it
3284 // could be changed or deleted in the called function.
3285 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3286 if (name == NULL)
3287 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003289 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003291
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003292 if (funcexe->doesrange != NULL)
3293 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294
3295 if (partial != NULL)
3296 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003297 // When the function has a partial with a dict and there is a dict
3298 // argument, use the dict argument. That is backwards compatible.
3299 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003300 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003301 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003302 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 {
3304 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003305 {
3306 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3307 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003308 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003309 goto theend;
3310 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003312 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 for (i = 0; i < argcount_in; ++i)
3314 argv[i + argv_clear] = argvars_in[i];
3315 argvars = argv;
3316 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003317
Bram Moolenaar22f85d02021-07-04 23:29:30 +02003318 if (funcexe->check_type != NULL
3319 && funcexe->check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003320 {
3321 // Now funcexe->check_type is missing the added arguments, make
3322 // a copy of the type with the correction.
3323 check_type = *funcexe->check_type;
3324 funcexe->check_type = &check_type;
3325 check_type.tt_argcount += partial->pt_argc;
3326 check_type.tt_min_argcount += partial->pt_argc;
3327 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328 }
3329 }
3330
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003331 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3332 {
3333 // Check that the argument types are OK for the types of the funcref.
3334 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003335 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003336 error = FCERR_OTHER;
3337 }
3338
Bram Moolenaaref140542019-12-31 21:27:13 +01003339 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 {
3341 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003342 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343
Bram Moolenaar333894b2020-08-01 18:53:07 +02003344 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003345 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003346 {
3347 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003349 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350
Bram Moolenaare38eab22019-12-05 21:50:01 +01003351 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003353 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003355 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356 {
3357 /*
3358 * User defined function.
3359 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003360 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003361 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362
Bram Moolenaare38eab22019-12-05 21:50:01 +01003363 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 if (fp == NULL
3365 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003366 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 && !aborting())
3368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003370 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003372 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3374 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003375 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003376 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003378 if (fp == NULL)
3379 {
3380 char_u *p = untrans_function_name(rfname);
3381
3382 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003383 // Don't do this if the name starts with "s:".
3384 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003385 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003386 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003388 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003389 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003390#ifdef FEAT_LUA
3391 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3392 {
3393 cfunc_T cb = fp->uf_cb;
3394
3395 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3396 }
3397#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003398 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003400 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003401 // postponed filling in the arguments, do it now
3402 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003403 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003404
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003405 if (funcexe->basetv != NULL)
3406 {
3407 // Method call: base->Method()
3408 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3409 argv[0] = *funcexe->basetv;
3410 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003411 argvars = argv;
3412 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003413 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003414
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003415 error = call_user_func_check(fp, argcount, argvars, rettv,
3416 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 }
3418 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003419 else if (funcexe->basetv != NULL)
3420 {
3421 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003422 * expr->method(): Find the method name in the table, call its
3423 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003424 */
3425 error = call_internal_method(fname, argcount, argvars, rettv,
3426 funcexe->basetv);
3427 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 else
3429 {
3430 /*
3431 * Find the function name in the table, call its implementation.
3432 */
3433 error = call_internal_func(fname, argcount, argvars, rettv);
3434 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003435
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 /*
3437 * The function call (or "FuncUndefined" autocommand sequence) might
3438 * have been aborted by an error, an interrupt, or an explicitly thrown
3439 * exception that has not been caught so far. This situation can be
3440 * tested for by calling aborting(). For an error in an internal
3441 * function or for the "E132" error in call_user_func(), however, the
3442 * throw point at which the "force_abort" flag (temporarily reset by
3443 * emsg()) is normally updated has not been reached yet. We need to
3444 * update that flag first to make aborting() reliable.
3445 */
3446 update_force_abort();
3447 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003448 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449 ret = OK;
3450
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003451theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 /*
3453 * Report an error unless the argument evaluation or function call has been
3454 * cancelled due to an aborting error, an interrupt, or an exception.
3455 */
3456 if (!aborting())
3457 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003458 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003459 }
3460
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003461 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003463 clear_tv(&argv[--argv_clear + argv_base]);
3464
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 vim_free(tofree);
3466 vim_free(name);
3467
3468 return ret;
3469}
3470
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003471 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003472printable_func_name(ufunc_T *fp)
3473{
3474 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3475}
3476
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003478 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 */
3480 static void
3481list_func_head(ufunc_T *fp, int indent)
3482{
3483 int j;
3484
3485 msg_start();
3486 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003487 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003488 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003489 msg_puts("def ");
3490 else
3491 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003492 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 msg_putchar('(');
3494 for (j = 0; j < fp->uf_args.ga_len; ++j)
3495 {
3496 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003497 msg_puts(", ");
3498 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003499 if (fp->uf_arg_types != NULL)
3500 {
3501 char *tofree;
3502
3503 msg_puts(": ");
3504 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3505 vim_free(tofree);
3506 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003507 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3508 {
3509 msg_puts(" = ");
3510 msg_puts(((char **)(fp->uf_def_args.ga_data))
3511 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3512 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 }
3514 if (fp->uf_varargs)
3515 {
3516 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003517 msg_puts(", ");
3518 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003520 if (fp->uf_va_name != NULL)
3521 {
3522 if (j)
3523 msg_puts(", ");
3524 msg_puts("...");
3525 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003526 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003527 {
3528 char *tofree;
3529
3530 msg_puts(": ");
3531 msg_puts(type_name(fp->uf_va_type, &tofree));
3532 vim_free(tofree);
3533 }
3534 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003536
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003537 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003538 {
3539 if (fp->uf_ret_type != &t_void)
3540 {
3541 char *tofree;
3542
3543 msg_puts(": ");
3544 msg_puts(type_name(fp->uf_ret_type, &tofree));
3545 vim_free(tofree);
3546 }
3547 }
3548 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003549 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003551 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003553 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003554 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003555 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 msg_clr_eos();
3557 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003558 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559}
3560
3561/*
3562 * Get a function name, translating "<SID>" and "<SNR>".
3563 * Also handles a Funcref in a List or Dictionary.
3564 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003565 * Set "*is_global" to TRUE when the function must be global, unless
3566 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 * flags:
3568 * TFN_INT: internal function name OK
3569 * TFN_QUIET: be quiet
3570 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003571 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 * Advances "pp" to just after the function name (if no error).
3573 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003574 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575trans_function_name(
3576 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003577 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003578 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003580 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003581 partial_T **partial, // return: partial of a FuncRef
3582 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583{
3584 char_u *name = NULL;
3585 char_u *start;
3586 char_u *end;
3587 int lead;
3588 char_u sid_buf[20];
3589 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003590 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003592 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003593 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594
3595 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003596 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 start = *pp;
3598
Bram Moolenaare38eab22019-12-05 21:50:01 +01003599 // Check for hard coded <SNR>: already translated function ID (from a user
3600 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3602 && (*pp)[2] == (int)KE_SNR)
3603 {
3604 *pp += 3;
3605 len = get_id_len(pp) + 3;
3606 return vim_strnsave(start, len);
3607 }
3608
Bram Moolenaare38eab22019-12-05 21:50:01 +01003609 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3610 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 lead = eval_fname_script(start);
3612 if (lead > 2)
3613 start += lead;
3614
Bram Moolenaare38eab22019-12-05 21:50:01 +01003615 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003616 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 lead > 2 ? 0 : FNE_CHECK_START);
3618 if (end == start)
3619 {
3620 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003621 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 goto theend;
3623 }
3624 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3625 {
3626 /*
3627 * Report an invalid expression in braces, unless the expression
3628 * evaluation has been cancelled due to an aborting error, an
3629 * interrupt, or an exception.
3630 */
3631 if (!aborting())
3632 {
3633 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003634 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 }
3636 else
3637 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3638 goto theend;
3639 }
3640
3641 if (lv.ll_tv != NULL)
3642 {
3643 if (fdp != NULL)
3644 {
3645 fdp->fd_dict = lv.ll_dict;
3646 fdp->fd_newkey = lv.ll_newkey;
3647 lv.ll_newkey = NULL;
3648 fdp->fd_di = lv.ll_di;
3649 }
3650 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3651 {
3652 name = vim_strsave(lv.ll_tv->vval.v_string);
3653 *pp = end;
3654 }
3655 else if (lv.ll_tv->v_type == VAR_PARTIAL
3656 && lv.ll_tv->vval.v_partial != NULL)
3657 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003658 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 *pp = end;
3660 if (partial != NULL)
3661 *partial = lv.ll_tv->vval.v_partial;
3662 }
3663 else
3664 {
3665 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3666 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003667 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 else
3669 *pp = end;
3670 name = NULL;
3671 }
3672 goto theend;
3673 }
3674
3675 if (lv.ll_name == NULL)
3676 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003677 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 *pp = end;
3679 goto theend;
3680 }
3681
Bram Moolenaare38eab22019-12-05 21:50:01 +01003682 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 if (lv.ll_exp_name != NULL)
3684 {
3685 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003686 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003687 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 if (name == lv.ll_exp_name)
3689 name = NULL;
3690 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003691 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 {
3693 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003694 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003695 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 if (name == *pp)
3697 name = NULL;
3698 }
3699 if (name != NULL)
3700 {
3701 name = vim_strsave(name);
3702 *pp = end;
3703 if (STRNCMP(name, "<SNR>", 5) == 0)
3704 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003705 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 name[0] = K_SPECIAL;
3707 name[1] = KS_EXTRA;
3708 name[2] = (int)KE_SNR;
3709 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3710 }
3711 goto theend;
3712 }
3713
3714 if (lv.ll_exp_name != NULL)
3715 {
3716 len = (int)STRLEN(lv.ll_exp_name);
3717 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3718 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3719 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003720 // When there was "s:" already or the name expanded to get a
3721 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 lv.ll_name += 2;
3723 len -= 2;
3724 lead = 2;
3725 }
3726 }
3727 else
3728 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003729 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003730 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003731 {
3732 if (is_global != NULL && lv.ll_name[0] == 'g')
3733 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003735 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736 len = (int)(end - lv.ll_name);
3737 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003738 if (len <= 0)
3739 {
3740 if (!skip)
3741 emsg(_(e_function_name));
3742 goto theend;
3743 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003745 // In Vim9 script a user function is script-local by default, unless it
3746 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003747 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003748 if (vim9script)
3749 {
3750 char_u *p;
3751
3752 // SomeScript#func() is a global function.
3753 for (p = start; *p != NUL && *p != '('; ++p)
3754 if (*p == AUTOLOAD_CHAR)
3755 vim9script = FALSE;
3756 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003757
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 /*
3759 * Copy the function name to allocated memory.
3760 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3761 * Accept <SNR>123_name() outside a script.
3762 */
3763 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003764 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003765 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003767 if (!vim9script)
3768 lead = 3;
3769 if (vim9script || (lv.ll_exp_name != NULL
3770 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 || eval_fname_sid(*pp))
3772 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003773 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003774 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003776 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 goto theend;
3778 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003779 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003780 if (vim9script)
3781 extra = 3 + (int)STRLEN(sid_buf);
3782 else
3783 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784 }
3785 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003786 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3787 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003789 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 start);
3791 goto theend;
3792 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003793 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 {
3795 char_u *cp = vim_strchr(lv.ll_name, ':');
3796
3797 if (cp != NULL && cp < end)
3798 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003799 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 goto theend;
3801 }
3802 }
3803
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003804 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 if (name != NULL)
3806 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003807 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 {
3809 name[0] = K_SPECIAL;
3810 name[1] = KS_EXTRA;
3811 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003812 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813 STRCPY(name + 3, sid_buf);
3814 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003815 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3816 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 }
3818 *pp = end;
3819
3820theend:
3821 clear_lval(&lv);
3822 return name;
3823}
3824
3825/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003826 * Assuming "name" is the result of trans_function_name() and it was prefixed
3827 * to use the script-local name, return the unmodified name (points into
3828 * "name"). Otherwise return NULL.
3829 * This can be used to first search for a script-local function and fall back
3830 * to the global function if not found.
3831 */
3832 char_u *
3833untrans_function_name(char_u *name)
3834{
3835 char_u *p;
3836
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003837 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003838 {
3839 p = vim_strchr(name, '_');
3840 if (p != NULL)
3841 return p + 1;
3842 }
3843 return NULL;
3844}
3845
3846/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003847 * Call trans_function_name(), except that a lambda is returned as-is.
3848 * Returns the name in allocated memory.
3849 */
3850 char_u *
3851save_function_name(
3852 char_u **name,
3853 int *is_global,
3854 int skip,
3855 int flags,
3856 funcdict_T *fudi)
3857{
3858 char_u *p = *name;
3859 char_u *saved;
3860
3861 if (STRNCMP(p, "<lambda>", 8) == 0)
3862 {
3863 p += 8;
3864 (void)getdigits(&p);
3865 saved = vim_strnsave(*name, p - *name);
3866 if (fudi != NULL)
3867 CLEAR_POINTER(fudi);
3868 }
3869 else
3870 saved = trans_function_name(&p, is_global, skip,
3871 flags, fudi, NULL, NULL);
3872 *name = p;
3873 return saved;
3874}
3875
3876/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003877 * List functions. When "regmatch" is NULL all of then.
3878 * Otherwise functions matching "regmatch".
3879 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003880 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003881list_functions(regmatch_T *regmatch)
3882{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003883 int changed = func_hashtab.ht_changed;
3884 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003885 hashitem_T *hi;
3886
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003887 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003888 {
3889 if (!HASHITEM_EMPTY(hi))
3890 {
3891 ufunc_T *fp = HI2UF(hi);
3892
3893 --todo;
3894 if ((fp->uf_flags & FC_DEAD) == 0
3895 && (regmatch == NULL
3896 ? !message_filtered(fp->uf_name)
3897 && !func_name_refcount(fp->uf_name)
3898 : !isdigit(*fp->uf_name)
3899 && vim_regexec(regmatch, fp->uf_name, 0)))
3900 {
3901 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003902 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003903 {
3904 emsg(_("E454: function list was modified"));
3905 return;
3906 }
3907 }
3908 }
3909 }
3910}
3911
3912/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003913 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003914 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3915 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003916 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003918 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003919define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003921 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 int j;
3923 int c;
3924 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003925 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003926 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 char_u *p;
3928 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003929 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 char_u *line_arg = NULL;
3931 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003932 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003933 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 garray_T newlines;
3935 int varargs = FALSE;
3936 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003937 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003938 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003939 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940 dictitem_T *v;
3941 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003942 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003945 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003946 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003947 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948
3949 /*
3950 * ":function" without argument: list functions.
3951 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003952 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 {
3954 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003955 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02003956 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003957 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 }
3959
3960 /*
3961 * ":function /pat": list functions matching pattern.
3962 */
3963 if (*eap->arg == '/')
3964 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003965 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 if (!eap->skip)
3967 {
3968 regmatch_T regmatch;
3969
3970 c = *p;
3971 *p = NUL;
3972 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3973 *p = c;
3974 if (regmatch.regprog != NULL)
3975 {
3976 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003977 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 vim_regfree(regmatch.regprog);
3979 }
3980 }
3981 if (*p == '/')
3982 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02003983 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003984 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 }
3986
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003987 ga_init(&newargs);
3988 ga_init(&argtypes);
3989 ga_init(&default_args);
3990
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991 /*
3992 * Get the function name. There are these situations:
3993 * func normal function name
3994 * "name" == func, "fudi.fd_dict" == NULL
3995 * dict.func new dictionary entry
3996 * "name" == NULL, "fudi.fd_dict" set,
3997 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3998 * dict.func existing dict entry with a Funcref
3999 * "name" == func, "fudi.fd_dict" set,
4000 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4001 * dict.func existing dict entry that's not a Funcref
4002 * "name" == NULL, "fudi.fd_dict" set,
4003 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4004 * s:func script-local function name
4005 * g:func global function name, same as "func"
4006 */
4007 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004008 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004009 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004010 // nested function, argument is (args).
4011 paren = TRUE;
4012 CLEAR_FIELD(fudi);
4013 }
4014 else
4015 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004016 name = save_function_name(&p, &is_global, eap->skip,
4017 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004018 paren = (vim_strchr(p, '(') != NULL);
4019 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004021 /*
4022 * Return on an invalid expression in braces, unless the expression
4023 * evaluation has been cancelled due to an aborting error, an
4024 * interrupt, or an exception.
4025 */
4026 if (!aborting())
4027 {
4028 if (!eap->skip && fudi.fd_newkey != NULL)
4029 semsg(_(e_dictkey), fudi.fd_newkey);
4030 vim_free(fudi.fd_newkey);
4031 return NULL;
4032 }
4033 else
4034 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 }
4037
Bram Moolenaare38eab22019-12-05 21:50:01 +01004038 // An error in a function call during evaluation of an expression in magic
4039 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 saved_did_emsg = did_emsg;
4041 did_emsg = FALSE;
4042
4043 /*
4044 * ":function func" with only function name: list function.
4045 */
4046 if (!paren)
4047 {
4048 if (!ends_excmd(*skipwhite(p)))
4049 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004050 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 goto ret_free;
4052 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004053 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 if (eap->nextcmd != NULL)
4055 *p = NUL;
4056 if (!eap->skip && !got_int)
4057 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004058 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004059 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4060 {
4061 char_u *up = untrans_function_name(name);
4062
4063 // With Vim9 script the name was made script-local, if not
4064 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004065 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004066 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004067 }
4068
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 if (fp != NULL)
4070 {
4071 list_func_head(fp, TRUE);
4072 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4073 {
4074 if (FUNCLINE(fp, j) == NULL)
4075 continue;
4076 msg_putchar('\n');
4077 msg_outnum((long)(j + 1));
4078 if (j < 9)
4079 msg_putchar(' ');
4080 if (j < 99)
4081 msg_putchar(' ');
4082 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004083 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 ui_breakcheck();
4085 }
4086 if (!got_int)
4087 {
4088 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004089 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004090 msg_puts(" enddef");
4091 else
4092 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 }
4094 }
4095 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02004096 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 }
4098 goto ret_free;
4099 }
4100
4101 /*
4102 * ":function name(arg1, arg2)" Define function.
4103 */
4104 p = skipwhite(p);
4105 if (*p != '(')
4106 {
4107 if (!eap->skip)
4108 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004109 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 goto ret_free;
4111 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004112 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 if (vim_strchr(p, '(') != NULL)
4114 p = vim_strchr(p, '(');
4115 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004117 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4118 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004119 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004120 goto ret_free;
4121 }
4122
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004123 // In Vim9 script only global functions can be redefined.
4124 if (vim9script && eap->forceit && !is_global)
4125 {
4126 emsg(_(e_nobang));
4127 goto ret_free;
4128 }
4129
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004130 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004131
Bram Moolenaar04b12692020-05-04 23:24:44 +02004132 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004134 // Check the name of the function. Unless it's a dictionary function
4135 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 if (name != NULL)
4137 arg = name;
4138 else
4139 arg = fudi.fd_newkey;
4140 if (arg != NULL && (fudi.fd_di == NULL
4141 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4142 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4143 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004144 char_u *name_base = arg;
4145 int i;
4146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004148 {
4149 name_base = vim_strchr(arg, '_');
4150 if (name_base == NULL)
4151 name_base = arg + 3;
4152 else
4153 ++name_base;
4154 }
4155 for (i = 0; name_base[i] != NUL && (i == 0
4156 ? eval_isnamec1(name_base[i])
4157 : eval_isnamec(name_base[i])); ++i)
4158 ;
4159 if (name_base[i] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160 emsg_funcname((char *)e_invarg2, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004161
4162 // In Vim9 script a function cannot have the same name as a
4163 // variable.
4164 if (vim9script && *arg == K_SPECIAL
4165 && eval_variable(name_base, STRLEN(name_base), NULL, NULL,
4166 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
4167 + EVAL_VAR_NO_FUNC) == OK)
4168 {
4169 semsg(_(e_redefining_script_item_str), name_base);
4170 goto ret_free;
4171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004173 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004174 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004175 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004176 emsg(_("E862: Cannot use g: here"));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004177 goto ret_free;
4178 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 }
4180
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004181 // This may get more lines and make the pointers into the first line
4182 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004183 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004184 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004185 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004186 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004187 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004189 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004191 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004193 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004194 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004196 if (*p != ':')
4197 {
4198 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4199 p = skipwhite(p);
4200 }
4201 else if (!IS_WHITE_OR_NUL(p[1]))
4202 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004203 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004204 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004205 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004206 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004207 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004208 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004209 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004210 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004211 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004212 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004213 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004214 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004215 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004216 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004217 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004219 else
4220 // find extra arguments "range", "dict", "abort" and "closure"
4221 for (;;)
4222 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004223 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004224 p = skipwhite(p);
4225 if (STRNCMP(p, "range", 5) == 0)
4226 {
4227 flags |= FC_RANGE;
4228 p += 5;
4229 }
4230 else if (STRNCMP(p, "dict", 4) == 0)
4231 {
4232 flags |= FC_DICT;
4233 p += 4;
4234 }
4235 else if (STRNCMP(p, "abort", 5) == 0)
4236 {
4237 flags |= FC_ABORT;
4238 p += 5;
4239 }
4240 else if (STRNCMP(p, "closure", 7) == 0)
4241 {
4242 flags |= FC_CLOSURE;
4243 p += 7;
4244 if (current_funccal == NULL)
4245 {
4246 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4247 name == NULL ? (char_u *)"" : name);
4248 goto erret;
4249 }
4250 }
4251 else
4252 break;
4253 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254
Bram Moolenaare38eab22019-12-05 21:50:01 +01004255 // When there is a line break use what follows for the function body.
4256 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257 if (*p == '\n')
4258 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004259 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004260 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4261 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004262 && !(VIM_ISWHITE(*whitep) && *p == '#'
4263 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004264 && !eap->skip
4265 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004266 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267
4268 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004269 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4270 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271 */
4272 if (KeyTyped)
4273 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004274 // Check if the function already exists, don't let the user type the
4275 // whole function before telling him it doesn't work! For a script we
4276 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 if (!eap->skip && !eap->forceit)
4278 {
4279 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004280 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004281 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 emsg_funcname(e_funcexts, name);
4283 }
4284
4285 if (!eap->skip && did_emsg)
4286 goto erret;
4287
Bram Moolenaare38eab22019-12-05 21:50:01 +01004288 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 cmdline_row = msg_row;
4290 }
4291
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004292 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004293 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004294
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004295 // Do not define the function when getting the body fails and when
4296 // skipping.
4297 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4298 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 goto erret;
4300
4301 /*
4302 * If there are no errors, add the function
4303 */
4304 if (fudi.fd_dict == NULL)
4305 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004306 hashtab_T *ht;
4307
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004308 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4310 {
4311 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4312 name);
4313 goto erret;
4314 }
4315
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004316 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004317 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004319 char_u *uname = untrans_function_name(name);
4320
4321 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4322 }
4323
4324 if (fp != NULL || import != NULL)
4325 {
4326 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004327
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004328 // Function can be replaced with "function!" and when sourcing the
4329 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004330 // A name that is used by an import can not be overruled.
4331 if (import != NULL
4332 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004333 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004334 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004336 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004337 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004338 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004339 else
4340 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341 goto erret;
4342 }
4343 if (fp->uf_calls > 0)
4344 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004345 emsg_funcname(
4346 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 name);
4348 goto erret;
4349 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004350 if (fp->uf_refcount > 1)
4351 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004352 // This function is referenced somewhere, don't redefine it but
4353 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004354 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004355 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004356 fp = NULL;
4357 overwrite = TRUE;
4358 }
4359 else
4360 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004361 char_u *exp_name = fp->uf_name_exp;
4362
4363 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004364 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004365 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004366 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004367 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004368 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004369#ifdef FEAT_PROFILE
4370 fp->uf_profiling = FALSE;
4371 fp->uf_prof_initialized = FALSE;
4372#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004373 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004374 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375 }
4376 }
4377 else
4378 {
4379 char numbuf[20];
4380
4381 fp = NULL;
4382 if (fudi.fd_newkey == NULL && !eap->forceit)
4383 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004384 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385 goto erret;
4386 }
4387 if (fudi.fd_di == NULL)
4388 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004389 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004390 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 goto erret;
4392 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004393 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004394 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395 goto erret;
4396
Bram Moolenaare38eab22019-12-05 21:50:01 +01004397 // Give the function a sequential number. Can only be used with a
4398 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 vim_free(name);
4400 sprintf(numbuf, "%d", ++func_nr);
4401 name = vim_strsave((char_u *)numbuf);
4402 if (name == NULL)
4403 goto erret;
4404 }
4405
4406 if (fp == NULL)
4407 {
4408 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4409 {
4410 int slen, plen;
4411 char_u *scriptname;
4412
Bram Moolenaare38eab22019-12-05 21:50:01 +01004413 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004415 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 {
4417 scriptname = autoload_name(name);
4418 if (scriptname != NULL)
4419 {
4420 p = vim_strchr(scriptname, '/');
4421 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004422 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004424 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 j = OK;
4426 vim_free(scriptname);
4427 }
4428 }
4429 if (j == FAIL)
4430 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004431 linenr_T save_lnum = SOURCING_LNUM;
4432
4433 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004434 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004435 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 goto erret;
4437 }
4438 }
4439
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004440 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004441 if (fp == NULL)
4442 goto erret;
4443
4444 if (fudi.fd_dict != NULL)
4445 {
4446 if (fudi.fd_di == NULL)
4447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004448 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4450 if (fudi.fd_di == NULL)
4451 {
4452 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004453 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004454 goto erret;
4455 }
4456 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4457 {
4458 vim_free(fudi.fd_di);
4459 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004460 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 goto erret;
4462 }
4463 }
4464 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004465 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 clear_tv(&fudi.fd_di->di_tv);
4467 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469
Bram Moolenaare38eab22019-12-05 21:50:01 +01004470 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 flags |= FC_DICT;
4472 }
4473
Bram Moolenaare38eab22019-12-05 21:50:01 +01004474 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004475 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004476 if (overwrite)
4477 {
4478 hi = hash_find(&func_hashtab, name);
4479 hi->hi_key = UF2HIKEY(fp);
4480 }
4481 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 {
4483 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004484 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 goto erret;
4486 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004487 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 }
4489 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004490 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004491 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004492 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004493
4494 if (eap->cmdidx == CMD_def)
4495 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004496 int lnum_save = SOURCING_LNUM;
4497 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004498
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004499 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004500
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004501 // error messages are for the first function line
4502 SOURCING_LNUM = sourcing_lnum_top;
4503
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004504 // The function may use script variables from the context.
4505 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004506
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004507 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004508 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004509 SOURCING_LNUM = lnum_save;
4510 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004511 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004512 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004513
4514 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004515 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004516 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004517 SOURCING_LNUM = lnum_save;
4518 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004519 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004520 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004521 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004522 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004524
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004526 if ((flags & FC_CLOSURE) != 0)
4527 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004528 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004529 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004530 }
4531 else
4532 fp->uf_scoped = NULL;
4533
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 if (prof_def_func())
4536 func_do_profile(fp);
4537#endif
4538 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004539 if (sandbox)
4540 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004541 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004542 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543 fp->uf_flags = flags;
4544 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004545 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004546 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004547 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004548 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004549 if (is_export)
4550 {
4551 fp->uf_flags |= FC_EXPORT;
4552 // let ex_export() know the export worked.
4553 is_export = FALSE;
4554 }
4555
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004556 if (eap->cmdidx == CMD_def)
4557 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004558 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4559 // :func does not use Vim9 script syntax, even in a Vim9 script file
4560 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004561
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 goto ret_free;
4563
4564erret:
4565 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004566 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004567 if (fp != NULL)
4568 {
4569 ga_init(&fp->uf_args);
4570 ga_init(&fp->uf_def_args);
4571 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572errret_2:
4573 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004574 if (fp != NULL)
4575 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004577 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004578 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004580 if (name != name_arg)
4581 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004582 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004584
4585 return fp;
4586}
4587
4588/*
4589 * ":function"
4590 */
4591 void
4592ex_function(exarg_T *eap)
4593{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004594 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004595}
4596
4597/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004598 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004599 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004600 */
4601 void
4602ex_defcompile(exarg_T *eap UNUSED)
4603{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004604 long todo = (long)func_hashtab.ht_used;
4605 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004606 hashitem_T *hi;
4607 ufunc_T *ufunc;
4608
4609 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4610 {
4611 if (!HASHITEM_EMPTY(hi))
4612 {
4613 --todo;
4614 ufunc = HI2UF(hi);
4615 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004616 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4617 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004618 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004619 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004620
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004621 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004622 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004623 // a function has been added or removed, need to start over
4624 todo = (long)func_hashtab.ht_used;
4625 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004626 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004627 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004628 }
4629 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004630 }
4631 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632}
4633
4634/*
4635 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4636 * Return 2 if "p" starts with "s:".
4637 * Return 0 otherwise.
4638 */
4639 int
4640eval_fname_script(char_u *p)
4641{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004642 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4643 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004644 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4645 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4646 return 5;
4647 if (p[0] == 's' && p[1] == ':')
4648 return 2;
4649 return 0;
4650}
4651
4652 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004653translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654{
4655 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004656 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004657 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004658}
4659
4660/*
4661 * Return TRUE when "ufunc" has old-style "..." varargs
4662 * or named varargs "...name: type".
4663 */
4664 int
4665has_varargs(ufunc_T *ufunc)
4666{
4667 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668}
4669
4670/*
4671 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004672 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673 */
4674 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004675function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676{
4677 char_u *nm = name;
4678 char_u *p;
4679 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004680 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004681 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004683 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4684 if (no_deref)
4685 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004686 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687 nm = skipwhite(nm);
4688
Bram Moolenaare38eab22019-12-05 21:50:01 +01004689 // Only accept "funcname", "funcname ", "funcname (..." and
4690 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004692 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 vim_free(p);
4694 return n;
4695}
4696
Bram Moolenaar113e1072019-01-20 15:30:40 +01004697#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698 char_u *
4699get_expanded_name(char_u *name, int check)
4700{
4701 char_u *nm = name;
4702 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004703 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004704
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004705 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004706 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004708 if (p != NULL && *nm == NUL
4709 && (!check || translated_function_exists(p, is_global)))
4710 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711
4712 vim_free(p);
4713 return NULL;
4714}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004715#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004716
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717/*
4718 * Function given to ExpandGeneric() to obtain the list of user defined
4719 * function names.
4720 */
4721 char_u *
4722get_user_func_name(expand_T *xp, int idx)
4723{
4724 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004725 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 static hashitem_T *hi;
4727 ufunc_T *fp;
4728
4729 if (idx == 0)
4730 {
4731 done = 0;
4732 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004733 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004735 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004736 {
4737 if (done++ > 0)
4738 ++hi;
4739 while (HASHITEM_EMPTY(hi))
4740 ++hi;
4741 fp = HI2UF(hi);
4742
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004743 // don't show dead, dict and lambda functions
4744 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004745 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004746 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747
4748 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004749 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750
4751 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004752 if (xp->xp_context != EXPAND_USER_FUNC
4753 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 {
4755 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004756 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 STRCAT(IObuff, ")");
4758 }
4759 return IObuff;
4760 }
4761 return NULL;
4762}
4763
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004764/*
4765 * ":delfunction {name}"
4766 */
4767 void
4768ex_delfunction(exarg_T *eap)
4769{
4770 ufunc_T *fp = NULL;
4771 char_u *p;
4772 char_u *name;
4773 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004774 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775
4776 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004777 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4778 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004779 vim_free(fudi.fd_newkey);
4780 if (name == NULL)
4781 {
4782 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004783 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 return;
4785 }
4786 if (!ends_excmd(*skipwhite(p)))
4787 {
4788 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004789 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790 return;
4791 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004792 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 if (eap->nextcmd != NULL)
4794 *p = NUL;
4795
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004796 if (isdigit(*name) && fudi.fd_dict == NULL)
4797 {
4798 if (!eap->skip)
4799 semsg(_(e_invarg2), eap->arg);
4800 vim_free(name);
4801 return;
4802 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004803 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004804 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004805 vim_free(name);
4806
4807 if (!eap->skip)
4808 {
4809 if (fp == NULL)
4810 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004811 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004812 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 return;
4814 }
4815 if (fp->uf_calls > 0)
4816 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004817 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818 return;
4819 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004820 if (fp->uf_flags & FC_VIM9)
4821 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004822 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004823 return;
4824 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825
4826 if (fudi.fd_dict != NULL)
4827 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004828 // Delete the dict item that refers to the function, it will
4829 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004830 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4831 }
4832 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004833 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004834 // A normal function (not a numbered function or lambda) has a
4835 // refcount of 1 for the entry in the hashtable. When deleting
4836 // it and the refcount is more than one, it should be kept.
4837 // A numbered function and lambda should be kept if the refcount is
4838 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004839 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004840 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004841 // Function is still referenced somewhere. Don't free it but
4842 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004843 if (func_remove(fp))
4844 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004845 }
4846 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004847 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004848 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 }
4850}
4851
4852/*
4853 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004854 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 */
4856 void
4857func_unref(char_u *name)
4858{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004859 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004861 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004862 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004863 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004864 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004865 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004867 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004868#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004869 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004871 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004872}
4873
4874/*
4875 * Unreference a Function: decrement the reference count and free it when it
4876 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004877 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004878 */
4879 void
4880func_ptr_unref(ufunc_T *fp)
4881{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004882 if (fp != NULL && (--fp->uf_refcount <= 0
4883 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4884 && fp->uf_partial->pt_refcount <= 1
4885 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004886 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004887 // Only delete it when it's not being used. Otherwise it's done
4888 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004889 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004890 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004891 }
4892}
4893
4894/*
4895 * Count a reference to a Function.
4896 */
4897 void
4898func_ref(char_u *name)
4899{
4900 ufunc_T *fp;
4901
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004902 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004904 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004905 if (fp != NULL)
4906 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004908 // Only give an error for a numbered function.
4909 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004910 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004911}
4912
4913/*
4914 * Count a reference to a Function.
4915 */
4916 void
4917func_ptr_ref(ufunc_T *fp)
4918{
4919 if (fp != NULL)
4920 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004921}
4922
4923/*
4924 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4925 * referenced from anywhere that is in use.
4926 */
4927 static int
4928can_free_funccal(funccall_T *fc, int copyID)
4929{
4930 return (fc->l_varlist.lv_copyID != copyID
4931 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004932 && fc->l_avars.dv_copyID != copyID
4933 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934}
4935
4936/*
4937 * ":return [expr]"
4938 */
4939 void
4940ex_return(exarg_T *eap)
4941{
4942 char_u *arg = eap->arg;
4943 typval_T rettv;
4944 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004945 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946
4947 if (current_funccal == NULL)
4948 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004949 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950 return;
4951 }
4952
Bram Moolenaar844fb642021-10-23 13:32:30 +01004953 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004954 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4955
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 if (eap->skip)
4957 ++emsg_skip;
4958
4959 eap->nextcmd = NULL;
4960 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004961 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962 {
4963 if (!eap->skip)
4964 returning = do_return(eap, FALSE, TRUE, &rettv);
4965 else
4966 clear_tv(&rettv);
4967 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004968 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969 else if (!eap->skip)
4970 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004971 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004972 update_force_abort();
4973
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974 /*
4975 * Return unless the expression evaluation has been cancelled due to an
4976 * aborting error, an interrupt, or an exception.
4977 */
4978 if (!aborting())
4979 returning = do_return(eap, FALSE, TRUE, NULL);
4980 }
4981
Bram Moolenaare38eab22019-12-05 21:50:01 +01004982 // When skipping or the return gets pending, advance to the next command
4983 // in this line (!returning). Otherwise, ignore the rest of the line.
4984 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 if (returning)
4986 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004987 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02004988 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004989
4990 if (eap->skip)
4991 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004992 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993}
4994
4995/*
4996 * ":1,25call func(arg1, arg2)" function call.
4997 */
4998 void
4999ex_call(exarg_T *eap)
5000{
5001 char_u *arg = eap->arg;
5002 char_u *startarg;
5003 char_u *name;
5004 char_u *tofree;
5005 int len;
5006 typval_T rettv;
5007 linenr_T lnum;
5008 int doesrange;
5009 int failed = FALSE;
5010 funcdict_T fudi;
5011 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005012 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005013 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005014 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005015
Bram Moolenaare6b53242020-07-01 17:28:33 +02005016 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017 if (eap->skip)
5018 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005019 // trans_function_name() doesn't work well when skipping, use eval0()
5020 // instead to skip to any following command, e.g. for:
5021 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005022 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005023 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024 clear_tv(&rettv);
5025 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005026 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005027 return;
5028 }
5029
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005030 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5031 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 if (fudi.fd_newkey != NULL)
5033 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005034 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005035 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005036 vim_free(fudi.fd_newkey);
5037 }
5038 if (tofree == NULL)
5039 return;
5040
Bram Moolenaare38eab22019-12-05 21:50:01 +01005041 // Increase refcount on dictionary, it could get deleted when evaluating
5042 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005043 if (fudi.fd_dict != NULL)
5044 ++fudi.fd_dict->dv_refcount;
5045
Bram Moolenaare38eab22019-12-05 21:50:01 +01005046 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5047 // contents. For VAR_PARTIAL get its partial, unless we already have one
5048 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005049 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005050 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005051 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052
Bram Moolenaare38eab22019-12-05 21:50:01 +01005053 // Skip white space to allow ":call func ()". Not good, but required for
5054 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005055 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005056 if (*startarg != '(')
5057 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005058 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059 goto end;
5060 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005061 if (in_vim9script() && startarg > arg)
5062 {
5063 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5064 goto end;
5065 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005066
5067 /*
5068 * When skipping, evaluate the function once, to find the end of the
5069 * arguments.
5070 * When the function takes a range, this is discovered after the first
5071 * call, and the loop is broken.
5072 */
5073 if (eap->skip)
5074 {
5075 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005076 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005077 }
5078 else
5079 lnum = eap->line1;
5080 for ( ; lnum <= eap->line2; ++lnum)
5081 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005082 funcexe_T funcexe;
5083
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005084 if (!eap->skip && eap->addr_count > 0)
5085 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005086 if (lnum > curbuf->b_ml.ml_line_count)
5087 {
5088 // If the function deleted lines or switched to another buffer
5089 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005090 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005091 break;
5092 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005093 curwin->w_cursor.lnum = lnum;
5094 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005095 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005096 }
5097 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005098
Bram Moolenaara80faa82020-04-12 19:37:17 +02005099 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005100 funcexe.firstline = eap->line1;
5101 funcexe.lastline = eap->line2;
5102 funcexe.doesrange = &doesrange;
5103 funcexe.evaluate = !eap->skip;
5104 funcexe.partial = partial;
5105 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005106 funcexe.check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005107 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005108 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005109 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110 {
5111 failed = TRUE;
5112 break;
5113 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005114 if (has_watchexpr())
5115 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005116
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005117 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005118 if (handle_subscript(&arg, &rettv,
5119 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005120 {
5121 failed = TRUE;
5122 break;
5123 }
5124
5125 clear_tv(&rettv);
5126 if (doesrange || eap->skip)
5127 break;
5128
Bram Moolenaare38eab22019-12-05 21:50:01 +01005129 // Stop when immediately aborting on error, or when an interrupt
5130 // occurred or an exception was thrown but not caught.
5131 // get_func_tv() returned OK, so that the check for trailing
5132 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005133 if (aborting())
5134 break;
5135 }
5136 if (eap->skip)
5137 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005138 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005139
Bram Moolenaar1d341892021-09-18 15:25:52 +02005140 // When inside :try we need to check for following "| catch" or "| endtry".
5141 // Not when there was an error, but do check if an exception was thrown.
5142 if ((!aborting() || did_throw)
5143 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005144 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005145 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005146 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005147 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005148 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005149 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005150 {
5151 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005152 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005153 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005154 }
5155 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005156 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005157 }
5158
5159end:
5160 dict_unref(fudi.fd_dict);
5161 vim_free(tofree);
5162}
5163
5164/*
5165 * Return from a function. Possibly makes the return pending. Also called
5166 * for a pending return at the ":endtry" or after returning from an extra
5167 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5168 * when called due to a ":return" command. "rettv" may point to a typval_T
5169 * with the return rettv. Returns TRUE when the return can be carried out,
5170 * FALSE when the return gets pending.
5171 */
5172 int
5173do_return(
5174 exarg_T *eap,
5175 int reanimate,
5176 int is_cmd,
5177 void *rettv)
5178{
5179 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005180 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181
5182 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005183 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005184 current_funccal->returned = FALSE;
5185
5186 /*
5187 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5188 * not in its finally clause (which then is to be executed next) is found.
5189 * In this case, make the ":return" pending for execution at the ":endtry".
5190 * Otherwise, return normally.
5191 */
5192 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5193 if (idx >= 0)
5194 {
5195 cstack->cs_pending[idx] = CSTP_RETURN;
5196
5197 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005198 // A pending return again gets pending. "rettv" points to an
5199 // allocated variable with the rettv of the original ":return"'s
5200 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 cstack->cs_rettv[idx] = rettv;
5202 else
5203 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005204 // When undoing a return in order to make it pending, get the stored
5205 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206 if (reanimate)
5207 rettv = current_funccal->rettv;
5208
5209 if (rettv != NULL)
5210 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005211 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5213 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5214 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005215 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 }
5217 else
5218 cstack->cs_rettv[idx] = NULL;
5219
5220 if (reanimate)
5221 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005222 // The pending return value could be overwritten by a ":return"
5223 // without argument in a finally clause; reset the default
5224 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005225 current_funccal->rettv->v_type = VAR_NUMBER;
5226 current_funccal->rettv->vval.v_number = 0;
5227 }
5228 }
5229 report_make_pending(CSTP_RETURN, rettv);
5230 }
5231 else
5232 {
5233 current_funccal->returned = TRUE;
5234
Bram Moolenaare38eab22019-12-05 21:50:01 +01005235 // If the return is carried out now, store the return value. For
5236 // a return immediately after reanimation, the value is already
5237 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005238 if (!reanimate && rettv != NULL)
5239 {
5240 clear_tv(current_funccal->rettv);
5241 *current_funccal->rettv = *(typval_T *)rettv;
5242 if (!is_cmd)
5243 vim_free(rettv);
5244 }
5245 }
5246
5247 return idx < 0;
5248}
5249
5250/*
5251 * Free the variable with a pending return value.
5252 */
5253 void
5254discard_pending_return(void *rettv)
5255{
5256 free_tv((typval_T *)rettv);
5257}
5258
5259/*
5260 * Generate a return command for producing the value of "rettv". The result
5261 * is an allocated string. Used by report_pending() for verbose messages.
5262 */
5263 char_u *
5264get_return_cmd(void *rettv)
5265{
5266 char_u *s = NULL;
5267 char_u *tofree = NULL;
5268 char_u numbuf[NUMBUFLEN];
5269
5270 if (rettv != NULL)
5271 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5272 if (s == NULL)
5273 s = (char_u *)"";
5274
5275 STRCPY(IObuff, ":return ");
5276 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5277 if (STRLEN(s) + 8 >= IOSIZE)
5278 STRCPY(IObuff + IOSIZE - 4, "...");
5279 vim_free(tofree);
5280 return vim_strsave(IObuff);
5281}
5282
5283/*
5284 * Get next function line.
5285 * Called by do_cmdline() to get the next line.
5286 * Returns allocated string, or NULL for end of function.
5287 */
5288 char_u *
5289get_func_line(
5290 int c UNUSED,
5291 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005292 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005293 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294{
5295 funccall_T *fcp = (funccall_T *)cookie;
5296 ufunc_T *fp = fcp->func;
5297 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005298 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005299
Bram Moolenaare38eab22019-12-05 21:50:01 +01005300 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005301 if (fcp->dbg_tick != debug_tick)
5302 {
5303 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005304 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005305 fcp->dbg_tick = debug_tick;
5306 }
5307#ifdef FEAT_PROFILE
5308 if (do_profiling == PROF_YES)
5309 func_line_end(cookie);
5310#endif
5311
5312 gap = &fp->uf_lines;
5313 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5314 || fcp->returned)
5315 retval = NULL;
5316 else
5317 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005318 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319 while (fcp->linenr < gap->ga_len
5320 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5321 ++fcp->linenr;
5322 if (fcp->linenr >= gap->ga_len)
5323 retval = NULL;
5324 else
5325 {
5326 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005327 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005328#ifdef FEAT_PROFILE
5329 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005330 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005331#endif
5332 }
5333 }
5334
Bram Moolenaare38eab22019-12-05 21:50:01 +01005335 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005336 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005338 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005339 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005340 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005341 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342 fcp->dbg_tick = debug_tick;
5343 }
5344
5345 return retval;
5346}
5347
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348/*
5349 * Return TRUE if the currently active function should be ended, because a
5350 * return was encountered or an error occurred. Used inside a ":while".
5351 */
5352 int
5353func_has_ended(void *cookie)
5354{
5355 funccall_T *fcp = (funccall_T *)cookie;
5356
Bram Moolenaare38eab22019-12-05 21:50:01 +01005357 // Ignore the "abort" flag if the abortion behavior has been changed due to
5358 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5360 || fcp->returned);
5361}
5362
5363/*
5364 * return TRUE if cookie indicates a function which "abort"s on errors.
5365 */
5366 int
5367func_has_abort(
5368 void *cookie)
5369{
5370 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5371}
5372
5373
5374/*
5375 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5376 * Don't do this when "Func" is already a partial that was bound
5377 * explicitly (pt_auto is FALSE).
5378 * Changes "rettv" in-place.
5379 * Returns the updated "selfdict_in".
5380 */
5381 dict_T *
5382make_partial(dict_T *selfdict_in, typval_T *rettv)
5383{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005384 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385 char_u *tofree = NULL;
5386 ufunc_T *fp;
5387 char_u fname_buf[FLEN_FIXED + 1];
5388 int error;
5389 dict_T *selfdict = selfdict_in;
5390
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005391 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5392 fp = rettv->vval.v_partial->pt_func;
5393 else
5394 {
5395 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5396 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005397 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005398 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005399 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005400 vim_free(tofree);
5401 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005402
5403 if (fp != NULL && (fp->uf_flags & FC_DICT))
5404 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005405 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005406
5407 if (pt != NULL)
5408 {
5409 pt->pt_refcount = 1;
5410 pt->pt_dict = selfdict;
5411 pt->pt_auto = TRUE;
5412 selfdict = NULL;
5413 if (rettv->v_type == VAR_FUNC)
5414 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005415 // Just a function: Take over the function name and use
5416 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005417 pt->pt_name = rettv->vval.v_string;
5418 }
5419 else
5420 {
5421 partial_T *ret_pt = rettv->vval.v_partial;
5422 int i;
5423
Bram Moolenaare38eab22019-12-05 21:50:01 +01005424 // Partial: copy the function name, use selfdict and copy
5425 // args. Can't take over name or args, the partial might
5426 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005427 if (ret_pt->pt_name != NULL)
5428 {
5429 pt->pt_name = vim_strsave(ret_pt->pt_name);
5430 func_ref(pt->pt_name);
5431 }
5432 else
5433 {
5434 pt->pt_func = ret_pt->pt_func;
5435 func_ptr_ref(pt->pt_func);
5436 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005437 if (ret_pt->pt_argc > 0)
5438 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005439 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005440 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005441 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 pt->pt_argc = 0;
5443 else
5444 {
5445 pt->pt_argc = ret_pt->pt_argc;
5446 for (i = 0; i < pt->pt_argc; i++)
5447 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5448 }
5449 }
5450 partial_unref(ret_pt);
5451 }
5452 rettv->v_type = VAR_PARTIAL;
5453 rettv->vval.v_partial = pt;
5454 }
5455 }
5456 return selfdict;
5457}
5458
5459/*
5460 * Return the name of the executed function.
5461 */
5462 char_u *
5463func_name(void *cookie)
5464{
5465 return ((funccall_T *)cookie)->func->uf_name;
5466}
5467
5468/*
5469 * Return the address holding the next breakpoint line for a funccall cookie.
5470 */
5471 linenr_T *
5472func_breakpoint(void *cookie)
5473{
5474 return &((funccall_T *)cookie)->breakpoint;
5475}
5476
5477/*
5478 * Return the address holding the debug tick for a funccall cookie.
5479 */
5480 int *
5481func_dbg_tick(void *cookie)
5482{
5483 return &((funccall_T *)cookie)->dbg_tick;
5484}
5485
5486/*
5487 * Return the nesting level for a funccall cookie.
5488 */
5489 int
5490func_level(void *cookie)
5491{
5492 return ((funccall_T *)cookie)->level;
5493}
5494
5495/*
5496 * Return TRUE when a function was ended by a ":return" command.
5497 */
5498 int
5499current_func_returned(void)
5500{
5501 return current_funccal->returned;
5502}
5503
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504 int
5505free_unref_funccal(int copyID, int testing)
5506{
5507 int did_free = FALSE;
5508 int did_free_funccal = FALSE;
5509 funccall_T *fc, **pfc;
5510
5511 for (pfc = &previous_funccal; *pfc != NULL; )
5512 {
5513 if (can_free_funccal(*pfc, copyID))
5514 {
5515 fc = *pfc;
5516 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005517 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005518 did_free = TRUE;
5519 did_free_funccal = TRUE;
5520 }
5521 else
5522 pfc = &(*pfc)->caller;
5523 }
5524 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005525 // When a funccal was freed some more items might be garbage
5526 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005527 (void)garbage_collect(testing);
5528
5529 return did_free;
5530}
5531
5532/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005533 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005534 */
5535 static funccall_T *
5536get_funccal(void)
5537{
5538 int i;
5539 funccall_T *funccal;
5540 funccall_T *temp_funccal;
5541
5542 funccal = current_funccal;
5543 if (debug_backtrace_level > 0)
5544 {
5545 for (i = 0; i < debug_backtrace_level; i++)
5546 {
5547 temp_funccal = funccal->caller;
5548 if (temp_funccal)
5549 funccal = temp_funccal;
5550 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005551 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005552 debug_backtrace_level = i;
5553 }
5554 }
5555 return funccal;
5556}
5557
5558/*
5559 * Return the hashtable used for local variables in the current funccal.
5560 * Return NULL if there is no current funccal.
5561 */
5562 hashtab_T *
5563get_funccal_local_ht()
5564{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005565 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005566 return NULL;
5567 return &get_funccal()->l_vars.dv_hashtab;
5568}
5569
5570/*
5571 * Return the l: scope variable.
5572 * Return NULL if there is no current funccal.
5573 */
5574 dictitem_T *
5575get_funccal_local_var()
5576{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005577 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005578 return NULL;
5579 return &get_funccal()->l_vars_var;
5580}
5581
5582/*
5583 * Return the hashtable used for argument in the current funccal.
5584 * Return NULL if there is no current funccal.
5585 */
5586 hashtab_T *
5587get_funccal_args_ht()
5588{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005589 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005590 return NULL;
5591 return &get_funccal()->l_avars.dv_hashtab;
5592}
5593
5594/*
5595 * Return the a: scope variable.
5596 * Return NULL if there is no current funccal.
5597 */
5598 dictitem_T *
5599get_funccal_args_var()
5600{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005601 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005602 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005603 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005604}
5605
5606/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005607 * List function variables, if there is a function.
5608 */
5609 void
5610list_func_vars(int *first)
5611{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005612 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005613 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005614 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005615}
5616
5617/*
5618 * If "ht" is the hashtable for local variables in the current funccal, return
5619 * the dict that contains it.
5620 * Otherwise return NULL.
5621 */
5622 dict_T *
5623get_current_funccal_dict(hashtab_T *ht)
5624{
5625 if (current_funccal != NULL
5626 && ht == &current_funccal->l_vars.dv_hashtab)
5627 return &current_funccal->l_vars;
5628 return NULL;
5629}
5630
5631/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005632 * Search hashitem in parent scope.
5633 */
5634 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005635find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005636{
5637 funccall_T *old_current_funccal = current_funccal;
5638 hashtab_T *ht;
5639 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005640 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005641
5642 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5643 return NULL;
5644
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005645 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005646 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005647 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005648 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005649 ht = find_var_ht(name, &varname);
5650 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005651 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005652 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005653 if (!HASHITEM_EMPTY(hi))
5654 {
5655 *pht = ht;
5656 break;
5657 }
5658 }
5659 if (current_funccal == current_funccal->func->uf_scoped)
5660 break;
5661 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005662 }
5663 current_funccal = old_current_funccal;
5664
5665 return hi;
5666}
5667
5668/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005669 * Search variable in parent scope.
5670 */
5671 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005672find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005673{
5674 dictitem_T *v = NULL;
5675 funccall_T *old_current_funccal = current_funccal;
5676 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005677 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005678
5679 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5680 return NULL;
5681
Bram Moolenaare38eab22019-12-05 21:50:01 +01005682 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005683 current_funccal = current_funccal->func->uf_scoped;
5684 while (current_funccal)
5685 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005686 ht = find_var_ht(name, &varname);
5687 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005688 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005689 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005690 if (v != NULL)
5691 break;
5692 }
5693 if (current_funccal == current_funccal->func->uf_scoped)
5694 break;
5695 current_funccal = current_funccal->func->uf_scoped;
5696 }
5697 current_funccal = old_current_funccal;
5698
5699 return v;
5700}
5701
5702/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005703 * Set "copyID + 1" in previous_funccal and callers.
5704 */
5705 int
5706set_ref_in_previous_funccal(int copyID)
5707{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005708 funccall_T *fc;
5709
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005710 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005711 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005712 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005713 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5714 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5715 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5716 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005717 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005718 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005719}
5720
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005721 static int
5722set_ref_in_funccal(funccall_T *fc, int copyID)
5723{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005724 if (fc->fc_copyID != copyID)
5725 {
5726 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005727 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5728 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5729 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5730 || set_ref_in_func(NULL, fc->func, copyID))
5731 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005732 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005733 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005734}
5735
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005736/*
5737 * Set "copyID" in all local vars and arguments in the call stack.
5738 */
5739 int
5740set_ref_in_call_stack(int copyID)
5741{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005742 funccall_T *fc;
5743 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005744
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005745 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5746 if (set_ref_in_funccal(fc, copyID))
5747 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005748
5749 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005750 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5751 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5752 if (set_ref_in_funccal(fc, copyID))
5753 return TRUE;
5754 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005755}
5756
5757/*
5758 * Set "copyID" in all functions available by name.
5759 */
5760 int
5761set_ref_in_functions(int copyID)
5762{
5763 int todo;
5764 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005765 ufunc_T *fp;
5766
5767 todo = (int)func_hashtab.ht_used;
5768 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005769 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005770 if (!HASHITEM_EMPTY(hi))
5771 {
5772 --todo;
5773 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005774 if (!func_name_refcount(fp->uf_name)
5775 && set_ref_in_func(NULL, fp, copyID))
5776 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005777 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005778 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005779 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005780}
5781
5782/*
5783 * Set "copyID" in all function arguments.
5784 */
5785 int
5786set_ref_in_func_args(int copyID)
5787{
5788 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005789
5790 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005791 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5792 copyID, NULL, NULL))
5793 return TRUE;
5794 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005795}
5796
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005797/*
5798 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005799 * Returns TRUE if setting references failed somehow.
5800 */
5801 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005802set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005803{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005804 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005805 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005806 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005807 char_u fname_buf[FLEN_FIXED + 1];
5808 char_u *tofree = NULL;
5809 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005810 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005811
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005812 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005813 return FALSE;
5814
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005815 if (fp_in == NULL)
5816 {
5817 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005818 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005819 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005820 if (fp != NULL)
5821 {
5822 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005823 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005824 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005825
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005826 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005827 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005828}
5829
Bram Moolenaare38eab22019-12-05 21:50:01 +01005830#endif // FEAT_EVAL