blob: 79e711c0a55b889e477fe5c23e62b442a0a5a809 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
526 fp->uf_flags = FC_CFUNC;
527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
617 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200618 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100619 * "newlines" must already have been initialized.
620 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
621 */
622 static int
623get_function_body(
624 exarg_T *eap,
625 garray_T *newlines,
626 char_u *line_arg_in,
627 char_u **line_to_free)
628{
629 linenr_T sourcing_lnum_top = SOURCING_LNUM;
630 linenr_T sourcing_lnum_off;
631 int saved_wait_return = need_wait_return;
632 char_u *line_arg = line_arg_in;
633 int vim9_function = eap->cmdidx == CMD_def
634 || eap->cmdidx == CMD_block;
635#define MAX_FUNC_NESTING 50
636 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200637 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100638 int nesting = 0;
639 getline_opt_T getline_options;
640 int indent = 2;
641 char_u *skip_until = NULL;
642 int ret = FAIL;
643 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200644 int heredoc_concat_len = 0;
645 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 char_u *heredoc_trimmed = NULL;
647
Bram Moolenaar20677332021-06-06 17:02:53 +0200648 ga_init2(&heredoc_ga, 1, 500);
649
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100650 // Detect having skipped over comment lines to find the return
651 // type. Add NULL lines to keep the line count correct.
652 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
653 if (SOURCING_LNUM < sourcing_lnum_off)
654 {
655 sourcing_lnum_off -= SOURCING_LNUM;
656 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
657 goto theend;
658 while (sourcing_lnum_off-- > 0)
659 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
660 }
661
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200662 nesting_def[0] = vim9_function;
663 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100664 getline_options = vim9_function
665 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
666 for (;;)
667 {
668 char_u *theline;
669 char_u *p;
670 char_u *arg;
671
672 if (KeyTyped)
673 {
674 msg_scroll = TRUE;
675 saved_wait_return = FALSE;
676 }
677 need_wait_return = FALSE;
678
679 if (line_arg != NULL)
680 {
681 // Use eap->arg, split up in parts by line breaks.
682 theline = line_arg;
683 p = vim_strchr(theline, '\n');
684 if (p == NULL)
685 line_arg += STRLEN(line_arg);
686 else
687 {
688 *p = NUL;
689 line_arg = p + 1;
690 }
691 }
692 else
693 {
694 vim_free(*line_to_free);
695 if (eap->getline == NULL)
696 theline = getcmdline(':', 0L, indent, getline_options);
697 else
698 theline = eap->getline(':', eap->cookie, indent,
699 getline_options);
700 *line_to_free = theline;
701 }
702 if (KeyTyped)
703 lines_left = Rows - 1;
704 if (theline == NULL)
705 {
706 // Use the start of the function for the line number.
707 SOURCING_LNUM = sourcing_lnum_top;
708 if (skip_until != NULL)
709 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200710 else if (nesting_inline[nesting])
711 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100712 else if (eap->cmdidx == CMD_def)
713 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100714 else
715 emsg(_("E126: Missing :endfunction"));
716 goto theend;
717 }
718
719 // Detect line continuation: SOURCING_LNUM increased more than one.
720 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
721 if (SOURCING_LNUM < sourcing_lnum_off)
722 sourcing_lnum_off -= SOURCING_LNUM;
723 else
724 sourcing_lnum_off = 0;
725
726 if (skip_until != NULL)
727 {
728 // Don't check for ":endfunc"/":enddef" between
729 // * ":append" and "."
730 // * ":python <<EOF" and "EOF"
731 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
732 if (heredoc_trimmed == NULL
733 || (is_heredoc && skipwhite(theline) == theline)
734 || STRNCMP(theline, heredoc_trimmed,
735 STRLEN(heredoc_trimmed)) == 0)
736 {
737 if (heredoc_trimmed == NULL)
738 p = theline;
739 else if (is_heredoc)
740 p = skipwhite(theline) == theline
741 ? theline : theline + STRLEN(heredoc_trimmed);
742 else
743 p = theline + STRLEN(heredoc_trimmed);
744 if (STRCMP(p, skip_until) == 0)
745 {
746 VIM_CLEAR(skip_until);
747 VIM_CLEAR(heredoc_trimmed);
748 getline_options = vim9_function
749 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
750 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200751
752 if (heredoc_concat_len > 0)
753 {
754 // Replace the starting line with all the concatenated
755 // lines.
756 ga_concat(&heredoc_ga, theline);
757 vim_free(((char_u **)(newlines->ga_data))[
758 heredoc_concat_len - 1]);
759 ((char_u **)(newlines->ga_data))[
760 heredoc_concat_len - 1] = heredoc_ga.ga_data;
761 ga_init(&heredoc_ga);
762 heredoc_concat_len = 0;
763 theline += STRLEN(theline); // skip the "EOF"
764 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100765 }
766 }
767 }
768 else
769 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200770 int c;
771 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100772
773 // skip ':' and blanks
774 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
775 ;
776
777 // Check for "endfunction", "enddef" or "}".
778 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200779 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100780 ? *p == '}'
781 : (checkforcmd(&p, nesting_def[nesting]
782 ? "enddef" : "endfunction", 4)
783 && *p != ':'))
784 {
785 if (nesting-- == 0)
786 {
787 char_u *nextcmd = NULL;
788
789 if (*p == '|' || *p == '}')
790 nextcmd = p + 1;
791 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
792 nextcmd = line_arg;
793 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100794 && (vim9_function || p_verbose > 0))
795 {
796 if (eap->cmdidx == CMD_def)
797 semsg(_(e_text_found_after_enddef_str), p);
798 else
799 give_warning2((char_u *)
800 _("W22: Text found after :endfunction: %s"),
801 p, TRUE);
802 }
803 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100804 {
805 // Another command follows. If the line came from "eap"
806 // we can simply point into it, otherwise we need to
807 // change "eap->cmdlinep".
808 eap->nextcmd = nextcmd;
809 if (*line_to_free != NULL)
810 {
811 vim_free(*eap->cmdlinep);
812 *eap->cmdlinep = *line_to_free;
813 *line_to_free = NULL;
814 }
815 }
816 break;
817 }
818 }
819
820 // Check for mismatched "endfunc" or "enddef".
821 // We don't check for "def" inside "func" thus we also can't check
822 // for "enddef".
823 // We continue to find the end of the function, although we might
824 // not find it.
825 else if (nesting_def[nesting])
826 {
827 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
828 emsg(_(e_mismatched_endfunction));
829 }
830 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
831 emsg(_(e_mismatched_enddef));
832
833 // Increase indent inside "if", "while", "for" and "try", decrease
834 // at "end".
835 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
836 indent -= 2;
837 else if (STRNCMP(p, "if", 2) == 0
838 || STRNCMP(p, "wh", 2) == 0
839 || STRNCMP(p, "for", 3) == 0
840 || STRNCMP(p, "try", 3) == 0)
841 indent += 2;
842
843 // Check for defining a function inside this function.
844 // Only recognize "def" inside "def", not inside "function",
845 // For backwards compatibility, see Test_function_python().
846 c = *p;
847 if (is_function_cmd(&p)
848 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
849 {
850 if (*p == '!')
851 p = skipwhite(p + 1);
852 p += eval_fname_script(p);
853 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
854 NULL, NULL));
855 if (*skipwhite(p) == '(')
856 {
857 if (nesting == MAX_FUNC_NESTING - 1)
858 emsg(_(e_function_nesting_too_deep));
859 else
860 {
861 ++nesting;
862 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200863 nesting_inline[nesting] = FALSE;
864 indent += 2;
865 }
866 }
867 }
868
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200869 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200870 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200871 // Not a comment line: check for nested inline function.
872 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200873 while (end > p && VIM_ISWHITE(*end))
874 --end;
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200875 if (end > p && *end == '{')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200876 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200877 --end;
878 while (end > p && VIM_ISWHITE(*end))
879 --end;
880 if (end > p + 2 && end[-1] == '=' && end[0] == '>')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200881 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200882 // found trailing "=> {", start of an inline function
883 if (nesting == MAX_FUNC_NESTING - 1)
884 emsg(_(e_function_nesting_too_deep));
885 else
886 {
887 ++nesting;
888 nesting_def[nesting] = TRUE;
889 nesting_inline[nesting] = TRUE;
890 indent += 2;
891 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100892 }
893 }
894 }
895
896 // Check for ":append", ":change", ":insert". Not for :def.
897 p = skip_range(p, FALSE, NULL);
898 if (!vim9_function
899 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
900 || (p[0] == 'c'
901 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
902 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
903 && (STRNCMP(&p[3], "nge", 3) != 0
904 || !ASCII_ISALPHA(p[6])))))))
905 || (p[0] == 'i'
906 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
907 && (!ASCII_ISALPHA(p[2])
908 || (p[2] == 's'
909 && (!ASCII_ISALPHA(p[3])
910 || p[3] == 'e'))))))))
911 skip_until = vim_strsave((char_u *)".");
912
913 // Check for ":python <<EOF", ":tcl <<EOF", etc.
914 arg = skipwhite(skiptowhite(p));
915 if (arg[0] == '<' && arg[1] =='<'
916 && ((p[0] == 'p' && p[1] == 'y'
917 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
918 || ((p[2] == '3' || p[2] == 'x')
919 && !ASCII_ISALPHA(p[3]))))
920 || (p[0] == 'p' && p[1] == 'e'
921 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
922 || (p[0] == 't' && p[1] == 'c'
923 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
924 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
925 && !ASCII_ISALPHA(p[3]))
926 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
927 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
928 || (p[0] == 'm' && p[1] == 'z'
929 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
930 ))
931 {
932 // ":python <<" continues until a dot, like ":append"
933 p = skipwhite(arg + 2);
934 if (STRNCMP(p, "trim", 4) == 0)
935 {
936 // Ignore leading white space.
937 p = skipwhite(p + 4);
938 heredoc_trimmed = vim_strnsave(theline,
939 skipwhite(theline) - theline);
940 }
941 if (*p == NUL)
942 skip_until = vim_strsave((char_u *)".");
943 else
944 skip_until = vim_strnsave(p, skiptowhite(p) - p);
945 getline_options = GETLINE_NONE;
946 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200947 if (eap->cmdidx == CMD_def)
948 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100949 }
950
951 // Check for ":cmd v =<< [trim] EOF"
952 // and ":cmd [a, b] =<< [trim] EOF"
953 // and "lines =<< [trim] EOF" for Vim9
954 // Where "cmd" can be "let", "var", "final" or "const".
955 arg = skipwhite(skiptowhite(p));
956 if (*arg == '[')
957 arg = vim_strchr(arg, ']');
958 if (arg != NULL)
959 {
960 int found = (eap->cmdidx == CMD_def && arg[0] == '='
961 && arg[1] == '<' && arg[2] =='<');
962
963 if (!found)
964 // skip over the argument after "cmd"
965 arg = skipwhite(skiptowhite(arg));
966 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
967 && (checkforcmd(&p, "let", 2)
968 || checkforcmd(&p, "var", 3)
969 || checkforcmd(&p, "final", 5)
970 || checkforcmd(&p, "const", 5))))
971 {
972 p = skipwhite(arg + 3);
973 if (STRNCMP(p, "trim", 4) == 0)
974 {
975 // Ignore leading white space.
976 p = skipwhite(p + 4);
977 heredoc_trimmed = vim_strnsave(theline,
978 skipwhite(theline) - theline);
979 }
980 skip_until = vim_strnsave(p, skiptowhite(p) - p);
981 getline_options = GETLINE_NONE;
982 is_heredoc = TRUE;
983 }
984 }
985 }
986
987 // Add the line to the function.
988 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
989 goto theend;
990
Bram Moolenaar20677332021-06-06 17:02:53 +0200991 if (heredoc_concat_len > 0)
992 {
993 // For a :def function "python << EOF" concatenats all the lines,
994 // to be used for the instruction later.
995 ga_concat(&heredoc_ga, theline);
996 ga_concat(&heredoc_ga, (char_u *)"\n");
997 p = vim_strsave((char_u *)"");
998 }
999 else
1000 {
1001 // Copy the line to newly allocated memory. get_one_sourceline()
1002 // allocates 250 bytes per line, this saves 80% on average. The
1003 // cost is an extra alloc/free.
1004 p = vim_strsave(theline);
1005 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001006 if (p == NULL)
1007 goto theend;
1008 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1009
1010 // Add NULL lines for continuation lines, so that the line count is
1011 // equal to the index in the growarray.
1012 while (sourcing_lnum_off-- > 0)
1013 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1014
1015 // Check for end of eap->arg.
1016 if (line_arg != NULL && *line_arg == NUL)
1017 line_arg = NULL;
1018 }
1019
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001020 // Return OK when no error was detected.
1021 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001022 ret = OK;
1023
1024theend:
1025 vim_free(skip_until);
1026 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001027 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001028 need_wait_return |= saved_wait_return;
1029 return ret;
1030}
1031
1032/*
1033 * Handle the body of a lambda. *arg points to the "{", process statements
1034 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001035 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001036 * When successful "rettv" is set to a funcref.
1037 */
1038 static int
1039lambda_function_body(
1040 char_u **arg,
1041 typval_T *rettv,
1042 evalarg_T *evalarg,
1043 garray_T *newargs,
1044 garray_T *argtypes,
1045 int varargs,
1046 garray_T *default_args,
1047 char_u *ret_type)
1048{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001049 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001050 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001051 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001052 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001053 exarg_T eap;
1054 garray_T newlines;
1055 char_u *cmdline = NULL;
1056 int ret = FAIL;
1057 char_u *line_to_free = NULL;
1058 partial_T *pt;
1059 char_u *name;
1060 int lnum_save = -1;
1061 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1062
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001063 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1064 {
1065 semsg(_(e_trailing_arg), *arg + 1);
1066 return FAIL;
1067 }
1068
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001069 CLEAR_FIELD(eap);
1070 eap.cmdidx = CMD_block;
1071 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001072 eap.cmdlinep = &cmdline;
1073 eap.skip = !evaluate;
1074 if (evalarg->eval_cctx != NULL)
1075 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1076 else
1077 {
1078 eap.getline = evalarg->eval_getline;
1079 eap.cookie = evalarg->eval_cookie;
1080 }
1081
1082 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1083 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001084 {
1085 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001086 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001087 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001088
1089 // When inside a lambda must add the function lines to evalarg.eval_ga.
1090 evalarg->eval_break_count += newlines.ga_len;
1091 if (gap->ga_itemsize > 0)
1092 {
1093 int idx;
1094 char_u *last;
1095 size_t plen;
1096 char_u *pnl;
1097
1098 for (idx = 0; idx < newlines.ga_len; ++idx)
1099 {
1100 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1101
Bram Moolenaarecb66452021-05-18 15:09:18 +02001102 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001103 goto erret;
1104
1105 // Going to concatenate the lines after parsing. For an empty or
1106 // comment line use an empty string.
1107 // Insert NL characters at the start of each line, the string will
1108 // be split again later in .get_lambda_tv().
1109 if (*p == NUL || vim9_comment_start(p))
1110 p = (char_u *)"";
1111 plen = STRLEN(p);
1112 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1113 if (pnl != NULL)
1114 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001115 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1116 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001117 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001118 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001119 goto erret;
1120 if (cmdline != NULL)
1121 // more is following after the "}", which was skipped
1122 last = cmdline;
1123 else
1124 // nothing is following the "}"
1125 last = (char_u *)"}";
1126 plen = STRLEN(last);
1127 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1128 if (pnl != NULL)
1129 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001130 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1131 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001132 }
1133
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001134 if (cmdline != NULL)
1135 {
1136 // Something comes after the "}".
1137 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001138
1139 // "arg" points into cmdline, need to keep the line and free it later.
1140 vim_free(evalarg->eval_tofree_cmdline);
1141 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 }
1143 else
1144 *arg = (char_u *)"";
1145
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001146 if (!evaluate)
1147 {
1148 ret = OK;
1149 goto erret;
1150 }
1151
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001152 name = get_lambda_name();
1153 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1154 if (ufunc == NULL)
1155 goto erret;
1156 set_ufunc_name(ufunc, name);
1157 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001158 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001159 ufunc->uf_refcount = 1;
1160 ufunc->uf_args = *newargs;
1161 newargs->ga_data = NULL;
1162 ufunc->uf_def_args = *default_args;
1163 default_args->ga_data = NULL;
1164 ufunc->uf_func_type = &t_func_any;
1165
1166 // error messages are for the first function line
1167 lnum_save = SOURCING_LNUM;
1168 SOURCING_LNUM = sourcing_lnum_top;
1169
1170 // parse argument types
1171 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1172 {
1173 SOURCING_LNUM = lnum_save;
1174 goto erret;
1175 }
1176
1177 // parse the return type, if any
1178 if (parse_return_type(ufunc, ret_type) == FAIL)
1179 goto erret;
1180
1181 pt = ALLOC_CLEAR_ONE(partial_T);
1182 if (pt == NULL)
1183 goto erret;
1184 pt->pt_func = ufunc;
1185 pt->pt_refcount = 1;
1186
1187 ufunc->uf_lines = newlines;
1188 newlines.ga_data = NULL;
1189 if (sandbox)
1190 ufunc->uf_flags |= FC_SANDBOX;
1191 if (!ASCII_ISUPPER(*ufunc->uf_name))
1192 ufunc->uf_flags |= FC_VIM9;
1193 ufunc->uf_script_ctx = current_sctx;
1194 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1195 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1196 set_function_type(ufunc);
1197
1198 rettv->vval.v_partial = pt;
1199 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001200 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001201 ret = OK;
1202
1203erret:
1204 if (lnum_save >= 0)
1205 SOURCING_LNUM = lnum_save;
1206 vim_free(line_to_free);
1207 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001208 if (newargs != NULL)
1209 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001210 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001211 if (ufunc != NULL)
1212 {
1213 func_clear(ufunc, TRUE);
1214 func_free(ufunc, TRUE);
1215 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001216 return ret;
1217}
1218
1219/*
1220 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001221 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001222 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001223 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1224 */
1225 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001226get_lambda_tv(
1227 char_u **arg,
1228 typval_T *rettv,
1229 int types_optional,
1230 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001231{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001232 int evaluate = evalarg != NULL
1233 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001234 garray_T newargs;
1235 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001236 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001237 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001238 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001239 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001240 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001241 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001242 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001243 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001244 char_u *s;
1245 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001246 int *old_eval_lavars = eval_lavars_used;
1247 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001248 char_u *tofree1 = NULL;
1249 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001250 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001251 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001252 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001253
1254 if (equal_arrow && !in_vim9script())
1255 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256
1257 ga_init(&newargs);
1258 ga_init(&newlines);
1259
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001260 // First, check if this is really a lambda expression. "->" or "=>" must
1261 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001262 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001263 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001264 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001265 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001266 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001267 {
1268 if (types_optional)
1269 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001270 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001271 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001272
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001273 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001274 if (evaluate)
1275 pnewargs = &newargs;
1276 else
1277 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001278 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001279 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001280 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001281 &varargs, &default_args,
1282 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001283 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001284 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001285 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001286 {
1287 if (types_optional)
1288 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001289 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001290 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001291 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001292 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001294 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1295 if (ret_type != NULL)
1296 {
1297 ret_type = vim_strsave(ret_type);
1298 tofree2 = ret_type;
1299 }
1300
Bram Moolenaare38eab22019-12-05 21:50:01 +01001301 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001302 if (evaluate)
1303 eval_lavars_used = &eval_lavars;
1304
Bram Moolenaar65c44152020-12-24 15:14:01 +01001305 *arg = skipwhite_and_linebreak(*arg, evalarg);
1306
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001307 // Recognize "{" as the start of a function body.
1308 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001309 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001310 if (evalarg == NULL)
1311 // cannot happen?
1312 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001313 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1314 types_optional ? &argtypes : NULL, varargs,
1315 &default_args, ret_type) == FAIL)
1316 goto errret;
1317 goto theend;
1318 }
1319 if (default_args.ga_len > 0)
1320 {
1321 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001322 goto errret;
1323 }
1324
Bram Moolenaare38eab22019-12-05 21:50:01 +01001325 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001326 start = *arg;
1327 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001328 if (ret == FAIL)
1329 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001330 if (evalarg != NULL)
1331 {
1332 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001333 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001334 evalarg->eval_tofree = NULL;
1335 }
1336
Bram Moolenaar65c44152020-12-24 15:14:01 +01001337 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001338 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001339 *arg = skipwhite_and_linebreak(*arg, evalarg);
1340 if (**arg != '}')
1341 {
1342 semsg(_("E451: Expected }: %s"), *arg);
1343 goto errret;
1344 }
1345 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347
1348 if (evaluate)
1349 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001350 int len;
1351 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001352 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001353 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001354 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001355
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001356 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001357 if (fp == NULL)
1358 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001359 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001360 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001361 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001362 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001364 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1365 if (ga_grow(&newlines, 1) == FAIL)
1366 goto errret;
1367
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001368 // If there are line breaks, we need to split up the string.
1369 line_end = vim_strchr(start, '\n');
1370 if (line_end == NULL)
1371 line_end = end;
1372
1373 // Add "return " before the expression (or the first line).
1374 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001375 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001376 if (p == NULL)
1377 goto errret;
1378 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1379 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001380 vim_strncpy(p + 7, start, line_end - start);
1381
1382 if (line_end != end)
1383 {
1384 // Add more lines, split by line breaks. Thus is used when a
1385 // lambda with { cmds } is encountered.
1386 while (*line_end == '\n')
1387 {
1388 if (ga_grow(&newlines, 1) == FAIL)
1389 goto errret;
1390 start = line_end + 1;
1391 line_end = vim_strchr(start, '\n');
1392 if (line_end == NULL)
1393 line_end = end;
1394 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1395 vim_strnsave(start, line_end - start);
1396 }
1397 }
1398
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001399 if (strstr((char *)p + 7, "a:") == NULL)
1400 // No a: variables are used for sure.
1401 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001402
1403 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001404 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001405 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001406 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001407 if (types_optional)
1408 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001409 if (parse_argument_types(fp, &argtypes,
1410 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001411 goto errret;
1412 if (ret_type != NULL)
1413 {
1414 fp->uf_ret_type = parse_type(&ret_type,
1415 &fp->uf_type_list, TRUE);
1416 if (fp->uf_ret_type == NULL)
1417 goto errret;
1418 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001419 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001420 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001421 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001422
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001423 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001424 if (current_funccal != NULL && eval_lavars)
1425 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001426 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001427 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001428 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001430
1431#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 if (prof_def_func())
1433 func_do_profile(fp);
1434#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001435 if (sandbox)
1436 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001437 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001438 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1439 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001440 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001442 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001443 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001445 pt->pt_func = fp;
1446 pt->pt_refcount = 1;
1447 rettv->vval.v_partial = pt;
1448 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001449
1450 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001453theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001454 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001455 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001456 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001457 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001458 vim_free(tofree1);
1459 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001460 if (types_optional)
1461 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 return OK;
1463
1464errret:
1465 ga_clear_strings(&newargs);
1466 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001467 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001468 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001469 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001470 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001471 if (fp != NULL)
1472 vim_free(fp->uf_arg_types);
1473 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001475 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001476 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001477 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001478 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001479 vim_free(tofree1);
1480 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001481 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482 return FAIL;
1483}
1484
1485/*
1486 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1487 * name it contains, otherwise return "name".
1488 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1489 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001490 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1491 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 */
1493 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001494deref_func_name(
1495 char_u *name,
1496 int *lenp,
1497 partial_T **partialp,
1498 type_T **type,
1499 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500{
1501 dictitem_T *v;
1502 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001503 char_u *s = NULL;
1504 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505
1506 if (partialp != NULL)
1507 *partialp = NULL;
1508
1509 cc = name[*lenp];
1510 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001511
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001512 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001513 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001514 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001516 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001518 if (v->di_tv.vval.v_string == NULL)
1519 {
1520 *lenp = 0;
1521 return (char_u *)""; // just in case
1522 }
1523 s = v->di_tv.vval.v_string;
1524 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001527 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001529 partial_T *pt = v->di_tv.vval.v_partial;
1530
1531 if (pt == NULL)
1532 {
1533 *lenp = 0;
1534 return (char_u *)""; // just in case
1535 }
1536 if (partialp != NULL)
1537 *partialp = pt;
1538 s = partial_name(pt);
1539 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001541
1542 if (s != NULL)
1543 {
1544 if (type != NULL && ht == get_script_local_ht())
1545 {
Bram Moolenaarc967d572021-07-08 21:38:50 +02001546 svar_T *sv = find_typval_in_script(&v->di_tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001547
1548 if (sv != NULL)
1549 *type = sv->sv_type;
1550 }
1551 return s;
1552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 }
1554
1555 return name;
1556}
1557
1558/*
1559 * Give an error message with a function name. Handle <SNR> things.
1560 * "ermsg" is to be passed without translation, use N_() instead of _().
1561 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001562 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563emsg_funcname(char *ermsg, char_u *name)
1564{
1565 char_u *p;
1566
1567 if (*name == K_SPECIAL)
1568 p = concat_str((char_u *)"<SNR>", name + 3);
1569 else
1570 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001571 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 if (p != name)
1573 vim_free(p);
1574}
1575
1576/*
1577 * Allocate a variable for the result of a function.
1578 * Return OK or FAIL.
1579 */
1580 int
1581get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001582 char_u *name, // name of the function
1583 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001585 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001586 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001587 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588{
1589 char_u *argp;
1590 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001591 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1592 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001593 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594
1595 /*
1596 * Get the arguments.
1597 */
1598 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001599 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1600 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001602 // skip the '(' or ',' and possibly line breaks
1603 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1604
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001605 if (*argp == ')' || *argp == ',' || *argp == NUL)
1606 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001607 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 {
1609 ret = FAIL;
1610 break;
1611 }
1612 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001613 // The comma should come right after the argument, but this wasn't
1614 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001615 if (vim9script)
1616 {
1617 if (*argp != ',' && *skipwhite(argp) == ',')
1618 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001619 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001620 ret = FAIL;
1621 break;
1622 }
1623 }
1624 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001625 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626 if (*argp != ',')
1627 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001628 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1629 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001630 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001631 ret = FAIL;
1632 break;
1633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001635 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 if (*argp == ')')
1637 ++argp;
1638 else
1639 ret = FAIL;
1640
1641 if (ret == OK)
1642 {
1643 int i = 0;
1644
1645 if (get_vim_var_nr(VV_TESTING))
1646 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001647 // Prepare for calling test_garbagecollect_now(), need to know
1648 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 if (funcargs.ga_itemsize == 0)
1650 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1651 for (i = 0; i < argcount; ++i)
1652 if (ga_grow(&funcargs, 1) == OK)
1653 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1654 &argvars[i];
1655 }
1656
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001657 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658
1659 funcargs.ga_len -= i;
1660 }
1661 else if (!aborting())
1662 {
1663 if (argcount == MAX_FUNC_ARGS)
1664 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1665 else
1666 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1667 }
1668
1669 while (--argcount >= 0)
1670 clear_tv(&argvars[argcount]);
1671
Bram Moolenaar8294d492020-08-10 22:40:56 +02001672 if (in_vim9script())
1673 *arg = argp;
1674 else
1675 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001676 return ret;
1677}
1678
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679/*
1680 * Return TRUE if "p" starts with "<SID>" or "s:".
1681 * Only works if eval_fname_script() returned non-zero for "p"!
1682 */
1683 static int
1684eval_fname_sid(char_u *p)
1685{
1686 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1687}
1688
1689/*
1690 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1691 * Change <SNR>123_name() to K_SNR 123_name().
1692 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1693 * (slow).
1694 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001695 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1697{
1698 int llen;
1699 char_u *fname;
1700 int i;
1701
1702 llen = eval_fname_script(name);
1703 if (llen > 0)
1704 {
1705 fname_buf[0] = K_SPECIAL;
1706 fname_buf[1] = KS_EXTRA;
1707 fname_buf[2] = (int)KE_SNR;
1708 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001709 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001711 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001712 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713 else
1714 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001715 sprintf((char *)fname_buf + 3, "%ld_",
1716 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 i = (int)STRLEN(fname_buf);
1718 }
1719 }
1720 if (i + STRLEN(name + llen) < FLEN_FIXED)
1721 {
1722 STRCPY(fname_buf + i, name + llen);
1723 fname = fname_buf;
1724 }
1725 else
1726 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001727 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001729 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 else
1731 {
1732 *tofree = fname;
1733 mch_memmove(fname, fname_buf, (size_t)i);
1734 STRCPY(fname + i, name + llen);
1735 }
1736 }
1737 }
1738 else
1739 fname = name;
1740 return fname;
1741}
1742
1743/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001744 * Find a function "name" in script "sid".
1745 */
1746 static ufunc_T *
1747find_func_with_sid(char_u *name, int sid)
1748{
1749 hashitem_T *hi;
1750 char_u buffer[200];
1751
1752 buffer[0] = K_SPECIAL;
1753 buffer[1] = KS_EXTRA;
1754 buffer[2] = (int)KE_SNR;
1755 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1756 (long)sid, name);
1757 hi = hash_find(&func_hashtab, buffer);
1758 if (!HASHITEM_EMPTY(hi))
1759 return HI2UF(hi);
1760
1761 return NULL;
1762}
1763
1764/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001766 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 * Return NULL for unknown function.
1768 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001769 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001770find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771{
1772 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001773 ufunc_T *func;
1774 imported_T *imported;
1775
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001776 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001777 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001778 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001779 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001780 int find_script_local = in_vim9script()
1781 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001782
Bram Moolenaar95006e32020-08-29 17:47:08 +02001783 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001784 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001785 // Find script-local function before global one.
1786 func = find_func_with_sid(name, current_sctx.sc_sid);
1787 if (func != NULL)
1788 return func;
1789 }
1790
Bram Moolenaarefa94442020-08-08 22:16:00 +02001791 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001792 && name[1] == KS_EXTRA
1793 && name[2] == KE_SNR)
1794 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001795 // Caller changes s: to <SNR>99_name.
1796
1797 after_script = name + 3;
1798 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001799 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001800 ++after_script;
1801 else
1802 after_script = NULL;
1803 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001804 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001805 {
1806 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001807 if (after_script != NULL && sid != current_sctx.sc_sid)
1808 imported = find_imported_in_script(after_script, 0, sid);
1809 else
1810 imported = find_imported(after_script == NULL
1811 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001812 if (imported != NULL && imported->imp_funcname != NULL)
1813 {
1814 hi = hash_find(&func_hashtab, imported->imp_funcname);
1815 if (!HASHITEM_EMPTY(hi))
1816 return HI2UF(hi);
1817 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001818 }
1819 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820
Bram Moolenaara26b9702020-04-18 19:53:28 +02001821 hi = hash_find(&func_hashtab,
1822 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823 if (!HASHITEM_EMPTY(hi))
1824 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001825
1826 return NULL;
1827}
1828
1829/*
1830 * Find a function by name, return pointer to it in ufuncs.
1831 * "cctx" is passed in a :def function to find imported functions.
1832 * Return NULL for unknown or dead function.
1833 */
1834 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001835find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001836{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001837 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001838
1839 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1840 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 return NULL;
1842}
1843
1844/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001845 * Return TRUE if "ufunc" is a global function.
1846 */
1847 int
1848func_is_global(ufunc_T *ufunc)
1849{
1850 return ufunc->uf_name[0] != K_SPECIAL;
1851}
1852
1853/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 * Copy the function name of "fp" to buffer "buf".
1855 * "buf" must be able to hold the function name plus three bytes.
1856 * Takes care of script-local function names.
1857 */
1858 static void
1859cat_func_name(char_u *buf, ufunc_T *fp)
1860{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001861 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001862 {
1863 STRCPY(buf, "<SNR>");
1864 STRCAT(buf, fp->uf_name + 3);
1865 }
1866 else
1867 STRCPY(buf, fp->uf_name);
1868}
1869
1870/*
1871 * Add a number variable "name" to dict "dp" with value "nr".
1872 */
1873 static void
1874add_nr_var(
1875 dict_T *dp,
1876 dictitem_T *v,
1877 char *name,
1878 varnumber_T nr)
1879{
1880 STRCPY(v->di_key, name);
1881 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1882 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1883 v->di_tv.v_type = VAR_NUMBER;
1884 v->di_tv.v_lock = VAR_FIXED;
1885 v->di_tv.vval.v_number = nr;
1886}
1887
1888/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001889 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001891 static void
1892free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001894 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001895
1896 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1897 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001898 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001899
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001900 // When garbage collecting a funccall_T may be freed before the
1901 // function that references it, clear its uf_scoped field.
1902 // The function may have been redefined and point to another
1903 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001904 if (fp != NULL && fp->uf_scoped == fc)
1905 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001906 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001907 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001908
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001909 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001910 vim_free(fc);
1911}
1912
1913/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001914 * Free "fc" and what it contains.
1915 * Can be called only when "fc" is kept beyond the period of it called,
1916 * i.e. after cleanup_function_call(fc).
1917 */
1918 static void
1919free_funccal_contents(funccall_T *fc)
1920{
1921 listitem_T *li;
1922
1923 // Free all l: variables.
1924 vars_clear(&fc->l_vars.dv_hashtab);
1925
1926 // Free all a: variables.
1927 vars_clear(&fc->l_avars.dv_hashtab);
1928
1929 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001930 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001931 clear_tv(&li->li_tv);
1932
1933 free_funccal(fc);
1934}
1935
1936/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001937 * Handle the last part of returning from a function: free the local hashtable.
1938 * Unless it is still in use by a closure.
1939 */
1940 static void
1941cleanup_function_call(funccall_T *fc)
1942{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001943 int may_free_fc = fc->fc_refcount <= 0;
1944 int free_fc = TRUE;
1945
Bram Moolenaar6914c642017-04-01 21:21:30 +02001946 current_funccal = fc->caller;
1947
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001948 // Free all l: variables if not referred.
1949 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1950 vars_clear(&fc->l_vars.dv_hashtab);
1951 else
1952 free_fc = FALSE;
1953
1954 // If the a:000 list and the l: and a: dicts are not referenced and
1955 // there is no closure using it, we can free the funccall_T and what's
1956 // in it.
1957 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1958 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001959 else
1960 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001961 int todo;
1962 hashitem_T *hi;
1963 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001964
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001965 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001966
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001967 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001968 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1969 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1970 {
1971 if (!HASHITEM_EMPTY(hi))
1972 {
1973 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001974 di = HI2DI(hi);
1975 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001976 }
1977 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001978 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001979
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001980 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1981 fc->l_varlist.lv_first = NULL;
1982 else
1983 {
1984 listitem_T *li;
1985
1986 free_fc = FALSE;
1987
1988 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001989 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001990 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001991 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001992
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001993 if (free_fc)
1994 free_funccal(fc);
1995 else
1996 {
1997 static int made_copy = 0;
1998
1999 // "fc" is still in use. This can happen when returning "a:000",
2000 // assigning "l:" to a global variable or defining a closure.
2001 // Link "fc" in the list for garbage collection later.
2002 fc->caller = previous_funccal;
2003 previous_funccal = fc;
2004
2005 if (want_garbage_collect)
2006 // If garbage collector is ready, clear count.
2007 made_copy = 0;
2008 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002009 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002010 // We have made a lot of copies, worth 4 Mbyte. This can happen
2011 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002012 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002013 // too much memory.
2014 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002015 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002016 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002017 }
2018}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002019
2020/*
2021 * There are two kinds of function names:
2022 * 1. ordinary names, function defined with :function or :def
2023 * 2. numbered functions and lambdas
2024 * For the first we only count the name stored in func_hashtab as a reference,
2025 * using function() does not count as a reference, because the function is
2026 * looked up by name.
2027 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002028 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002029func_name_refcount(char_u *name)
2030{
2031 return isdigit(*name) || *name == '<';
2032}
2033
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002034/*
2035 * Unreference "fc": decrement the reference count and free it when it
2036 * becomes zero. "fp" is detached from "fc".
2037 * When "force" is TRUE we are exiting.
2038 */
2039 static void
2040funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2041{
2042 funccall_T **pfc;
2043 int i;
2044
2045 if (fc == NULL)
2046 return;
2047
2048 if (--fc->fc_refcount <= 0 && (force || (
2049 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2050 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2051 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2052 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2053 {
2054 if (fc == *pfc)
2055 {
2056 *pfc = fc->caller;
2057 free_funccal_contents(fc);
2058 return;
2059 }
2060 }
2061 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2062 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2063 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2064}
2065
2066/*
2067 * Remove the function from the function hashtable. If the function was
2068 * deleted while it still has references this was already done.
2069 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2070 */
2071 static int
2072func_remove(ufunc_T *fp)
2073{
2074 hashitem_T *hi;
2075
2076 // Return if it was already virtually deleted.
2077 if (fp->uf_flags & FC_DEAD)
2078 return FALSE;
2079
2080 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2081 if (!HASHITEM_EMPTY(hi))
2082 {
2083 // When there is a def-function index do not actually remove the
2084 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002085 // Do remove it when it's a copy.
2086 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002087 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002088 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002089 return FALSE;
2090 }
2091 hash_remove(&func_hashtab, hi);
2092 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002093 return TRUE;
2094 }
2095 return FALSE;
2096}
2097
2098 static void
2099func_clear_items(ufunc_T *fp)
2100{
2101 ga_clear_strings(&(fp->uf_args));
2102 ga_clear_strings(&(fp->uf_def_args));
2103 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002104 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002105 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002106 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002107 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002108
2109 // Increment the refcount of this function to avoid it being freed
2110 // recursively when the partial is freed.
2111 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002112 partial_unref(fp->uf_partial);
2113 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002114 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002115
2116#ifdef FEAT_LUA
2117 if (fp->uf_cb_free != NULL)
2118 {
2119 fp->uf_cb_free(fp->uf_cb_state);
2120 fp->uf_cb_free = NULL;
2121 }
2122
2123 fp->uf_cb_state = NULL;
2124 fp->uf_cb = NULL;
2125#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002126#ifdef FEAT_PROFILE
2127 VIM_CLEAR(fp->uf_tml_count);
2128 VIM_CLEAR(fp->uf_tml_total);
2129 VIM_CLEAR(fp->uf_tml_self);
2130#endif
2131}
2132
2133/*
2134 * Free all things that a function contains. Does not free the function
2135 * itself, use func_free() for that.
2136 * When "force" is TRUE we are exiting.
2137 */
2138 static void
2139func_clear(ufunc_T *fp, int force)
2140{
2141 if (fp->uf_cleared)
2142 return;
2143 fp->uf_cleared = TRUE;
2144
2145 // clear this function
2146 func_clear_items(fp);
2147 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002148 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002149}
2150
2151/*
2152 * Free a function and remove it from the list of functions. Does not free
2153 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002154 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002155 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002156 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002157 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002158func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002159{
2160 // Only remove it when not done already, otherwise we would remove a newer
2161 // version of the function with the same name.
2162 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2163 func_remove(fp);
2164
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002165 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002166 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002167 if (fp->uf_dfunc_idx > 0)
2168 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002169 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002170 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002171 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002172 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002173 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002174}
2175
2176/*
2177 * Free all things that a function contains and free the function itself.
2178 * When "force" is TRUE we are exiting.
2179 */
2180 static void
2181func_clear_free(ufunc_T *fp, int force)
2182{
2183 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002184 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2185 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002186 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002187 else
2188 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002189}
2190
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002191/*
2192 * Copy already defined function "lambda" to a new function with name "global".
2193 * This is for when a compiled function defines a global function.
2194 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002195 int
2196copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002197{
2198 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002199 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002200
2201 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002202 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002203 semsg(_(e_lambda_function_not_found_str), lambda);
2204 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002205 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002206
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002207 fp = find_func(global, TRUE, NULL);
2208 if (fp != NULL)
2209 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002210 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002211 semsg(_(e_funcexts), global);
2212 return FAIL;
2213 }
2214
2215 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2216 if (fp == NULL)
2217 return FAIL;
2218
2219 fp->uf_varargs = ufunc->uf_varargs;
2220 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2221 fp->uf_def_status = ufunc->uf_def_status;
2222 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2223 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2224 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2225 == FAIL
2226 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2227 goto failed;
2228
2229 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2230 : vim_strsave(ufunc->uf_name_exp);
2231 if (ufunc->uf_arg_types != NULL)
2232 {
2233 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2234 if (fp->uf_arg_types == NULL)
2235 goto failed;
2236 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2237 sizeof(type_T *) * fp->uf_args.ga_len);
2238 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002239 if (ufunc->uf_va_name != NULL)
2240 {
2241 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2242 if (fp->uf_va_name == NULL)
2243 goto failed;
2244 }
2245 fp->uf_ret_type = ufunc->uf_ret_type;
2246
2247 fp->uf_refcount = 1;
2248 STRCPY(fp->uf_name, global);
2249 hash_add(&func_hashtab, UF2HIKEY(fp));
2250
2251 // the referenced dfunc_T is now used one more time
2252 link_def_function(fp);
2253
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002254 // Create a partial to store the context of the function where it was
2255 // instantiated. Only needs to be done once. Do this on the original
2256 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002257 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2258 {
2259 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2260
2261 if (pt == NULL)
2262 goto failed;
2263 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002264 {
2265 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002266 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002267 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002268 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002269 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002270 }
2271
2272 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002273
2274failed:
2275 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002276 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002277}
2278
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002279static int funcdepth = 0;
2280
2281/*
2282 * Increment the function call depth count.
2283 * Return FAIL when going over 'maxfuncdepth'.
2284 * Otherwise return OK, must call funcdepth_decrement() later!
2285 */
2286 int
2287funcdepth_increment(void)
2288{
2289 if (funcdepth >= p_mfd)
2290 {
2291 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2292 return FAIL;
2293 }
2294 ++funcdepth;
2295 return OK;
2296}
2297
2298 void
2299funcdepth_decrement(void)
2300{
2301 --funcdepth;
2302}
2303
2304/*
2305 * Get the current function call depth.
2306 */
2307 int
2308funcdepth_get(void)
2309{
2310 return funcdepth;
2311}
2312
2313/*
2314 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002315 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002316 * times as funcdepth_increment().
2317 */
2318 void
2319funcdepth_restore(int depth)
2320{
2321 funcdepth = depth;
2322}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002323
2324/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002325 * Call a user function.
2326 */
2327 static void
2328call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002329 ufunc_T *fp, // pointer to function
2330 int argcount, // nr of args
2331 typval_T *argvars, // arguments
2332 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002333 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002334 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002335{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002336 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002337 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002338 funccall_T *fc;
2339 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002340 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002342 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 int i;
2344 int ai;
2345 int islambda = FALSE;
2346 char_u numbuf[NUMBUFLEN];
2347 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002348 typval_T *tv_to_free[MAX_FUNC_ARGS];
2349 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002351 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002353 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002354
Bram Moolenaarb2049902021-01-24 12:53:53 +01002355#ifdef FEAT_PROFILE
2356 CLEAR_FIELD(profile_info);
2357#endif
2358
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002359 // If depth of calling is getting too high, don't execute the function.
2360 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362 rettv->v_type = VAR_NUMBER;
2363 rettv->vval.v_number = -1;
2364 return;
2365 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366
Bram Moolenaare38eab22019-12-05 21:50:01 +01002367 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002368
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002369 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002370 if (fc == NULL)
2371 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 fc->caller = current_funccal;
2373 current_funccal = fc;
2374 fc->func = fp;
2375 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002377 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2379 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002380 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002381 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002382 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002383
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002384 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002385 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002386#ifdef FEAT_PROFILE
2387 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2388#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002389 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002390#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002391 if (do_profiling == PROF_YES)
2392 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002393#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002394 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002395 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002396#ifdef FEAT_PROFILE
2397 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002398 || (caller != NULL && caller->uf_profiling)))
2399 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002400#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002401 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002402 free_funccal(fc);
2403 return;
2404 }
2405
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2407 islambda = TRUE;
2408
2409 /*
2410 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2411 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2412 * each argument variable and saves a lot of time.
2413 */
2414 /*
2415 * Init l: variables.
2416 */
2417 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2418 if (selfdict != NULL)
2419 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002420 // Set l:self to "selfdict". Use "name" to avoid a warning from
2421 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 v = &fc->fixvar[fixvar_idx++].var;
2423 name = v->di_key;
2424 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002425 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2427 v->di_tv.v_type = VAR_DICT;
2428 v->di_tv.v_lock = 0;
2429 v->di_tv.vval.v_dict = selfdict;
2430 ++selfdict->dv_refcount;
2431 }
2432
2433 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002434 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002435 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436 * Set a:000 to a list with room for the "..." arguments.
2437 */
2438 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002439 if ((fp->uf_flags & FC_NOARGS) == 0)
2440 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002441 (varnumber_T)(argcount >= fp->uf_args.ga_len
2442 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002443 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002444 if ((fp->uf_flags & FC_NOARGS) == 0)
2445 {
2446 // Use "name" to avoid a warning from some compiler that checks the
2447 // destination size.
2448 v = &fc->fixvar[fixvar_idx++].var;
2449 name = v->di_key;
2450 STRCPY(name, "000");
2451 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2452 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2453 v->di_tv.v_type = VAR_LIST;
2454 v->di_tv.v_lock = VAR_FIXED;
2455 v->di_tv.vval.v_list = &fc->l_varlist;
2456 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002457 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2459 fc->l_varlist.lv_lock = VAR_FIXED;
2460
2461 /*
2462 * Set a:firstline to "firstline" and a:lastline to "lastline".
2463 * Set a:name to named arguments.
2464 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002465 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002467 if ((fp->uf_flags & FC_NOARGS) == 0)
2468 {
2469 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002470 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002471 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002472 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002473 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002474 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 {
2476 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002477 typval_T def_rettv;
2478 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479
2480 ai = i - fp->uf_args.ga_len;
2481 if (ai < 0)
2482 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002483 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 name = FUNCARG(fp, i);
2485 if (islambda)
2486 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002487
2488 // evaluate named argument default expression
2489 isdefault = ai + fp->uf_def_args.ga_len >= 0
2490 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2491 && argvars[i].vval.v_number == VVAL_NONE));
2492 if (isdefault)
2493 {
2494 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002495
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002496 def_rettv.v_type = VAR_NUMBER;
2497 def_rettv.vval.v_number = -1;
2498
2499 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2500 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002501 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002502 {
2503 default_arg_err = 1;
2504 break;
2505 }
2506 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 }
2508 else
2509 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002510 if ((fp->uf_flags & FC_NOARGS) != 0)
2511 // Bail out if no a: arguments used (in lambda).
2512 break;
2513
Bram Moolenaare38eab22019-12-05 21:50:01 +01002514 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515 sprintf((char *)numbuf, "%d", ai + 1);
2516 name = numbuf;
2517 }
2518 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2519 {
2520 v = &fc->fixvar[fixvar_idx++].var;
2521 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002522 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 }
2524 else
2525 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002526 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527 if (v == NULL)
2528 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002529 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002532 // Note: the values are copied directly to avoid alloc/free.
2533 // "argvars" must have VAR_FIXED for v_lock.
2534 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 v->di_tv.v_lock = VAR_FIXED;
2536
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002537 if (isdefault)
2538 // Need to free this later, no matter where it's stored.
2539 tv_to_free[tv_to_free_len++] = &v->di_tv;
2540
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 if (addlocal)
2542 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002543 // Named arguments should be accessed without the "a:" prefix in
2544 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002545 copy_tv(&v->di_tv, &v->di_tv);
2546 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002548 else
2549 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002550
2551 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2552 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002553 listitem_T *li = &fc->l_listitems[ai];
2554
2555 li->li_tv = argvars[i];
2556 li->li_tv.v_lock = VAR_FIXED;
2557 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 }
2559 }
2560
Bram Moolenaare38eab22019-12-05 21:50:01 +01002561 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002562 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002563
2564 if (fp->uf_flags & FC_SANDBOX)
2565 {
2566 using_sandbox = TRUE;
2567 ++sandbox;
2568 }
2569
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002570 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002571 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002572 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002574 ++no_wait_return;
2575 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002577 smsg(_("calling %s"), SOURCING_NAME);
2578 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002579 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002580 char_u buf[MSG_BUF_LEN];
2581 char_u numbuf2[NUMBUFLEN];
2582 char_u *tofree;
2583 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002585 msg_puts("(");
2586 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002588 if (i > 0)
2589 msg_puts(", ");
2590 if (argvars[i].v_type == VAR_NUMBER)
2591 msg_outnum((long)argvars[i].vval.v_number);
2592 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002593 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002594 // Do not want errors such as E724 here.
2595 ++emsg_off;
2596 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2597 --emsg_off;
2598 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002599 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002600 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002602 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2603 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002604 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002605 msg_puts((char *)s);
2606 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607 }
2608 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002609 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002610 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002611 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002612 msg_puts("\n"); // don't overwrite this either
2613
2614 verbose_leave_scroll();
2615 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616 }
2617#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002618 if (do_profiling == PROF_YES)
2619 profile_may_start_func(&profile_info, fp,
2620 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621#endif
2622
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002623 save_current_sctx = current_sctx;
2624 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002625 save_did_emsg = did_emsg;
2626 did_emsg = FALSE;
2627
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002628 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2629 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002630 else if (islambda)
2631 {
2632 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2633
2634 // A Lambda always has the command "return {expr}". It is much faster
2635 // to evaluate {expr} directly.
2636 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002637 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002638 --ex_nesting_level;
2639 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002640 else
2641 // call do_cmdline() to execute the lines
2642 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2644
2645 --RedrawingDisabled;
2646
Bram Moolenaare38eab22019-12-05 21:50:01 +01002647 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2649 {
2650 clear_tv(rettv);
2651 rettv->v_type = VAR_NUMBER;
2652 rettv->vval.v_number = -1;
2653 }
2654
2655#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002656 if (do_profiling == PROF_YES)
2657 {
2658 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2659
2660 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2661 profile_may_end_func(&profile_info, fp, caller);
2662 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663#endif
2664
Bram Moolenaare38eab22019-12-05 21:50:01 +01002665 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 if (p_verbose >= 12)
2667 {
2668 ++no_wait_return;
2669 verbose_enter_scroll();
2670
2671 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002672 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002674 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 (long)fc->rettv->vval.v_number);
2676 else
2677 {
2678 char_u buf[MSG_BUF_LEN];
2679 char_u numbuf2[NUMBUFLEN];
2680 char_u *tofree;
2681 char_u *s;
2682
Bram Moolenaare38eab22019-12-05 21:50:01 +01002683 // The value may be very long. Skip the middle part, so that we
2684 // have some idea how it starts and ends. smsg() would always
2685 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 ++emsg_off;
2687 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2688 --emsg_off;
2689 if (s != NULL)
2690 {
2691 if (vim_strsize(s) > MSG_BUF_CLEN)
2692 {
2693 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2694 s = buf;
2695 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002696 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 vim_free(tofree);
2698 }
2699 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002700 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701
2702 verbose_leave_scroll();
2703 --no_wait_return;
2704 }
2705
Bram Moolenaare31ee862020-01-07 20:59:34 +01002706 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002707 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002708 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709#ifdef FEAT_PROFILE
2710 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002711 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002713 if (using_sandbox)
2714 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002716 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 {
2718 ++no_wait_return;
2719 verbose_enter_scroll();
2720
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002721 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002722 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723
2724 verbose_leave_scroll();
2725 --no_wait_return;
2726 }
2727
2728 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002729 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002730 for (i = 0; i < tv_to_free_len; ++i)
2731 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002732 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733}
2734
2735/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002736 * Check the argument count for user function "fp".
2737 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2738 */
2739 int
2740check_user_func_argcount(ufunc_T *fp, int argcount)
2741{
2742 int regular_args = fp->uf_args.ga_len;
2743
2744 if (argcount < regular_args - fp->uf_def_args.ga_len)
2745 return FCERR_TOOFEW;
2746 else if (!has_varargs(fp) && argcount > regular_args)
2747 return FCERR_TOOMANY;
2748 return FCERR_UNKNOWN;
2749}
2750
2751/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002752 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002753 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002754 int
2755call_user_func_check(
2756 ufunc_T *fp,
2757 int argcount,
2758 typval_T *argvars,
2759 typval_T *rettv,
2760 funcexe_T *funcexe,
2761 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002762{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002763 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002764
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002765 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2766 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002767 error = check_user_func_argcount(fp, argcount);
2768 if (error != FCERR_UNKNOWN)
2769 return error;
2770 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002771 error = FCERR_DICT;
2772 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002773 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002774 int did_save_redo = FALSE;
2775 save_redo_T save_redo;
2776
2777 /*
2778 * Call the user function.
2779 * Save and restore search patterns, script variables and
2780 * redo buffer.
2781 */
2782 save_search_patterns();
2783 if (!ins_compl_active())
2784 {
2785 saveRedobuff(&save_redo);
2786 did_save_redo = TRUE;
2787 }
2788 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002789 call_user_func(fp, argcount, argvars, rettv, funcexe,
2790 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002791 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2792 // Function was unreferenced while being used, free it now.
2793 func_clear_free(fp, FALSE);
2794 if (did_save_redo)
2795 restoreRedobuff(&save_redo);
2796 restore_search_patterns();
2797 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002798 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002799 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002800}
2801
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002802static funccal_entry_T *funccal_stack = NULL;
2803
2804/*
2805 * Save the current function call pointer, and set it to NULL.
2806 * Used when executing autocommands and for ":source".
2807 */
2808 void
2809save_funccal(funccal_entry_T *entry)
2810{
2811 entry->top_funccal = current_funccal;
2812 entry->next = funccal_stack;
2813 funccal_stack = entry;
2814 current_funccal = NULL;
2815}
2816
2817 void
2818restore_funccal(void)
2819{
2820 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002821 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002822 else
2823 {
2824 current_funccal = funccal_stack->top_funccal;
2825 funccal_stack = funccal_stack->next;
2826 }
2827}
2828
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002829 funccall_T *
2830get_current_funccal(void)
2831{
2832 return current_funccal;
2833}
2834
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002835/*
2836 * Mark all functions of script "sid" as deleted.
2837 */
2838 void
2839delete_script_functions(int sid)
2840{
2841 hashitem_T *hi;
2842 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002843 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002844 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002845 size_t len;
2846
2847 buf[0] = K_SPECIAL;
2848 buf[1] = KS_EXTRA;
2849 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002850 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002851 len = STRLEN(buf);
2852
Bram Moolenaarce658352020-07-31 23:47:12 +02002853 while (todo > 0)
2854 {
2855 todo = func_hashtab.ht_used;
2856 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2857 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002858 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002859 fp = HI2UF(hi);
2860 if (STRNCMP(fp->uf_name, buf, len) == 0)
2861 {
2862 int changed = func_hashtab.ht_changed;
2863
2864 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002865
2866 if (fp->uf_calls > 0)
2867 {
2868 // Function is executing, don't free it but do remove
2869 // it from the hashtable.
2870 if (func_remove(fp))
2871 fp->uf_refcount--;
2872 }
2873 else
2874 {
2875 func_clear(fp, TRUE);
2876 // When clearing a function another function can be
2877 // cleared as a side effect. When that happens start
2878 // over.
2879 if (changed != func_hashtab.ht_changed)
2880 break;
2881 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002882 }
2883 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002884 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002885 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002886}
2887
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888#if defined(EXITFREE) || defined(PROTO)
2889 void
2890free_all_functions(void)
2891{
2892 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002893 ufunc_T *fp;
2894 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002895 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002896 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897
Bram Moolenaare38eab22019-12-05 21:50:01 +01002898 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002899 while (current_funccal != NULL)
2900 {
2901 clear_tv(current_funccal->rettv);
2902 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002903 if (current_funccal == NULL && funccal_stack != NULL)
2904 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002905 }
2906
Bram Moolenaare38eab22019-12-05 21:50:01 +01002907 // First clear what the functions contain. Since this may lower the
2908 // reference count of a function, it may also free a function and change
2909 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002910 while (todo > 0)
2911 {
2912 todo = func_hashtab.ht_used;
2913 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2914 if (!HASHITEM_EMPTY(hi))
2915 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002916 // clear the def function index now
2917 fp = HI2UF(hi);
2918 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002919 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002920
Bram Moolenaare38eab22019-12-05 21:50:01 +01002921 // Only free functions that are not refcounted, those are
2922 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002923 if (func_name_refcount(fp->uf_name))
2924 ++skipped;
2925 else
2926 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002927 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002928 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002929 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002930 {
2931 skipped = 0;
2932 break;
2933 }
2934 }
2935 --todo;
2936 }
2937 }
2938
Bram Moolenaare38eab22019-12-05 21:50:01 +01002939 // Now actually free the functions. Need to start all over every time,
2940 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002941 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002942 while (func_hashtab.ht_used > skipped)
2943 {
2944 todo = func_hashtab.ht_used;
2945 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946 if (!HASHITEM_EMPTY(hi))
2947 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002948 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002949 // Only free functions that are not refcounted, those are
2950 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002951 fp = HI2UF(hi);
2952 if (func_name_refcount(fp->uf_name))
2953 ++skipped;
2954 else
2955 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002956 if (func_free(fp, FALSE) == OK)
2957 {
2958 skipped = 0;
2959 break;
2960 }
2961 // did not actually free it
2962 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002963 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002965 }
2966 if (skipped == 0)
2967 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002968
2969 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970}
2971#endif
2972
2973/*
2974 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002975 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002976 * "len" is the length of "name", or -1 for NUL terminated.
2977 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002978 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002979builtin_function(char_u *name, int len)
2980{
2981 char_u *p;
2982
Bram Moolenaara26b9702020-04-18 19:53:28 +02002983 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984 return FALSE;
2985 p = vim_strchr(name, AUTOLOAD_CHAR);
2986 return p == NULL || (len > 0 && p > name + len);
2987}
2988
2989 int
2990func_call(
2991 char_u *name,
2992 typval_T *args,
2993 partial_T *partial,
2994 dict_T *selfdict,
2995 typval_T *rettv)
2996{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002997 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 listitem_T *item;
2999 typval_T argv[MAX_FUNC_ARGS + 1];
3000 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 int r = 0;
3002
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003003 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003004 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005 {
3006 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3007 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003008 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009 break;
3010 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003011 // Make a copy of each argument. This is needed to be able to set
3012 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013 copy_tv(&item->li_tv, &argv[argc++]);
3014 }
3015
3016 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003017 {
3018 funcexe_T funcexe;
3019
Bram Moolenaara80faa82020-04-12 19:37:17 +02003020 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003021 funcexe.firstline = curwin->w_cursor.lnum;
3022 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003023 funcexe.evaluate = TRUE;
3024 funcexe.partial = partial;
3025 funcexe.selfdict = selfdict;
3026 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3027 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028
Bram Moolenaare38eab22019-12-05 21:50:01 +01003029 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 while (argc > 0)
3031 clear_tv(&argv[--argc]);
3032
3033 return r;
3034}
3035
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003036static int callback_depth = 0;
3037
3038 int
3039get_callback_depth(void)
3040{
3041 return callback_depth;
3042}
3043
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003045 * Invoke call_func() with a callback.
3046 */
3047 int
3048call_callback(
3049 callback_T *callback,
3050 int len, // length of "name" or -1 to use strlen()
3051 typval_T *rettv, // return value goes here
3052 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003053 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003054 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003055{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003056 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003057 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003058
Bram Moolenaara80faa82020-04-12 19:37:17 +02003059 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003060 funcexe.evaluate = TRUE;
3061 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003062 ++callback_depth;
3063 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3064 --callback_depth;
3065 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003066}
3067
3068/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003069 * Give an error message for the result of a function.
3070 * Nothing if "error" is FCERR_NONE.
3071 */
3072 void
3073user_func_error(int error, char_u *name)
3074{
3075 switch (error)
3076 {
3077 case FCERR_UNKNOWN:
3078 emsg_funcname(e_unknownfunc, name);
3079 break;
3080 case FCERR_NOTMETHOD:
3081 emsg_funcname(
3082 N_("E276: Cannot use function as a method: %s"), name);
3083 break;
3084 case FCERR_DELETED:
3085 emsg_funcname(N_(e_func_deleted), name);
3086 break;
3087 case FCERR_TOOMANY:
3088 emsg_funcname((char *)e_toomanyarg, name);
3089 break;
3090 case FCERR_TOOFEW:
3091 emsg_funcname((char *)e_toofewarg, name);
3092 break;
3093 case FCERR_SCRIPT:
3094 emsg_funcname(
3095 N_("E120: Using <SID> not in a script context: %s"), name);
3096 break;
3097 case FCERR_DICT:
3098 emsg_funcname(
3099 N_("E725: Calling dict function without Dictionary: %s"),
3100 name);
3101 break;
3102 }
3103}
3104
3105/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003107 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 * Return FAIL when the function can't be called, OK otherwise.
3109 * Also returns OK when an error was encountered while executing the function.
3110 */
3111 int
3112call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003113 char_u *funcname, // name of the function
3114 int len, // length of "name" or -1 to use strlen()
3115 typval_T *rettv, // return value goes here
3116 int argcount_in, // number of "argvars"
3117 typval_T *argvars_in, // vars for arguments, must have "argcount"
3118 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003119 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120{
3121 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003122 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003124 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125 char_u fname_buf[FLEN_FIXED + 1];
3126 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003127 char_u *fname = NULL;
3128 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 int argcount = argcount_in;
3130 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003131 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003132 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3133 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003135 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003136 partial_T *partial = funcexe->partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003137 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003139 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3140 // even when call_func() returns FAIL.
3141 rettv->v_type = VAR_UNKNOWN;
3142
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003143 if (partial != NULL)
3144 fp = partial->pt_func;
3145 if (fp == NULL)
3146 {
3147 // Make a copy of the name, if it comes from a funcref variable it
3148 // could be changed or deleted in the called function.
3149 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3150 if (name == NULL)
3151 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003153 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3154 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003155
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003156 if (funcexe->doesrange != NULL)
3157 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003158
3159 if (partial != NULL)
3160 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003161 // When the function has a partial with a dict and there is a dict
3162 // argument, use the dict argument. That is backwards compatible.
3163 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003164 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003166 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 {
3168 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003169 {
3170 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3171 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003172 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003173 goto theend;
3174 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 for (i = 0; i < argcount_in; ++i)
3178 argv[i + argv_clear] = argvars_in[i];
3179 argvars = argv;
3180 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003181
Bram Moolenaar22f85d02021-07-04 23:29:30 +02003182 if (funcexe->check_type != NULL
3183 && funcexe->check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003184 {
3185 // Now funcexe->check_type is missing the added arguments, make
3186 // a copy of the type with the correction.
3187 check_type = *funcexe->check_type;
3188 funcexe->check_type = &check_type;
3189 check_type.tt_argcount += partial->pt_argc;
3190 check_type.tt_min_argcount += partial->pt_argc;
3191 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192 }
3193 }
3194
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003195 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3196 {
3197 // Check that the argument types are OK for the types of the funcref.
3198 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003199 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003200 error = FCERR_OTHER;
3201 }
3202
Bram Moolenaaref140542019-12-31 21:27:13 +01003203 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003204 {
3205 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003206 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207
Bram Moolenaar333894b2020-08-01 18:53:07 +02003208 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003209 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003210 {
3211 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003213 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214
Bram Moolenaare38eab22019-12-05 21:50:01 +01003215 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003217 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003219 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220 {
3221 /*
3222 * User defined function.
3223 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003224 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003225 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226
Bram Moolenaare38eab22019-12-05 21:50:01 +01003227 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 if (fp == NULL
3229 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003230 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 && !aborting())
3232 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003233 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003234 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003236 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3238 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003239 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003240 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003242 if (fp == NULL)
3243 {
3244 char_u *p = untrans_function_name(rfname);
3245
3246 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003247 // Don't do this if the name starts with "s:".
3248 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003249 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003250 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003251
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003252 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003253 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003254#ifdef FEAT_LUA
3255 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3256 {
3257 cfunc_T cb = fp->uf_cb;
3258
3259 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3260 }
3261#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003262 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003264 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003265 // postponed filling in the arguments, do it now
3266 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003267 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003268
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003269 if (funcexe->basetv != NULL)
3270 {
3271 // Method call: base->Method()
3272 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3273 argv[0] = *funcexe->basetv;
3274 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003275 argvars = argv;
3276 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003277 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003278
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 error = call_user_func_check(fp, argcount, argvars, rettv,
3280 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 }
3282 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003283 else if (funcexe->basetv != NULL)
3284 {
3285 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003286 * expr->method(): Find the method name in the table, call its
3287 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003288 */
3289 error = call_internal_method(fname, argcount, argvars, rettv,
3290 funcexe->basetv);
3291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 else
3293 {
3294 /*
3295 * Find the function name in the table, call its implementation.
3296 */
3297 error = call_internal_func(fname, argcount, argvars, rettv);
3298 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003299
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003300 /*
3301 * The function call (or "FuncUndefined" autocommand sequence) might
3302 * have been aborted by an error, an interrupt, or an explicitly thrown
3303 * exception that has not been caught so far. This situation can be
3304 * tested for by calling aborting(). For an error in an internal
3305 * function or for the "E132" error in call_user_func(), however, the
3306 * throw point at which the "force_abort" flag (temporarily reset by
3307 * emsg()) is normally updated has not been reached yet. We need to
3308 * update that flag first to make aborting() reliable.
3309 */
3310 update_force_abort();
3311 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003312 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 ret = OK;
3314
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003315theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 /*
3317 * Report an error unless the argument evaluation or function call has been
3318 * cancelled due to an aborting error, an interrupt, or an exception.
3319 */
3320 if (!aborting())
3321 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003322 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323 }
3324
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003325 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003326 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003327 clear_tv(&argv[--argv_clear + argv_base]);
3328
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329 vim_free(tofree);
3330 vim_free(name);
3331
3332 return ret;
3333}
3334
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003335 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336printable_func_name(ufunc_T *fp)
3337{
3338 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3339}
3340
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003342 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343 */
3344 static void
3345list_func_head(ufunc_T *fp, int indent)
3346{
3347 int j;
3348
3349 msg_start();
3350 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003351 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003352 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003353 msg_puts("def ");
3354 else
3355 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003356 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 msg_putchar('(');
3358 for (j = 0; j < fp->uf_args.ga_len; ++j)
3359 {
3360 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003361 msg_puts(", ");
3362 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003363 if (fp->uf_arg_types != NULL)
3364 {
3365 char *tofree;
3366
3367 msg_puts(": ");
3368 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3369 vim_free(tofree);
3370 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003371 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3372 {
3373 msg_puts(" = ");
3374 msg_puts(((char **)(fp->uf_def_args.ga_data))
3375 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3376 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 }
3378 if (fp->uf_varargs)
3379 {
3380 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003381 msg_puts(", ");
3382 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003383 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003384 if (fp->uf_va_name != NULL)
3385 {
3386 if (j)
3387 msg_puts(", ");
3388 msg_puts("...");
3389 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003390 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003391 {
3392 char *tofree;
3393
3394 msg_puts(": ");
3395 msg_puts(type_name(fp->uf_va_type, &tofree));
3396 vim_free(tofree);
3397 }
3398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003400
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003401 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003402 {
3403 if (fp->uf_ret_type != &t_void)
3404 {
3405 char *tofree;
3406
3407 msg_puts(": ");
3408 msg_puts(type_name(fp->uf_ret_type, &tofree));
3409 vim_free(tofree);
3410 }
3411 }
3412 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003413 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003415 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003417 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003418 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003419 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 msg_clr_eos();
3421 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003422 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423}
3424
3425/*
3426 * Get a function name, translating "<SID>" and "<SNR>".
3427 * Also handles a Funcref in a List or Dictionary.
3428 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003429 * Set "*is_global" to TRUE when the function must be global, unless
3430 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 * flags:
3432 * TFN_INT: internal function name OK
3433 * TFN_QUIET: be quiet
3434 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003435 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 * Advances "pp" to just after the function name (if no error).
3437 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003438 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439trans_function_name(
3440 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003441 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003444 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003445 partial_T **partial, // return: partial of a FuncRef
3446 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447{
3448 char_u *name = NULL;
3449 char_u *start;
3450 char_u *end;
3451 int lead;
3452 char_u sid_buf[20];
3453 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003454 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003456 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003457 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458
3459 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003460 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 start = *pp;
3462
Bram Moolenaare38eab22019-12-05 21:50:01 +01003463 // Check for hard coded <SNR>: already translated function ID (from a user
3464 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3466 && (*pp)[2] == (int)KE_SNR)
3467 {
3468 *pp += 3;
3469 len = get_id_len(pp) + 3;
3470 return vim_strnsave(start, len);
3471 }
3472
Bram Moolenaare38eab22019-12-05 21:50:01 +01003473 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3474 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 lead = eval_fname_script(start);
3476 if (lead > 2)
3477 start += lead;
3478
Bram Moolenaare38eab22019-12-05 21:50:01 +01003479 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003480 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003481 lead > 2 ? 0 : FNE_CHECK_START);
3482 if (end == start)
3483 {
3484 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003485 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 goto theend;
3487 }
3488 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3489 {
3490 /*
3491 * Report an invalid expression in braces, unless the expression
3492 * evaluation has been cancelled due to an aborting error, an
3493 * interrupt, or an exception.
3494 */
3495 if (!aborting())
3496 {
3497 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003498 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 }
3500 else
3501 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3502 goto theend;
3503 }
3504
3505 if (lv.ll_tv != NULL)
3506 {
3507 if (fdp != NULL)
3508 {
3509 fdp->fd_dict = lv.ll_dict;
3510 fdp->fd_newkey = lv.ll_newkey;
3511 lv.ll_newkey = NULL;
3512 fdp->fd_di = lv.ll_di;
3513 }
3514 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3515 {
3516 name = vim_strsave(lv.ll_tv->vval.v_string);
3517 *pp = end;
3518 }
3519 else if (lv.ll_tv->v_type == VAR_PARTIAL
3520 && lv.ll_tv->vval.v_partial != NULL)
3521 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003522 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 *pp = end;
3524 if (partial != NULL)
3525 *partial = lv.ll_tv->vval.v_partial;
3526 }
3527 else
3528 {
3529 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3530 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003531 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 else
3533 *pp = end;
3534 name = NULL;
3535 }
3536 goto theend;
3537 }
3538
3539 if (lv.ll_name == NULL)
3540 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003541 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 *pp = end;
3543 goto theend;
3544 }
3545
Bram Moolenaare38eab22019-12-05 21:50:01 +01003546 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 if (lv.ll_exp_name != NULL)
3548 {
3549 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003550 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 flags & TFN_NO_AUTOLOAD);
3552 if (name == lv.ll_exp_name)
3553 name = NULL;
3554 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003555 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 {
3557 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003558 name = deref_func_name(*pp, &len, partial, type,
3559 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 if (name == *pp)
3561 name = NULL;
3562 }
3563 if (name != NULL)
3564 {
3565 name = vim_strsave(name);
3566 *pp = end;
3567 if (STRNCMP(name, "<SNR>", 5) == 0)
3568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003569 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 name[0] = K_SPECIAL;
3571 name[1] = KS_EXTRA;
3572 name[2] = (int)KE_SNR;
3573 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3574 }
3575 goto theend;
3576 }
3577
3578 if (lv.ll_exp_name != NULL)
3579 {
3580 len = (int)STRLEN(lv.ll_exp_name);
3581 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3582 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3583 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003584 // When there was "s:" already or the name expanded to get a
3585 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 lv.ll_name += 2;
3587 len -= 2;
3588 lead = 2;
3589 }
3590 }
3591 else
3592 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003593 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003595 {
3596 if (is_global != NULL && lv.ll_name[0] == 'g')
3597 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003599 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600 len = (int)(end - lv.ll_name);
3601 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003602 if (len <= 0)
3603 {
3604 if (!skip)
3605 emsg(_(e_function_name));
3606 goto theend;
3607 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003609 // In Vim9 script a user function is script-local by default, unless it
3610 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003611 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003612 if (vim9script)
3613 {
3614 char_u *p;
3615
3616 // SomeScript#func() is a global function.
3617 for (p = start; *p != NUL && *p != '('; ++p)
3618 if (*p == AUTOLOAD_CHAR)
3619 vim9script = FALSE;
3620 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003621
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 /*
3623 * Copy the function name to allocated memory.
3624 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3625 * Accept <SNR>123_name() outside a script.
3626 */
3627 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003628 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003629 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003631 if (!vim9script)
3632 lead = 3;
3633 if (vim9script || (lv.ll_exp_name != NULL
3634 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 || eval_fname_sid(*pp))
3636 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003637 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003638 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003640 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 goto theend;
3642 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003643 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003644 if (vim9script)
3645 extra = 3 + (int)STRLEN(sid_buf);
3646 else
3647 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 }
3649 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003650 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3651 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003653 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654 start);
3655 goto theend;
3656 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003657 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658 {
3659 char_u *cp = vim_strchr(lv.ll_name, ':');
3660
3661 if (cp != NULL && cp < end)
3662 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003663 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 goto theend;
3665 }
3666 }
3667
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003668 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 if (name != NULL)
3670 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003671 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 {
3673 name[0] = K_SPECIAL;
3674 name[1] = KS_EXTRA;
3675 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 STRCPY(name + 3, sid_buf);
3678 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003679 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3680 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 }
3682 *pp = end;
3683
3684theend:
3685 clear_lval(&lv);
3686 return name;
3687}
3688
3689/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003690 * Assuming "name" is the result of trans_function_name() and it was prefixed
3691 * to use the script-local name, return the unmodified name (points into
3692 * "name"). Otherwise return NULL.
3693 * This can be used to first search for a script-local function and fall back
3694 * to the global function if not found.
3695 */
3696 char_u *
3697untrans_function_name(char_u *name)
3698{
3699 char_u *p;
3700
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003701 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003702 {
3703 p = vim_strchr(name, '_');
3704 if (p != NULL)
3705 return p + 1;
3706 }
3707 return NULL;
3708}
3709
3710/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003711 * List functions. When "regmatch" is NULL all of then.
3712 * Otherwise functions matching "regmatch".
3713 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003714 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003715list_functions(regmatch_T *regmatch)
3716{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003717 int changed = func_hashtab.ht_changed;
3718 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003719 hashitem_T *hi;
3720
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003721 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003722 {
3723 if (!HASHITEM_EMPTY(hi))
3724 {
3725 ufunc_T *fp = HI2UF(hi);
3726
3727 --todo;
3728 if ((fp->uf_flags & FC_DEAD) == 0
3729 && (regmatch == NULL
3730 ? !message_filtered(fp->uf_name)
3731 && !func_name_refcount(fp->uf_name)
3732 : !isdigit(*fp->uf_name)
3733 && vim_regexec(regmatch, fp->uf_name, 0)))
3734 {
3735 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003736 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003737 {
3738 emsg(_("E454: function list was modified"));
3739 return;
3740 }
3741 }
3742 }
3743 }
3744}
3745
3746/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003747 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003748 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3749 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003750 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003752 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003753define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003755 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 int j;
3757 int c;
3758 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003759 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003760 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 char_u *p;
3762 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003763 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 char_u *line_arg = NULL;
3765 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003766 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003767 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768 garray_T newlines;
3769 int varargs = FALSE;
3770 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003771 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003772 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003773 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 dictitem_T *v;
3775 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003776 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003779 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003780 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003781 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782
3783 /*
3784 * ":function" without argument: list functions.
3785 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003786 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 {
3788 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003789 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003791 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 }
3793
3794 /*
3795 * ":function /pat": list functions matching pattern.
3796 */
3797 if (*eap->arg == '/')
3798 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003799 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 if (!eap->skip)
3801 {
3802 regmatch_T regmatch;
3803
3804 c = *p;
3805 *p = NUL;
3806 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3807 *p = c;
3808 if (regmatch.regprog != NULL)
3809 {
3810 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003811 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 vim_regfree(regmatch.regprog);
3813 }
3814 }
3815 if (*p == '/')
3816 ++p;
3817 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003818 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 }
3820
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003821 ga_init(&newargs);
3822 ga_init(&argtypes);
3823 ga_init(&default_args);
3824
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 /*
3826 * Get the function name. There are these situations:
3827 * func normal function name
3828 * "name" == func, "fudi.fd_dict" == NULL
3829 * dict.func new dictionary entry
3830 * "name" == NULL, "fudi.fd_dict" set,
3831 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3832 * dict.func existing dict entry with a Funcref
3833 * "name" == func, "fudi.fd_dict" set,
3834 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3835 * dict.func existing dict entry that's not a Funcref
3836 * "name" == NULL, "fudi.fd_dict" set,
3837 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3838 * s:func script-local function name
3839 * g:func global function name, same as "func"
3840 */
3841 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003842 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003844 // nested function, argument is (args).
3845 paren = TRUE;
3846 CLEAR_FIELD(fudi);
3847 }
3848 else
3849 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003850 if (STRNCMP(p, "<lambda>", 8) == 0)
3851 {
3852 p += 8;
3853 (void)getdigits(&p);
3854 name = vim_strnsave(eap->arg, p - eap->arg);
3855 CLEAR_FIELD(fudi);
3856 }
3857 else
3858 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003859 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003860 paren = (vim_strchr(p, '(') != NULL);
3861 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003863 /*
3864 * Return on an invalid expression in braces, unless the expression
3865 * evaluation has been cancelled due to an aborting error, an
3866 * interrupt, or an exception.
3867 */
3868 if (!aborting())
3869 {
3870 if (!eap->skip && fudi.fd_newkey != NULL)
3871 semsg(_(e_dictkey), fudi.fd_newkey);
3872 vim_free(fudi.fd_newkey);
3873 return NULL;
3874 }
3875 else
3876 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878 }
3879
Bram Moolenaare38eab22019-12-05 21:50:01 +01003880 // An error in a function call during evaluation of an expression in magic
3881 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882 saved_did_emsg = did_emsg;
3883 did_emsg = FALSE;
3884
3885 /*
3886 * ":function func" with only function name: list function.
3887 */
3888 if (!paren)
3889 {
3890 if (!ends_excmd(*skipwhite(p)))
3891 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003892 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003893 goto ret_free;
3894 }
3895 eap->nextcmd = check_nextcmd(p);
3896 if (eap->nextcmd != NULL)
3897 *p = NUL;
3898 if (!eap->skip && !got_int)
3899 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003900 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003901 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3902 {
3903 char_u *up = untrans_function_name(name);
3904
3905 // With Vim9 script the name was made script-local, if not
3906 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003907 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003908 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003909 }
3910
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 if (fp != NULL)
3912 {
3913 list_func_head(fp, TRUE);
3914 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3915 {
3916 if (FUNCLINE(fp, j) == NULL)
3917 continue;
3918 msg_putchar('\n');
3919 msg_outnum((long)(j + 1));
3920 if (j < 9)
3921 msg_putchar(' ');
3922 if (j < 99)
3923 msg_putchar(' ');
3924 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003925 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 ui_breakcheck();
3927 }
3928 if (!got_int)
3929 {
3930 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003931 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003932 msg_puts(" enddef");
3933 else
3934 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 }
3936 }
3937 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003938 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 }
3940 goto ret_free;
3941 }
3942
3943 /*
3944 * ":function name(arg1, arg2)" Define function.
3945 */
3946 p = skipwhite(p);
3947 if (*p != '(')
3948 {
3949 if (!eap->skip)
3950 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003951 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 goto ret_free;
3953 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003954 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 if (vim_strchr(p, '(') != NULL)
3956 p = vim_strchr(p, '(');
3957 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003959 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3960 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003961 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003962 goto ret_free;
3963 }
3964
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003965 // In Vim9 script only global functions can be redefined.
3966 if (vim9script && eap->forceit && !is_global)
3967 {
3968 emsg(_(e_nobang));
3969 goto ret_free;
3970 }
3971
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003972 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973
Bram Moolenaar04b12692020-05-04 23:24:44 +02003974 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003975 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003976 // Check the name of the function. Unless it's a dictionary function
3977 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 if (name != NULL)
3979 arg = name;
3980 else
3981 arg = fudi.fd_newkey;
3982 if (arg != NULL && (fudi.fd_di == NULL
3983 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3984 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3985 {
3986 if (*arg == K_SPECIAL)
3987 j = 3;
3988 else
3989 j = 0;
3990 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3991 : eval_isnamec(arg[j])))
3992 ++j;
3993 if (arg[j] != NUL)
3994 emsg_funcname((char *)e_invarg2, arg);
3995 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003996 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003997 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003998 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 }
4000
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004001 // This may get more lines and make the pointers into the first line
4002 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004003 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004004 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004005 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004006 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004007 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004009 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004011 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004013 // find the return type: :def Func(): type
4014 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004016 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004017 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004018 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004019 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004020 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004021 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004022 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004023 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004024 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004025 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004026 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004027 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004028 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004030 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004032 else
4033 // find extra arguments "range", "dict", "abort" and "closure"
4034 for (;;)
4035 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004036 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004037 p = skipwhite(p);
4038 if (STRNCMP(p, "range", 5) == 0)
4039 {
4040 flags |= FC_RANGE;
4041 p += 5;
4042 }
4043 else if (STRNCMP(p, "dict", 4) == 0)
4044 {
4045 flags |= FC_DICT;
4046 p += 4;
4047 }
4048 else if (STRNCMP(p, "abort", 5) == 0)
4049 {
4050 flags |= FC_ABORT;
4051 p += 5;
4052 }
4053 else if (STRNCMP(p, "closure", 7) == 0)
4054 {
4055 flags |= FC_CLOSURE;
4056 p += 7;
4057 if (current_funccal == NULL)
4058 {
4059 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4060 name == NULL ? (char_u *)"" : name);
4061 goto erret;
4062 }
4063 }
4064 else
4065 break;
4066 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067
Bram Moolenaare38eab22019-12-05 21:50:01 +01004068 // When there is a line break use what follows for the function body.
4069 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 if (*p == '\n')
4071 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004072 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004073 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4074 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004075 && !(VIM_ISWHITE(*whitep) && *p == '#'
4076 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004077 && !eap->skip
4078 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004079 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080
4081 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004082 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4083 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 */
4085 if (KeyTyped)
4086 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004087 // Check if the function already exists, don't let the user type the
4088 // whole function before telling him it doesn't work! For a script we
4089 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090 if (!eap->skip && !eap->forceit)
4091 {
4092 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004093 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004094 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 emsg_funcname(e_funcexts, name);
4096 }
4097
4098 if (!eap->skip && did_emsg)
4099 goto erret;
4100
Bram Moolenaare38eab22019-12-05 21:50:01 +01004101 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 cmdline_row = msg_row;
4103 }
4104
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004105 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004106 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004107
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004108 // Do not define the function when getting the body fails and when
4109 // skipping.
4110 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4111 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 goto erret;
4113
4114 /*
4115 * If there are no errors, add the function
4116 */
4117 if (fudi.fd_dict == NULL)
4118 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004119 hashtab_T *ht;
4120
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004121 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004122 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4123 {
4124 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4125 name);
4126 goto erret;
4127 }
4128
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004129 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004130 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004131 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004132 char_u *uname = untrans_function_name(name);
4133
4134 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4135 }
4136
4137 if (fp != NULL || import != NULL)
4138 {
4139 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004141 // Function can be replaced with "function!" and when sourcing the
4142 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004143 // A name that is used by an import can not be overruled.
4144 if (import != NULL
4145 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004146 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004147 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004149 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004150 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004151 else
4152 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004153 goto erret;
4154 }
4155 if (fp->uf_calls > 0)
4156 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004157 emsg_funcname(
4158 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 name);
4160 goto erret;
4161 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004162 if (fp->uf_refcount > 1)
4163 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004164 // This function is referenced somewhere, don't redefine it but
4165 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004166 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004167 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004168 fp = NULL;
4169 overwrite = TRUE;
4170 }
4171 else
4172 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004173 char_u *exp_name = fp->uf_name_exp;
4174
4175 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004176 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004177 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004178 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004179 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004180 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004181#ifdef FEAT_PROFILE
4182 fp->uf_profiling = FALSE;
4183 fp->uf_prof_initialized = FALSE;
4184#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004185 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004186 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 }
4188 }
4189 else
4190 {
4191 char numbuf[20];
4192
4193 fp = NULL;
4194 if (fudi.fd_newkey == NULL && !eap->forceit)
4195 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004196 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 goto erret;
4198 }
4199 if (fudi.fd_di == NULL)
4200 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004201 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004202 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 goto erret;
4204 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004205 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004206 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004207 goto erret;
4208
Bram Moolenaare38eab22019-12-05 21:50:01 +01004209 // Give the function a sequential number. Can only be used with a
4210 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 vim_free(name);
4212 sprintf(numbuf, "%d", ++func_nr);
4213 name = vim_strsave((char_u *)numbuf);
4214 if (name == NULL)
4215 goto erret;
4216 }
4217
4218 if (fp == NULL)
4219 {
4220 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4221 {
4222 int slen, plen;
4223 char_u *scriptname;
4224
Bram Moolenaare38eab22019-12-05 21:50:01 +01004225 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004227 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004228 {
4229 scriptname = autoload_name(name);
4230 if (scriptname != NULL)
4231 {
4232 p = vim_strchr(scriptname, '/');
4233 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004234 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004236 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 j = OK;
4238 vim_free(scriptname);
4239 }
4240 }
4241 if (j == FAIL)
4242 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004243 linenr_T save_lnum = SOURCING_LNUM;
4244
4245 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004246 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004247 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248 goto erret;
4249 }
4250 }
4251
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004252 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004253 if (fp == NULL)
4254 goto erret;
4255
4256 if (fudi.fd_dict != NULL)
4257 {
4258 if (fudi.fd_di == NULL)
4259 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4262 if (fudi.fd_di == NULL)
4263 {
4264 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004265 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 goto erret;
4267 }
4268 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4269 {
4270 vim_free(fudi.fd_di);
4271 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004272 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 goto erret;
4274 }
4275 }
4276 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004277 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278 clear_tv(&fudi.fd_di->di_tv);
4279 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281
Bram Moolenaare38eab22019-12-05 21:50:01 +01004282 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283 flags |= FC_DICT;
4284 }
4285
Bram Moolenaare38eab22019-12-05 21:50:01 +01004286 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004287 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004288 if (overwrite)
4289 {
4290 hi = hash_find(&func_hashtab, name);
4291 hi->hi_key = UF2HIKEY(fp);
4292 }
4293 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294 {
4295 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004296 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 goto erret;
4298 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004299 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 }
4301 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004302 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004303 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004304 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004305
4306 if (eap->cmdidx == CMD_def)
4307 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004308 int lnum_save = SOURCING_LNUM;
4309 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004310
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004311 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004312
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004313 // error messages are for the first function line
4314 SOURCING_LNUM = sourcing_lnum_top;
4315
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004316 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004317 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004318 int count = cstack->cs_idx + 1;
4319 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004320
4321 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004322 // a block that is visible now but not when the function is called
4323 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004324 fp->uf_block_ids = ALLOC_MULT(int, count);
4325 if (fp->uf_block_ids != NULL)
4326 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004327 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004328 sizeof(int) * count);
4329 fp->uf_block_depth = count;
4330 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004331
4332 // Set flag in each block to indicate a function was defined. This
4333 // is used to keep the variable when leaving the block, see
4334 // hide_script_var().
4335 for (i = 0; i <= cstack->cs_idx; ++i)
4336 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004337 }
4338
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004339 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004340 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004341 SOURCING_LNUM = lnum_save;
4342 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004343 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004344 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004345
4346 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004347 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004348 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004349 SOURCING_LNUM = lnum_save;
4350 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004351 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004352 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004353 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004354 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004355 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004356
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004358 if ((flags & FC_CLOSURE) != 0)
4359 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004360 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004361 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004362 }
4363 else
4364 fp->uf_scoped = NULL;
4365
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 if (prof_def_func())
4368 func_do_profile(fp);
4369#endif
4370 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004371 if (sandbox)
4372 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004373 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004374 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375 fp->uf_flags = flags;
4376 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004377 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004378 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004379 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004380 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004381 if (is_export)
4382 {
4383 fp->uf_flags |= FC_EXPORT;
4384 // let ex_export() know the export worked.
4385 is_export = FALSE;
4386 }
4387
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004388 if (eap->cmdidx == CMD_def)
4389 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004390 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4391 // :func does not use Vim9 script syntax, even in a Vim9 script file
4392 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004393
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 goto ret_free;
4395
4396erret:
4397 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004398 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004399 if (fp != NULL)
4400 {
4401 ga_init(&fp->uf_args);
4402 ga_init(&fp->uf_def_args);
4403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404errret_2:
4405 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004406 if (fp != NULL)
4407 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004409 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004410 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004412 if (name != name_arg)
4413 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004414 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004416
4417 return fp;
4418}
4419
4420/*
4421 * ":function"
4422 */
4423 void
4424ex_function(exarg_T *eap)
4425{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004426 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004427}
4428
4429/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004430 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004431 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004432 */
4433 void
4434ex_defcompile(exarg_T *eap UNUSED)
4435{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004436 long todo = (long)func_hashtab.ht_used;
4437 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004438 hashitem_T *hi;
4439 ufunc_T *ufunc;
4440
4441 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4442 {
4443 if (!HASHITEM_EMPTY(hi))
4444 {
4445 --todo;
4446 ufunc = HI2UF(hi);
4447 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004448 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4449 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004450 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004451 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004452
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004453 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004454 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004455 // a function has been added or removed, need to start over
4456 todo = (long)func_hashtab.ht_used;
4457 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004458 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004459 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004460 }
4461 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004462 }
4463 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464}
4465
4466/*
4467 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4468 * Return 2 if "p" starts with "s:".
4469 * Return 0 otherwise.
4470 */
4471 int
4472eval_fname_script(char_u *p)
4473{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004474 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4475 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4477 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4478 return 5;
4479 if (p[0] == 's' && p[1] == ':')
4480 return 2;
4481 return 0;
4482}
4483
4484 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004485translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486{
4487 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004488 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004489 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004490}
4491
4492/*
4493 * Return TRUE when "ufunc" has old-style "..." varargs
4494 * or named varargs "...name: type".
4495 */
4496 int
4497has_varargs(ufunc_T *ufunc)
4498{
4499 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500}
4501
4502/*
4503 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004504 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004505 */
4506 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004507function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508{
4509 char_u *nm = name;
4510 char_u *p;
4511 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004512 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004513 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004515 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4516 if (no_deref)
4517 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004518 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 nm = skipwhite(nm);
4520
Bram Moolenaare38eab22019-12-05 21:50:01 +01004521 // Only accept "funcname", "funcname ", "funcname (..." and
4522 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004524 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 vim_free(p);
4526 return n;
4527}
4528
Bram Moolenaar113e1072019-01-20 15:30:40 +01004529#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530 char_u *
4531get_expanded_name(char_u *name, int check)
4532{
4533 char_u *nm = name;
4534 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004535 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004537 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004538 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004540 if (p != NULL && *nm == NUL
4541 && (!check || translated_function_exists(p, is_global)))
4542 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543
4544 vim_free(p);
4545 return NULL;
4546}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004547#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549/*
4550 * Function given to ExpandGeneric() to obtain the list of user defined
4551 * function names.
4552 */
4553 char_u *
4554get_user_func_name(expand_T *xp, int idx)
4555{
4556 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004557 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 static hashitem_T *hi;
4559 ufunc_T *fp;
4560
4561 if (idx == 0)
4562 {
4563 done = 0;
4564 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004565 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004566 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004567 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 {
4569 if (done++ > 0)
4570 ++hi;
4571 while (HASHITEM_EMPTY(hi))
4572 ++hi;
4573 fp = HI2UF(hi);
4574
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004575 // don't show dead, dict and lambda functions
4576 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004577 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004578 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579
4580 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004581 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582
4583 cat_func_name(IObuff, fp);
4584 if (xp->xp_context != EXPAND_USER_FUNC)
4585 {
4586 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004587 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588 STRCAT(IObuff, ")");
4589 }
4590 return IObuff;
4591 }
4592 return NULL;
4593}
4594
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595/*
4596 * ":delfunction {name}"
4597 */
4598 void
4599ex_delfunction(exarg_T *eap)
4600{
4601 ufunc_T *fp = NULL;
4602 char_u *p;
4603 char_u *name;
4604 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004605 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004606
4607 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004608 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4609 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610 vim_free(fudi.fd_newkey);
4611 if (name == NULL)
4612 {
4613 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004614 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004615 return;
4616 }
4617 if (!ends_excmd(*skipwhite(p)))
4618 {
4619 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004620 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004621 return;
4622 }
4623 eap->nextcmd = check_nextcmd(p);
4624 if (eap->nextcmd != NULL)
4625 *p = NUL;
4626
4627 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004628 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629 vim_free(name);
4630
4631 if (!eap->skip)
4632 {
4633 if (fp == NULL)
4634 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004635 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004636 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 return;
4638 }
4639 if (fp->uf_calls > 0)
4640 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004641 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 return;
4643 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004644 if (fp->uf_flags & FC_VIM9)
4645 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004646 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004647 return;
4648 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649
4650 if (fudi.fd_dict != NULL)
4651 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004652 // Delete the dict item that refers to the function, it will
4653 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4655 }
4656 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004657 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 // A normal function (not a numbered function or lambda) has a
4659 // refcount of 1 for the entry in the hashtable. When deleting
4660 // it and the refcount is more than one, it should be kept.
4661 // A numbered function and lambda should be kept if the refcount is
4662 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004663 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004664 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004665 // Function is still referenced somewhere. Don't free it but
4666 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004667 if (func_remove(fp))
4668 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004669 }
4670 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004671 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004672 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673 }
4674}
4675
4676/*
4677 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004678 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 */
4680 void
4681func_unref(char_u *name)
4682{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004683 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004685 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004687 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004688 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004691 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004693 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004695 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004696}
4697
4698/*
4699 * Unreference a Function: decrement the reference count and free it when it
4700 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004701 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004702 */
4703 void
4704func_ptr_unref(ufunc_T *fp)
4705{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004706 if (fp != NULL && (--fp->uf_refcount <= 0
4707 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4708 && fp->uf_partial->pt_refcount <= 1
4709 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004710 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004711 // Only delete it when it's not being used. Otherwise it's done
4712 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004713 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004714 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 }
4716}
4717
4718/*
4719 * Count a reference to a Function.
4720 */
4721 void
4722func_ref(char_u *name)
4723{
4724 ufunc_T *fp;
4725
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004726 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004728 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004729 if (fp != NULL)
4730 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004732 // Only give an error for a numbered function.
4733 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004734 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004735}
4736
4737/*
4738 * Count a reference to a Function.
4739 */
4740 void
4741func_ptr_ref(ufunc_T *fp)
4742{
4743 if (fp != NULL)
4744 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745}
4746
4747/*
4748 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4749 * referenced from anywhere that is in use.
4750 */
4751 static int
4752can_free_funccal(funccall_T *fc, int copyID)
4753{
4754 return (fc->l_varlist.lv_copyID != copyID
4755 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004756 && fc->l_avars.dv_copyID != copyID
4757 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004758}
4759
4760/*
4761 * ":return [expr]"
4762 */
4763 void
4764ex_return(exarg_T *eap)
4765{
4766 char_u *arg = eap->arg;
4767 typval_T rettv;
4768 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004769 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770
4771 if (current_funccal == NULL)
4772 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004773 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 return;
4775 }
4776
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004777 CLEAR_FIELD(evalarg);
4778 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4779
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 if (eap->skip)
4781 ++emsg_skip;
4782
4783 eap->nextcmd = NULL;
4784 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004785 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 {
4787 if (!eap->skip)
4788 returning = do_return(eap, FALSE, TRUE, &rettv);
4789 else
4790 clear_tv(&rettv);
4791 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004792 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 else if (!eap->skip)
4794 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004795 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004796 update_force_abort();
4797
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798 /*
4799 * Return unless the expression evaluation has been cancelled due to an
4800 * aborting error, an interrupt, or an exception.
4801 */
4802 if (!aborting())
4803 returning = do_return(eap, FALSE, TRUE, NULL);
4804 }
4805
Bram Moolenaare38eab22019-12-05 21:50:01 +01004806 // When skipping or the return gets pending, advance to the next command
4807 // in this line (!returning). Otherwise, ignore the rest of the line.
4808 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 if (returning)
4810 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004811 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 eap->nextcmd = check_nextcmd(arg);
4813
4814 if (eap->skip)
4815 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004816 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817}
4818
4819/*
4820 * ":1,25call func(arg1, arg2)" function call.
4821 */
4822 void
4823ex_call(exarg_T *eap)
4824{
4825 char_u *arg = eap->arg;
4826 char_u *startarg;
4827 char_u *name;
4828 char_u *tofree;
4829 int len;
4830 typval_T rettv;
4831 linenr_T lnum;
4832 int doesrange;
4833 int failed = FALSE;
4834 funcdict_T fudi;
4835 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004836 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004837 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838
Bram Moolenaare6b53242020-07-01 17:28:33 +02004839 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840 if (eap->skip)
4841 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004842 // trans_function_name() doesn't work well when skipping, use eval0()
4843 // instead to skip to any following command, e.g. for:
4844 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004846 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 clear_tv(&rettv);
4848 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004849 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 return;
4851 }
4852
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004853 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4854 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 if (fudi.fd_newkey != NULL)
4856 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004857 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004858 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859 vim_free(fudi.fd_newkey);
4860 }
4861 if (tofree == NULL)
4862 return;
4863
Bram Moolenaare38eab22019-12-05 21:50:01 +01004864 // Increase refcount on dictionary, it could get deleted when evaluating
4865 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866 if (fudi.fd_dict != NULL)
4867 ++fudi.fd_dict->dv_refcount;
4868
Bram Moolenaare38eab22019-12-05 21:50:01 +01004869 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4870 // contents. For VAR_PARTIAL get its partial, unless we already have one
4871 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004872 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004873 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4874 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875
Bram Moolenaare38eab22019-12-05 21:50:01 +01004876 // Skip white space to allow ":call func ()". Not good, but required for
4877 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004878 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004879 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880
4881 if (*startarg != '(')
4882 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004883 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004884 goto end;
4885 }
4886
4887 /*
4888 * When skipping, evaluate the function once, to find the end of the
4889 * arguments.
4890 * When the function takes a range, this is discovered after the first
4891 * call, and the loop is broken.
4892 */
4893 if (eap->skip)
4894 {
4895 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004896 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004897 }
4898 else
4899 lnum = eap->line1;
4900 for ( ; lnum <= eap->line2; ++lnum)
4901 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004902 funcexe_T funcexe;
4903
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904 if (!eap->skip && eap->addr_count > 0)
4905 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004906 if (lnum > curbuf->b_ml.ml_line_count)
4907 {
4908 // If the function deleted lines or switched to another buffer
4909 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02004910 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004911 break;
4912 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 curwin->w_cursor.lnum = lnum;
4914 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916 }
4917 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004918
Bram Moolenaara80faa82020-04-12 19:37:17 +02004919 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004920 funcexe.firstline = eap->line1;
4921 funcexe.lastline = eap->line2;
4922 funcexe.doesrange = &doesrange;
4923 funcexe.evaluate = !eap->skip;
4924 funcexe.partial = partial;
4925 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004926 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004927 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004928 {
4929 failed = TRUE;
4930 break;
4931 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004932 if (has_watchexpr())
4933 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004935 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004936 if (handle_subscript(&arg, &rettv,
4937 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938 {
4939 failed = TRUE;
4940 break;
4941 }
4942
4943 clear_tv(&rettv);
4944 if (doesrange || eap->skip)
4945 break;
4946
Bram Moolenaare38eab22019-12-05 21:50:01 +01004947 // Stop when immediately aborting on error, or when an interrupt
4948 // occurred or an exception was thrown but not caught.
4949 // get_func_tv() returned OK, so that the check for trailing
4950 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951 if (aborting())
4952 break;
4953 }
4954 if (eap->skip)
4955 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004956 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957
Bram Moolenaare51bb172020-02-16 19:42:23 +01004958 // When inside :try we need to check for following "| catch".
4959 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004960 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004961 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004962 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004963 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004964 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004965 if (!failed)
4966 {
4967 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004968 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004969 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970 }
4971 else
4972 eap->nextcmd = check_nextcmd(arg);
4973 }
4974
4975end:
4976 dict_unref(fudi.fd_dict);
4977 vim_free(tofree);
4978}
4979
4980/*
4981 * Return from a function. Possibly makes the return pending. Also called
4982 * for a pending return at the ":endtry" or after returning from an extra
4983 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4984 * when called due to a ":return" command. "rettv" may point to a typval_T
4985 * with the return rettv. Returns TRUE when the return can be carried out,
4986 * FALSE when the return gets pending.
4987 */
4988 int
4989do_return(
4990 exarg_T *eap,
4991 int reanimate,
4992 int is_cmd,
4993 void *rettv)
4994{
4995 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004996 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004997
4998 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004999 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000 current_funccal->returned = FALSE;
5001
5002 /*
5003 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5004 * not in its finally clause (which then is to be executed next) is found.
5005 * In this case, make the ":return" pending for execution at the ":endtry".
5006 * Otherwise, return normally.
5007 */
5008 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5009 if (idx >= 0)
5010 {
5011 cstack->cs_pending[idx] = CSTP_RETURN;
5012
5013 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005014 // A pending return again gets pending. "rettv" points to an
5015 // allocated variable with the rettv of the original ":return"'s
5016 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017 cstack->cs_rettv[idx] = rettv;
5018 else
5019 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005020 // When undoing a return in order to make it pending, get the stored
5021 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005022 if (reanimate)
5023 rettv = current_funccal->rettv;
5024
5025 if (rettv != NULL)
5026 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005027 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5029 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5030 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005031 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 }
5033 else
5034 cstack->cs_rettv[idx] = NULL;
5035
5036 if (reanimate)
5037 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005038 // The pending return value could be overwritten by a ":return"
5039 // without argument in a finally clause; reset the default
5040 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 current_funccal->rettv->v_type = VAR_NUMBER;
5042 current_funccal->rettv->vval.v_number = 0;
5043 }
5044 }
5045 report_make_pending(CSTP_RETURN, rettv);
5046 }
5047 else
5048 {
5049 current_funccal->returned = TRUE;
5050
Bram Moolenaare38eab22019-12-05 21:50:01 +01005051 // If the return is carried out now, store the return value. For
5052 // a return immediately after reanimation, the value is already
5053 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005054 if (!reanimate && rettv != NULL)
5055 {
5056 clear_tv(current_funccal->rettv);
5057 *current_funccal->rettv = *(typval_T *)rettv;
5058 if (!is_cmd)
5059 vim_free(rettv);
5060 }
5061 }
5062
5063 return idx < 0;
5064}
5065
5066/*
5067 * Free the variable with a pending return value.
5068 */
5069 void
5070discard_pending_return(void *rettv)
5071{
5072 free_tv((typval_T *)rettv);
5073}
5074
5075/*
5076 * Generate a return command for producing the value of "rettv". The result
5077 * is an allocated string. Used by report_pending() for verbose messages.
5078 */
5079 char_u *
5080get_return_cmd(void *rettv)
5081{
5082 char_u *s = NULL;
5083 char_u *tofree = NULL;
5084 char_u numbuf[NUMBUFLEN];
5085
5086 if (rettv != NULL)
5087 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5088 if (s == NULL)
5089 s = (char_u *)"";
5090
5091 STRCPY(IObuff, ":return ");
5092 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5093 if (STRLEN(s) + 8 >= IOSIZE)
5094 STRCPY(IObuff + IOSIZE - 4, "...");
5095 vim_free(tofree);
5096 return vim_strsave(IObuff);
5097}
5098
5099/*
5100 * Get next function line.
5101 * Called by do_cmdline() to get the next line.
5102 * Returns allocated string, or NULL for end of function.
5103 */
5104 char_u *
5105get_func_line(
5106 int c UNUSED,
5107 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005108 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005109 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110{
5111 funccall_T *fcp = (funccall_T *)cookie;
5112 ufunc_T *fp = fcp->func;
5113 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005114 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115
Bram Moolenaare38eab22019-12-05 21:50:01 +01005116 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005117 if (fcp->dbg_tick != debug_tick)
5118 {
5119 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005120 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005121 fcp->dbg_tick = debug_tick;
5122 }
5123#ifdef FEAT_PROFILE
5124 if (do_profiling == PROF_YES)
5125 func_line_end(cookie);
5126#endif
5127
5128 gap = &fp->uf_lines;
5129 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5130 || fcp->returned)
5131 retval = NULL;
5132 else
5133 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005134 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005135 while (fcp->linenr < gap->ga_len
5136 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5137 ++fcp->linenr;
5138 if (fcp->linenr >= gap->ga_len)
5139 retval = NULL;
5140 else
5141 {
5142 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005143 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005144#ifdef FEAT_PROFILE
5145 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005146 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147#endif
5148 }
5149 }
5150
Bram Moolenaare38eab22019-12-05 21:50:01 +01005151 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005152 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005154 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005155 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005157 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005158 fcp->dbg_tick = debug_tick;
5159 }
5160
5161 return retval;
5162}
5163
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164/*
5165 * Return TRUE if the currently active function should be ended, because a
5166 * return was encountered or an error occurred. Used inside a ":while".
5167 */
5168 int
5169func_has_ended(void *cookie)
5170{
5171 funccall_T *fcp = (funccall_T *)cookie;
5172
Bram Moolenaare38eab22019-12-05 21:50:01 +01005173 // Ignore the "abort" flag if the abortion behavior has been changed due to
5174 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5176 || fcp->returned);
5177}
5178
5179/*
5180 * return TRUE if cookie indicates a function which "abort"s on errors.
5181 */
5182 int
5183func_has_abort(
5184 void *cookie)
5185{
5186 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5187}
5188
5189
5190/*
5191 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5192 * Don't do this when "Func" is already a partial that was bound
5193 * explicitly (pt_auto is FALSE).
5194 * Changes "rettv" in-place.
5195 * Returns the updated "selfdict_in".
5196 */
5197 dict_T *
5198make_partial(dict_T *selfdict_in, typval_T *rettv)
5199{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005200 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 char_u *tofree = NULL;
5202 ufunc_T *fp;
5203 char_u fname_buf[FLEN_FIXED + 1];
5204 int error;
5205 dict_T *selfdict = selfdict_in;
5206
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005207 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5208 fp = rettv->vval.v_partial->pt_func;
5209 else
5210 {
5211 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5212 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005213 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005214 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005215 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005216 vim_free(tofree);
5217 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218
5219 if (fp != NULL && (fp->uf_flags & FC_DICT))
5220 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005221 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005222
5223 if (pt != NULL)
5224 {
5225 pt->pt_refcount = 1;
5226 pt->pt_dict = selfdict;
5227 pt->pt_auto = TRUE;
5228 selfdict = NULL;
5229 if (rettv->v_type == VAR_FUNC)
5230 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005231 // Just a function: Take over the function name and use
5232 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 pt->pt_name = rettv->vval.v_string;
5234 }
5235 else
5236 {
5237 partial_T *ret_pt = rettv->vval.v_partial;
5238 int i;
5239
Bram Moolenaare38eab22019-12-05 21:50:01 +01005240 // Partial: copy the function name, use selfdict and copy
5241 // args. Can't take over name or args, the partial might
5242 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005243 if (ret_pt->pt_name != NULL)
5244 {
5245 pt->pt_name = vim_strsave(ret_pt->pt_name);
5246 func_ref(pt->pt_name);
5247 }
5248 else
5249 {
5250 pt->pt_func = ret_pt->pt_func;
5251 func_ptr_ref(pt->pt_func);
5252 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005253 if (ret_pt->pt_argc > 0)
5254 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005255 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005256 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005257 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 pt->pt_argc = 0;
5259 else
5260 {
5261 pt->pt_argc = ret_pt->pt_argc;
5262 for (i = 0; i < pt->pt_argc; i++)
5263 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5264 }
5265 }
5266 partial_unref(ret_pt);
5267 }
5268 rettv->v_type = VAR_PARTIAL;
5269 rettv->vval.v_partial = pt;
5270 }
5271 }
5272 return selfdict;
5273}
5274
5275/*
5276 * Return the name of the executed function.
5277 */
5278 char_u *
5279func_name(void *cookie)
5280{
5281 return ((funccall_T *)cookie)->func->uf_name;
5282}
5283
5284/*
5285 * Return the address holding the next breakpoint line for a funccall cookie.
5286 */
5287 linenr_T *
5288func_breakpoint(void *cookie)
5289{
5290 return &((funccall_T *)cookie)->breakpoint;
5291}
5292
5293/*
5294 * Return the address holding the debug tick for a funccall cookie.
5295 */
5296 int *
5297func_dbg_tick(void *cookie)
5298{
5299 return &((funccall_T *)cookie)->dbg_tick;
5300}
5301
5302/*
5303 * Return the nesting level for a funccall cookie.
5304 */
5305 int
5306func_level(void *cookie)
5307{
5308 return ((funccall_T *)cookie)->level;
5309}
5310
5311/*
5312 * Return TRUE when a function was ended by a ":return" command.
5313 */
5314 int
5315current_func_returned(void)
5316{
5317 return current_funccal->returned;
5318}
5319
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320 int
5321free_unref_funccal(int copyID, int testing)
5322{
5323 int did_free = FALSE;
5324 int did_free_funccal = FALSE;
5325 funccall_T *fc, **pfc;
5326
5327 for (pfc = &previous_funccal; *pfc != NULL; )
5328 {
5329 if (can_free_funccal(*pfc, copyID))
5330 {
5331 fc = *pfc;
5332 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005333 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005334 did_free = TRUE;
5335 did_free_funccal = TRUE;
5336 }
5337 else
5338 pfc = &(*pfc)->caller;
5339 }
5340 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005341 // When a funccal was freed some more items might be garbage
5342 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005343 (void)garbage_collect(testing);
5344
5345 return did_free;
5346}
5347
5348/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005349 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350 */
5351 static funccall_T *
5352get_funccal(void)
5353{
5354 int i;
5355 funccall_T *funccal;
5356 funccall_T *temp_funccal;
5357
5358 funccal = current_funccal;
5359 if (debug_backtrace_level > 0)
5360 {
5361 for (i = 0; i < debug_backtrace_level; i++)
5362 {
5363 temp_funccal = funccal->caller;
5364 if (temp_funccal)
5365 funccal = temp_funccal;
5366 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005367 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005368 debug_backtrace_level = i;
5369 }
5370 }
5371 return funccal;
5372}
5373
5374/*
5375 * Return the hashtable used for local variables in the current funccal.
5376 * Return NULL if there is no current funccal.
5377 */
5378 hashtab_T *
5379get_funccal_local_ht()
5380{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005381 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382 return NULL;
5383 return &get_funccal()->l_vars.dv_hashtab;
5384}
5385
5386/*
5387 * Return the l: scope variable.
5388 * Return NULL if there is no current funccal.
5389 */
5390 dictitem_T *
5391get_funccal_local_var()
5392{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005393 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005394 return NULL;
5395 return &get_funccal()->l_vars_var;
5396}
5397
5398/*
5399 * Return the hashtable used for argument in the current funccal.
5400 * Return NULL if there is no current funccal.
5401 */
5402 hashtab_T *
5403get_funccal_args_ht()
5404{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005405 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005406 return NULL;
5407 return &get_funccal()->l_avars.dv_hashtab;
5408}
5409
5410/*
5411 * Return the a: scope variable.
5412 * Return NULL if there is no current funccal.
5413 */
5414 dictitem_T *
5415get_funccal_args_var()
5416{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005417 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005418 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005419 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420}
5421
5422/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005423 * List function variables, if there is a function.
5424 */
5425 void
5426list_func_vars(int *first)
5427{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005428 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005429 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005430 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005431}
5432
5433/*
5434 * If "ht" is the hashtable for local variables in the current funccal, return
5435 * the dict that contains it.
5436 * Otherwise return NULL.
5437 */
5438 dict_T *
5439get_current_funccal_dict(hashtab_T *ht)
5440{
5441 if (current_funccal != NULL
5442 && ht == &current_funccal->l_vars.dv_hashtab)
5443 return &current_funccal->l_vars;
5444 return NULL;
5445}
5446
5447/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005448 * Search hashitem in parent scope.
5449 */
5450 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005451find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005452{
5453 funccall_T *old_current_funccal = current_funccal;
5454 hashtab_T *ht;
5455 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005456 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005457
5458 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5459 return NULL;
5460
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005461 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005462 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005463 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005464 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005465 ht = find_var_ht(name, &varname);
5466 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005467 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005468 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005469 if (!HASHITEM_EMPTY(hi))
5470 {
5471 *pht = ht;
5472 break;
5473 }
5474 }
5475 if (current_funccal == current_funccal->func->uf_scoped)
5476 break;
5477 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005478 }
5479 current_funccal = old_current_funccal;
5480
5481 return hi;
5482}
5483
5484/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005485 * Search variable in parent scope.
5486 */
5487 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005488find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005489{
5490 dictitem_T *v = NULL;
5491 funccall_T *old_current_funccal = current_funccal;
5492 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005493 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005494
5495 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5496 return NULL;
5497
Bram Moolenaare38eab22019-12-05 21:50:01 +01005498 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005499 current_funccal = current_funccal->func->uf_scoped;
5500 while (current_funccal)
5501 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005502 ht = find_var_ht(name, &varname);
5503 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005504 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005505 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005506 if (v != NULL)
5507 break;
5508 }
5509 if (current_funccal == current_funccal->func->uf_scoped)
5510 break;
5511 current_funccal = current_funccal->func->uf_scoped;
5512 }
5513 current_funccal = old_current_funccal;
5514
5515 return v;
5516}
5517
5518/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519 * Set "copyID + 1" in previous_funccal and callers.
5520 */
5521 int
5522set_ref_in_previous_funccal(int copyID)
5523{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005524 funccall_T *fc;
5525
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005526 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005527 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005528 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005529 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5530 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5531 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5532 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005533 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005534 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005535}
5536
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005537 static int
5538set_ref_in_funccal(funccall_T *fc, int copyID)
5539{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005540 if (fc->fc_copyID != copyID)
5541 {
5542 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005543 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5544 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5545 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5546 || set_ref_in_func(NULL, fc->func, copyID))
5547 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005548 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005549 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005550}
5551
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005552/*
5553 * Set "copyID" in all local vars and arguments in the call stack.
5554 */
5555 int
5556set_ref_in_call_stack(int copyID)
5557{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005558 funccall_T *fc;
5559 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005560
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005561 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5562 if (set_ref_in_funccal(fc, copyID))
5563 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005564
5565 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005566 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5567 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5568 if (set_ref_in_funccal(fc, copyID))
5569 return TRUE;
5570 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005571}
5572
5573/*
5574 * Set "copyID" in all functions available by name.
5575 */
5576 int
5577set_ref_in_functions(int copyID)
5578{
5579 int todo;
5580 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005581 ufunc_T *fp;
5582
5583 todo = (int)func_hashtab.ht_used;
5584 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005585 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005586 if (!HASHITEM_EMPTY(hi))
5587 {
5588 --todo;
5589 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005590 if (!func_name_refcount(fp->uf_name)
5591 && set_ref_in_func(NULL, fp, copyID))
5592 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005593 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005594 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005595 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005596}
5597
5598/*
5599 * Set "copyID" in all function arguments.
5600 */
5601 int
5602set_ref_in_func_args(int copyID)
5603{
5604 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005605
5606 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005607 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5608 copyID, NULL, NULL))
5609 return TRUE;
5610 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005611}
5612
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005613/*
5614 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005615 * Returns TRUE if setting references failed somehow.
5616 */
5617 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005618set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005619{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005620 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005621 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005622 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005623 char_u fname_buf[FLEN_FIXED + 1];
5624 char_u *tofree = NULL;
5625 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005626 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005627
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005628 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005629 return FALSE;
5630
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005631 if (fp_in == NULL)
5632 {
5633 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005634 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005635 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005636 if (fp != NULL)
5637 {
5638 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005639 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005640 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005641
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005642 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005643 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005644}
5645
Bram Moolenaare38eab22019-12-05 21:50:01 +01005646#endif // FEAT_EVAL