blob: 38930a2169206c2bd1cdf9d622c2b1a7abb38413 [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 Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
67 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010068{
Bram Moolenaar6e949782020-04-13 17:21:00 +020069 char_u *p = arg;
70 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010071
72 while (ASCII_ISALNUM(*p) || *p == '_')
73 ++p;
74 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020075 || (argtypes == NULL
76 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
77 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010078 {
79 if (!skip)
80 semsg(_("E125: Illegal argument: %s"), arg);
81 return arg;
82 }
83 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
84 return arg;
85 if (newargs != NULL)
86 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010087 int c;
88 int i;
89
90 c = *p;
91 *p = NUL;
92 arg_copy = vim_strsave(arg);
93 if (arg_copy == NULL)
94 {
95 *p = c;
96 return arg;
97 }
98
99 // Check for duplicate argument name.
100 for (i = 0; i < newargs->ga_len; ++i)
101 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
102 {
103 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
104 vim_free(arg_copy);
105 return arg;
106 }
107 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
108 newargs->ga_len++;
109
110 *p = c;
111 }
112
113 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100114 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100115 {
116 char_u *type = NULL;
117
Bram Moolenaar6e949782020-04-13 17:21:00 +0200118 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
119 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200120 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200121 arg_copy == NULL ? arg : arg_copy);
122 p = skipwhite(p);
123 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 if (*p == ':')
125 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200126 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100127 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200128 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200129 semsg(_(e_white_space_required_after_str), ":");
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200130 return arg;
131 }
132 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200133 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100134 if (!skip)
135 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100136 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100137 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200138 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200139 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200140 arg_copy == NULL ? arg : arg_copy);
141 return arg;
142 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 {
145 if (type == NULL && types_optional)
146 // lambda arguments default to "any" type
147 type = vim_strsave((char_u *)"any");
148 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
149 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
151
152 return p;
153}
154
155/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200156 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100157 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100158 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200159 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100160 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200161get_function_args(
162 char_u **argp,
163 char_u endchar,
164 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100166 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200167 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200169 int skip,
170 exarg_T *eap,
171 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200172{
173 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100174 char_u *arg;
175 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200177 int any_default = FALSE;
178 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100179 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200180
181 if (newargs != NULL)
182 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183 if (argtypes != NULL)
184 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200185 if (default_args != NULL)
186 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200187
188 if (varargs != NULL)
189 *varargs = FALSE;
190
191 /*
192 * Isolate the arguments: "arg1, arg2, ...)"
193 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100194 arg = skipwhite(*argp);
195 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196 while (*p != endchar)
197 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200198 while (eap != NULL && eap->getline != NULL
199 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200200 {
201 char_u *theline;
202
203 // End of the line, get the next one.
204 theline = eap->getline(':', eap->cookie, 0, TRUE);
205 if (theline == NULL)
206 break;
207 vim_free(*line_to_free);
208 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200209 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 p = skipwhite(theline);
211 }
212
213 if (mustend && *p != endchar)
214 {
215 if (!skip)
216 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100217 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200218 }
219 if (*p == endchar)
220 break;
221
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
223 {
224 if (varargs != NULL)
225 *varargs = TRUE;
226 p += 3;
227 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228
229 if (argtypes != NULL)
230 {
231 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200232 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100233 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100234 if (!skip)
235 emsg(_(e_missing_name_after_dots));
236 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100237 }
238
239 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100240 p = one_function_arg(p, newargs, argtypes, types_optional,
241 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242 if (p == arg)
243 break;
244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200245 }
246 else
247 {
248 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100249 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100250 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200251 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200252
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200253 if (*skipwhite(p) == '=' && default_args != NULL)
254 {
255 typval_T rettv;
256
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100257 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200258 any_default = TRUE;
259 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200260 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200261 p = skipwhite(p);
262 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200263 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200264 {
265 if (ga_grow(default_args, 1) == FAIL)
266 goto err_ret;
267
268 // trim trailing whitespace
269 while (p > expr && VIM_ISWHITE(p[-1]))
270 p--;
271 c = *p;
272 *p = NUL;
273 expr = vim_strsave(expr);
274 if (expr == NULL)
275 {
276 *p = c;
277 goto err_ret;
278 }
279 ((char_u **)(default_args->ga_data))
280 [default_args->ga_len] = expr;
281 default_args->ga_len++;
282 *p = c;
283 }
284 else
285 mustend = TRUE;
286 }
287 else if (any_default)
288 {
289 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200290 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200292 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200293 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200295 // Don't give this error when skipping, it makes the "->" not
296 // found in "{k,v -> x}" and give a confusing error.
297 if (!skip && in_vim9script()
298 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
299 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200300 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200301 goto err_ret;
302 }
303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304 else
305 mustend = TRUE;
306 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200307 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200309 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200310
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200311 if (*p != endchar)
312 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100313 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314
315 *argp = p;
316 return OK;
317
318err_ret:
319 if (newargs != NULL)
320 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200321 if (default_args != NULL)
322 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 return FAIL;
324}
325
326/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100327 * Parse the argument types, filling "fp->uf_arg_types".
328 * Return OK or FAIL.
329 */
330 static int
331parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
332{
333 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
334 if (argtypes->ga_len > 0)
335 {
336 // When "varargs" is set the last name/type goes into uf_va_name
337 // and uf_va_type.
338 int len = argtypes->ga_len - (varargs ? 1 : 0);
339
340 if (len > 0)
341 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
342 if (fp->uf_arg_types != NULL)
343 {
344 int i;
345 type_T *type;
346
347 for (i = 0; i < len; ++ i)
348 {
349 char_u *p = ((char_u **)argtypes->ga_data)[i];
350
351 if (p == NULL)
352 // will get the type from the default value
353 type = &t_unknown;
354 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100355 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100356 if (type == NULL)
357 return FAIL;
358 fp->uf_arg_types[i] = type;
359 }
360 }
361 if (varargs)
362 {
363 char_u *p;
364
365 // Move the last argument "...name: type" to uf_va_name and
366 // uf_va_type.
367 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
368 [fp->uf_args.ga_len - 1];
369 --fp->uf_args.ga_len;
370 p = ((char_u **)argtypes->ga_data)[len];
371 if (p == NULL)
372 // todo: get type from default value
373 fp->uf_va_type = &t_any;
374 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100375 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100376 if (fp->uf_va_type == NULL)
377 return FAIL;
378 }
379 }
380 return OK;
381}
382
383/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200384 * Register function "fp" as using "current_funccal" as its scope.
385 */
386 static int
387register_closure(ufunc_T *fp)
388{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200389 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100390 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200391 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200392 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200393 fp->uf_scoped = current_funccal;
394 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200395
Bram Moolenaar58016442016-07-31 18:30:22 +0200396 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
397 return FAIL;
398 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
399 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200400 return OK;
401}
402
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100403 static void
404set_ufunc_name(ufunc_T *fp, char_u *name)
405{
406 STRCPY(fp->uf_name, name);
407
408 if (name[0] == K_SPECIAL)
409 {
410 fp->uf_name_exp = alloc(STRLEN(name) + 3);
411 if (fp->uf_name_exp != NULL)
412 {
413 STRCPY(fp->uf_name_exp, "<SNR>");
414 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
415 }
416 }
417}
418
Bram Moolenaar58016442016-07-31 18:30:22 +0200419/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200420 * Get a name for a lambda. Returned in static memory.
421 */
422 char_u *
423get_lambda_name(void)
424{
425 static char_u name[30];
426 static int lambda_no = 0;
427
428 sprintf((char*)name, "<lambda>%d", ++lambda_no);
429 return name;
430}
431
Bram Moolenaar801ab062020-06-25 19:27:56 +0200432#if defined(FEAT_LUA) || defined(PROTO)
433/*
434 * Registers a native C callback which can be called from Vim script.
435 * Returns the name of the Vim script function.
436 */
437 char_u *
438register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
439{
440 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200441 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200442
443 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
444 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200445 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200446
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200447 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200448 fp->uf_refcount = 1;
449 fp->uf_varargs = TRUE;
450 fp->uf_flags = FC_CFUNC;
451 fp->uf_calls = 0;
452 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200453 fp->uf_cb = cb;
454 fp->uf_cb_free = cb_free;
455 fp->uf_cb_state = state;
456
457 set_ufunc_name(fp, name);
458 hash_add(&func_hashtab, UF2HIKEY(fp));
459
460 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200461}
462#endif
463
Bram Moolenaar04b12692020-05-04 23:24:44 +0200464/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100465 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100466 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100467 * If "white_error" is not NULL check for correct use of white space and set
468 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100469 * Return NULL if no valid arrow found.
470 */
471 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100472skip_arrow(
473 char_u *start,
474 int equal_arrow,
475 char_u **ret_type,
476 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100477{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100478 char_u *s = start;
479 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100480
481 if (equal_arrow)
482 {
483 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100484 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100485 if (white_error != NULL && !VIM_ISWHITE(s[1]))
486 {
487 *white_error = TRUE;
488 semsg(_(e_white_space_required_after_str), ":");
489 return NULL;
490 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100491 s = skipwhite(s + 1);
492 *ret_type = s;
493 s = skip_type(s, TRUE);
494 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100495 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100496 s = skipwhite(s);
497 if (*s != '=')
498 return NULL;
499 ++s;
500 }
501 if (*s != '>')
502 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100503 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
504 || !IS_WHITE_OR_NUL(s[1])))
505 {
506 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100507 semsg(_(e_white_space_required_before_and_after_str_at_str),
508 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100509 return NULL;
510 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100511 return skipwhite(s + 1);
512}
513
514/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200515 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100516 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100517 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200518 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
519 */
520 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100521get_lambda_tv(
522 char_u **arg,
523 typval_T *rettv,
524 int types_optional,
525 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200526{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200527 int evaluate = evalarg != NULL
528 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200529 garray_T newargs;
530 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200531 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100532 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200533 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100534 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200535 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100536 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200538 char_u *s;
539 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200540 int *old_eval_lavars = eval_lavars_used;
541 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200542 char_u *tofree = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100543 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100544 int white_error = FALSE;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545
546 if (equal_arrow && !in_vim9script())
547 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200548
549 ga_init(&newargs);
550 ga_init(&newlines);
551
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100552 // First, check if this is really a lambda expression. "->" or "=>" must
553 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100554 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100555 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100556 types_optional ? &argtypes : NULL, types_optional,
557 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100558 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100559 {
560 if (types_optional)
561 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200562 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200564
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100565 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200566 if (evaluate)
567 pnewargs = &newargs;
568 else
569 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100570 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100571 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100572 types_optional ? &argtypes : NULL, types_optional,
573 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100574 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100575 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100576 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100577 {
578 if (types_optional)
579 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100580 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100581 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100582 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100583 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200584
Bram Moolenaare38eab22019-12-05 21:50:01 +0100585 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200586 if (evaluate)
587 eval_lavars_used = &eval_lavars;
588
Bram Moolenaar65c44152020-12-24 15:14:01 +0100589 *arg = skipwhite_and_linebreak(*arg, evalarg);
590
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100591 // Recognize "{" as the start of a function body.
592 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100593 {
594 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100595 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100596 emsg("Lambda function body not supported yet");
597 goto errret;
598 }
599
Bram Moolenaare38eab22019-12-05 21:50:01 +0100600 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200601 start = *arg;
602 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200603 if (ret == FAIL)
604 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200605 if (evalarg != NULL)
606 {
607 // avoid that the expression gets freed when another line break follows
608 tofree = evalarg->eval_tofree;
609 evalarg->eval_tofree = NULL;
610 }
611
Bram Moolenaar65c44152020-12-24 15:14:01 +0100612 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100613 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100614 *arg = skipwhite_and_linebreak(*arg, evalarg);
615 if (**arg != '}')
616 {
617 semsg(_("E451: Expected }: %s"), *arg);
618 goto errret;
619 }
620 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200622
623 if (evaluate)
624 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200625 int len;
626 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200627 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200628 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200629
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200630 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200631 if (fp == NULL)
632 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200633 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200634 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200635 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200636 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200637
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200638 ga_init2(&newlines, (int)sizeof(char_u *), 1);
639 if (ga_grow(&newlines, 1) == FAIL)
640 goto errret;
641
Bram Moolenaare38eab22019-12-05 21:50:01 +0100642 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200643 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200644 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645 if (p == NULL)
646 goto errret;
647 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
648 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200649 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200650 if (strstr((char *)p + 7, "a:") == NULL)
651 // No a: variables are used for sure.
652 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653
654 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100655 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200656 hash_add(&func_hashtab, UF2HIKEY(fp));
657 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200658 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100659 if (types_optional)
660 {
661 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
662 goto errret;
663 if (ret_type != NULL)
664 {
665 fp->uf_ret_type = parse_type(&ret_type,
666 &fp->uf_type_list, TRUE);
667 if (fp->uf_ret_type == NULL)
668 goto errret;
669 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100670 else
671 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100672 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100673
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200674 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200675 if (current_funccal != NULL && eval_lavars)
676 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200677 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200678 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200679 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200681
682#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200683 if (prof_def_func())
684 func_do_profile(fp);
685#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200686 if (sandbox)
687 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100688 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200689 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200690 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200692 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100693 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200694
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200695 pt->pt_func = fp;
696 pt->pt_refcount = 1;
697 rettv->vval.v_partial = pt;
698 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200699 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200700
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200701 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200702 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200703 evalarg->eval_tofree = tofree;
704 else
705 vim_free(tofree);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100706 if (types_optional)
707 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200708 return OK;
709
710errret:
711 ga_clear_strings(&newargs);
712 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100713 if (types_optional)
714 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200715 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100716 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200717 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200718 evalarg->eval_tofree = tofree;
719 else
720 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200721 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200722 return FAIL;
723}
724
725/*
726 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
727 * name it contains, otherwise return "name".
728 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
729 * "partialp".
730 */
731 char_u *
732deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
733{
734 dictitem_T *v;
735 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200736 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200737
738 if (partialp != NULL)
739 *partialp = NULL;
740
741 cc = name[*lenp];
742 name[*lenp] = NUL;
743 v = find_var(name, NULL, no_autoload);
744 name[*lenp] = cc;
745 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
746 {
747 if (v->di_tv.vval.v_string == NULL)
748 {
749 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100750 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200751 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200752 s = v->di_tv.vval.v_string;
753 *lenp = (int)STRLEN(s);
754 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200755 }
756
757 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
758 {
759 partial_T *pt = v->di_tv.vval.v_partial;
760
761 if (pt == NULL)
762 {
763 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100764 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200765 }
766 if (partialp != NULL)
767 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200768 s = partial_name(pt);
769 *lenp = (int)STRLEN(s);
770 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200771 }
772
773 return name;
774}
775
776/*
777 * Give an error message with a function name. Handle <SNR> things.
778 * "ermsg" is to be passed without translation, use N_() instead of _().
779 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100780 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200781emsg_funcname(char *ermsg, char_u *name)
782{
783 char_u *p;
784
785 if (*name == K_SPECIAL)
786 p = concat_str((char_u *)"<SNR>", name + 3);
787 else
788 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100789 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200790 if (p != name)
791 vim_free(p);
792}
793
794/*
795 * Allocate a variable for the result of a function.
796 * Return OK or FAIL.
797 */
798 int
799get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200800 char_u *name, // name of the function
801 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200802 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200803 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200804 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200805 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200806{
807 char_u *argp;
808 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100809 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
810 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200811 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200812
813 /*
814 * Get the arguments.
815 */
816 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200817 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
818 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200819 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200820 // skip the '(' or ',' and possibly line breaks
821 argp = skipwhite_and_linebreak(argp + 1, evalarg);
822
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200823 if (*argp == ')' || *argp == ',' || *argp == NUL)
824 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200825 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200826 {
827 ret = FAIL;
828 break;
829 }
830 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200831 // The comma should come right after the argument, but this wasn't
832 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200833 if (vim9script)
834 {
835 if (*argp != ',' && *skipwhite(argp) == ',')
836 {
837 semsg(_(e_no_white_space_allowed_before_str), ",");
838 ret = FAIL;
839 break;
840 }
841 }
842 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200843 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200844 if (*argp != ',')
845 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200846 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
847 {
848 semsg(_(e_white_space_required_after_str), ",");
849 ret = FAIL;
850 break;
851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200852 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200853 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200854 if (*argp == ')')
855 ++argp;
856 else
857 ret = FAIL;
858
859 if (ret == OK)
860 {
861 int i = 0;
862
863 if (get_vim_var_nr(VV_TESTING))
864 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100865 // Prepare for calling test_garbagecollect_now(), need to know
866 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200867 if (funcargs.ga_itemsize == 0)
868 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
869 for (i = 0; i < argcount; ++i)
870 if (ga_grow(&funcargs, 1) == OK)
871 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
872 &argvars[i];
873 }
874
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200875 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200876
877 funcargs.ga_len -= i;
878 }
879 else if (!aborting())
880 {
881 if (argcount == MAX_FUNC_ARGS)
882 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
883 else
884 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
885 }
886
887 while (--argcount >= 0)
888 clear_tv(&argvars[argcount]);
889
Bram Moolenaar8294d492020-08-10 22:40:56 +0200890 if (in_vim9script())
891 *arg = argp;
892 else
893 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200894 return ret;
895}
896
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200897/*
898 * Return TRUE if "p" starts with "<SID>" or "s:".
899 * Only works if eval_fname_script() returned non-zero for "p"!
900 */
901 static int
902eval_fname_sid(char_u *p)
903{
904 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
905}
906
907/*
908 * In a script change <SID>name() and s:name() to K_SNR 123_name().
909 * Change <SNR>123_name() to K_SNR 123_name().
910 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
911 * (slow).
912 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100913 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200914fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
915{
916 int llen;
917 char_u *fname;
918 int i;
919
920 llen = eval_fname_script(name);
921 if (llen > 0)
922 {
923 fname_buf[0] = K_SPECIAL;
924 fname_buf[1] = KS_EXTRA;
925 fname_buf[2] = (int)KE_SNR;
926 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100927 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200928 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200929 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100930 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200931 else
932 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200933 sprintf((char *)fname_buf + 3, "%ld_",
934 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200935 i = (int)STRLEN(fname_buf);
936 }
937 }
938 if (i + STRLEN(name + llen) < FLEN_FIXED)
939 {
940 STRCPY(fname_buf + i, name + llen);
941 fname = fname_buf;
942 }
943 else
944 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200945 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200946 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100947 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200948 else
949 {
950 *tofree = fname;
951 mch_memmove(fname, fname_buf, (size_t)i);
952 STRCPY(fname + i, name + llen);
953 }
954 }
955 }
956 else
957 fname = name;
958 return fname;
959}
960
961/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100962 * Find a function "name" in script "sid".
963 */
964 static ufunc_T *
965find_func_with_sid(char_u *name, int sid)
966{
967 hashitem_T *hi;
968 char_u buffer[200];
969
970 buffer[0] = K_SPECIAL;
971 buffer[1] = KS_EXTRA;
972 buffer[2] = (int)KE_SNR;
973 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
974 (long)sid, name);
975 hi = hash_find(&func_hashtab, buffer);
976 if (!HASHITEM_EMPTY(hi))
977 return HI2UF(hi);
978
979 return NULL;
980}
981
982/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200983 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200984 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200985 * Return NULL for unknown function.
986 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200987 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200988find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200989{
990 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100991 ufunc_T *func;
992 imported_T *imported;
993
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200994 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100995 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200996 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200997 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +0200998 int find_script_local = in_vim9script()
999 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001000
Bram Moolenaar95006e32020-08-29 17:47:08 +02001001 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001002 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001003 // Find script-local function before global one.
1004 func = find_func_with_sid(name, current_sctx.sc_sid);
1005 if (func != NULL)
1006 return func;
1007 }
1008
Bram Moolenaarefa94442020-08-08 22:16:00 +02001009 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001010 && name[1] == KS_EXTRA
1011 && name[2] == KE_SNR)
1012 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001013 // Caller changes s: to <SNR>99_name.
1014
1015 after_script = name + 3;
1016 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001017 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001018 ++after_script;
1019 else
1020 after_script = NULL;
1021 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001022 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001023 {
1024 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001025 if (after_script != NULL && sid != current_sctx.sc_sid)
1026 imported = find_imported_in_script(after_script, 0, sid);
1027 else
1028 imported = find_imported(after_script == NULL
1029 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001030 if (imported != NULL && imported->imp_funcname != NULL)
1031 {
1032 hi = hash_find(&func_hashtab, imported->imp_funcname);
1033 if (!HASHITEM_EMPTY(hi))
1034 return HI2UF(hi);
1035 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001036 }
1037 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001038
Bram Moolenaara26b9702020-04-18 19:53:28 +02001039 hi = hash_find(&func_hashtab,
1040 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001041 if (!HASHITEM_EMPTY(hi))
1042 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001043
1044 return NULL;
1045}
1046
1047/*
1048 * Find a function by name, return pointer to it in ufuncs.
1049 * "cctx" is passed in a :def function to find imported functions.
1050 * Return NULL for unknown or dead function.
1051 */
1052 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001053find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001054{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001055 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001056
1057 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1058 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001059 return NULL;
1060}
1061
1062/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001063 * Return TRUE if "ufunc" is a global function.
1064 */
1065 int
1066func_is_global(ufunc_T *ufunc)
1067{
1068 return ufunc->uf_name[0] != K_SPECIAL;
1069}
1070
1071/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001072 * Copy the function name of "fp" to buffer "buf".
1073 * "buf" must be able to hold the function name plus three bytes.
1074 * Takes care of script-local function names.
1075 */
1076 static void
1077cat_func_name(char_u *buf, ufunc_T *fp)
1078{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001079 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080 {
1081 STRCPY(buf, "<SNR>");
1082 STRCAT(buf, fp->uf_name + 3);
1083 }
1084 else
1085 STRCPY(buf, fp->uf_name);
1086}
1087
1088/*
1089 * Add a number variable "name" to dict "dp" with value "nr".
1090 */
1091 static void
1092add_nr_var(
1093 dict_T *dp,
1094 dictitem_T *v,
1095 char *name,
1096 varnumber_T nr)
1097{
1098 STRCPY(v->di_key, name);
1099 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1100 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1101 v->di_tv.v_type = VAR_NUMBER;
1102 v->di_tv.v_lock = VAR_FIXED;
1103 v->di_tv.vval.v_number = nr;
1104}
1105
1106/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001107 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001108 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001109 static void
1110free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001112 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001113
1114 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1115 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001116 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001117
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001118 // When garbage collecting a funccall_T may be freed before the
1119 // function that references it, clear its uf_scoped field.
1120 // The function may have been redefined and point to another
1121 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001122 if (fp != NULL && fp->uf_scoped == fc)
1123 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001124 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001125 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001126
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001127 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001128 vim_free(fc);
1129}
1130
1131/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001132 * Free "fc" and what it contains.
1133 * Can be called only when "fc" is kept beyond the period of it called,
1134 * i.e. after cleanup_function_call(fc).
1135 */
1136 static void
1137free_funccal_contents(funccall_T *fc)
1138{
1139 listitem_T *li;
1140
1141 // Free all l: variables.
1142 vars_clear(&fc->l_vars.dv_hashtab);
1143
1144 // Free all a: variables.
1145 vars_clear(&fc->l_avars.dv_hashtab);
1146
1147 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001148 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001149 clear_tv(&li->li_tv);
1150
1151 free_funccal(fc);
1152}
1153
1154/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001155 * Handle the last part of returning from a function: free the local hashtable.
1156 * Unless it is still in use by a closure.
1157 */
1158 static void
1159cleanup_function_call(funccall_T *fc)
1160{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001161 int may_free_fc = fc->fc_refcount <= 0;
1162 int free_fc = TRUE;
1163
Bram Moolenaar6914c642017-04-01 21:21:30 +02001164 current_funccal = fc->caller;
1165
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001166 // Free all l: variables if not referred.
1167 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1168 vars_clear(&fc->l_vars.dv_hashtab);
1169 else
1170 free_fc = FALSE;
1171
1172 // If the a:000 list and the l: and a: dicts are not referenced and
1173 // there is no closure using it, we can free the funccall_T and what's
1174 // in it.
1175 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1176 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001177 else
1178 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001179 int todo;
1180 hashitem_T *hi;
1181 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001182
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001183 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001184
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001185 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001186 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1187 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1188 {
1189 if (!HASHITEM_EMPTY(hi))
1190 {
1191 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001192 di = HI2DI(hi);
1193 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001194 }
1195 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001196 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001197
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001198 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1199 fc->l_varlist.lv_first = NULL;
1200 else
1201 {
1202 listitem_T *li;
1203
1204 free_fc = FALSE;
1205
1206 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001207 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001208 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001209 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001210
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001211 if (free_fc)
1212 free_funccal(fc);
1213 else
1214 {
1215 static int made_copy = 0;
1216
1217 // "fc" is still in use. This can happen when returning "a:000",
1218 // assigning "l:" to a global variable or defining a closure.
1219 // Link "fc" in the list for garbage collection later.
1220 fc->caller = previous_funccal;
1221 previous_funccal = fc;
1222
1223 if (want_garbage_collect)
1224 // If garbage collector is ready, clear count.
1225 made_copy = 0;
1226 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001227 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001228 // We have made a lot of copies, worth 4 Mbyte. This can happen
1229 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001230 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001231 // too much memory.
1232 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001233 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001234 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001235 }
1236}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001237
1238/*
1239 * There are two kinds of function names:
1240 * 1. ordinary names, function defined with :function or :def
1241 * 2. numbered functions and lambdas
1242 * For the first we only count the name stored in func_hashtab as a reference,
1243 * using function() does not count as a reference, because the function is
1244 * looked up by name.
1245 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001246 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001247func_name_refcount(char_u *name)
1248{
1249 return isdigit(*name) || *name == '<';
1250}
1251
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001252/*
1253 * Unreference "fc": decrement the reference count and free it when it
1254 * becomes zero. "fp" is detached from "fc".
1255 * When "force" is TRUE we are exiting.
1256 */
1257 static void
1258funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1259{
1260 funccall_T **pfc;
1261 int i;
1262
1263 if (fc == NULL)
1264 return;
1265
1266 if (--fc->fc_refcount <= 0 && (force || (
1267 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1268 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1269 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1270 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1271 {
1272 if (fc == *pfc)
1273 {
1274 *pfc = fc->caller;
1275 free_funccal_contents(fc);
1276 return;
1277 }
1278 }
1279 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1280 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1281 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1282}
1283
1284/*
1285 * Remove the function from the function hashtable. If the function was
1286 * deleted while it still has references this was already done.
1287 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1288 */
1289 static int
1290func_remove(ufunc_T *fp)
1291{
1292 hashitem_T *hi;
1293
1294 // Return if it was already virtually deleted.
1295 if (fp->uf_flags & FC_DEAD)
1296 return FALSE;
1297
1298 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1299 if (!HASHITEM_EMPTY(hi))
1300 {
1301 // When there is a def-function index do not actually remove the
1302 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001303 // Do remove it when it's a copy.
1304 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001305 fp->uf_flags |= FC_DEAD;
1306 else
1307 hash_remove(&func_hashtab, hi);
1308 return TRUE;
1309 }
1310 return FALSE;
1311}
1312
1313 static void
1314func_clear_items(ufunc_T *fp)
1315{
1316 ga_clear_strings(&(fp->uf_args));
1317 ga_clear_strings(&(fp->uf_def_args));
1318 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001319 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001320 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001321 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001322 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001323 clear_type_list(&fp->uf_type_list);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001324 partial_unref(fp->uf_partial);
1325 fp->uf_partial = NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001326
1327#ifdef FEAT_LUA
1328 if (fp->uf_cb_free != NULL)
1329 {
1330 fp->uf_cb_free(fp->uf_cb_state);
1331 fp->uf_cb_free = NULL;
1332 }
1333
1334 fp->uf_cb_state = NULL;
1335 fp->uf_cb = NULL;
1336#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001337#ifdef FEAT_PROFILE
1338 VIM_CLEAR(fp->uf_tml_count);
1339 VIM_CLEAR(fp->uf_tml_total);
1340 VIM_CLEAR(fp->uf_tml_self);
1341#endif
1342}
1343
1344/*
1345 * Free all things that a function contains. Does not free the function
1346 * itself, use func_free() for that.
1347 * When "force" is TRUE we are exiting.
1348 */
1349 static void
1350func_clear(ufunc_T *fp, int force)
1351{
1352 if (fp->uf_cleared)
1353 return;
1354 fp->uf_cleared = TRUE;
1355
1356 // clear this function
1357 func_clear_items(fp);
1358 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001359 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001360}
1361
1362/*
1363 * Free a function and remove it from the list of functions. Does not free
1364 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001365 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001366 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001367 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001368 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001369func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001370{
1371 // Only remove it when not done already, otherwise we would remove a newer
1372 // version of the function with the same name.
1373 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1374 func_remove(fp);
1375
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001376 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001377 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001378 if (fp->uf_dfunc_idx > 0)
1379 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001380 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001381 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001382 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001383 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001384 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001385}
1386
1387/*
1388 * Free all things that a function contains and free the function itself.
1389 * When "force" is TRUE we are exiting.
1390 */
1391 static void
1392func_clear_free(ufunc_T *fp, int force)
1393{
1394 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001395 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1396 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001397 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001398 else
1399 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001400}
1401
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001402/*
1403 * Copy already defined function "lambda" to a new function with name "global".
1404 * This is for when a compiled function defines a global function.
1405 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001406 int
1407copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001408{
1409 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001410 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001411
1412 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001413 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001414 semsg(_(e_lambda_function_not_found_str), lambda);
1415 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001416 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001417
1418 // TODO: handle ! to overwrite
1419 fp = find_func(global, TRUE, NULL);
1420 if (fp != NULL)
1421 {
1422 semsg(_(e_funcexts), global);
1423 return FAIL;
1424 }
1425
1426 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1427 if (fp == NULL)
1428 return FAIL;
1429
1430 fp->uf_varargs = ufunc->uf_varargs;
1431 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1432 fp->uf_def_status = ufunc->uf_def_status;
1433 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1434 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1435 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1436 == FAIL
1437 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1438 goto failed;
1439
1440 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1441 : vim_strsave(ufunc->uf_name_exp);
1442 if (ufunc->uf_arg_types != NULL)
1443 {
1444 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1445 if (fp->uf_arg_types == NULL)
1446 goto failed;
1447 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1448 sizeof(type_T *) * fp->uf_args.ga_len);
1449 }
1450 if (ufunc->uf_def_arg_idx != NULL)
1451 {
1452 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1453 if (fp->uf_def_arg_idx == NULL)
1454 goto failed;
1455 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1456 sizeof(int) * fp->uf_def_args.ga_len + 1);
1457 }
1458 if (ufunc->uf_va_name != NULL)
1459 {
1460 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1461 if (fp->uf_va_name == NULL)
1462 goto failed;
1463 }
1464 fp->uf_ret_type = ufunc->uf_ret_type;
1465
1466 fp->uf_refcount = 1;
1467 STRCPY(fp->uf_name, global);
1468 hash_add(&func_hashtab, UF2HIKEY(fp));
1469
1470 // the referenced dfunc_T is now used one more time
1471 link_def_function(fp);
1472
1473 // Create a partial to store the context of the function, if not done
1474 // already.
1475 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1476 {
1477 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1478
1479 if (pt == NULL)
1480 goto failed;
1481 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
1482 goto failed;
1483 ufunc->uf_partial = pt;
1484 --pt->pt_refcount; // not referenced here yet
1485 }
1486 if (ufunc->uf_partial != NULL)
1487 {
1488 fp->uf_partial = ufunc->uf_partial;
1489 ++fp->uf_partial->pt_refcount;
1490 }
1491
1492 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001493
1494failed:
1495 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001496 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001497}
1498
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001499static int funcdepth = 0;
1500
1501/*
1502 * Increment the function call depth count.
1503 * Return FAIL when going over 'maxfuncdepth'.
1504 * Otherwise return OK, must call funcdepth_decrement() later!
1505 */
1506 int
1507funcdepth_increment(void)
1508{
1509 if (funcdepth >= p_mfd)
1510 {
1511 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1512 return FAIL;
1513 }
1514 ++funcdepth;
1515 return OK;
1516}
1517
1518 void
1519funcdepth_decrement(void)
1520{
1521 --funcdepth;
1522}
1523
1524/*
1525 * Get the current function call depth.
1526 */
1527 int
1528funcdepth_get(void)
1529{
1530 return funcdepth;
1531}
1532
1533/*
1534 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001535 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001536 * times as funcdepth_increment().
1537 */
1538 void
1539funcdepth_restore(int depth)
1540{
1541 funcdepth = depth;
1542}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001543
1544/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001545 * Call a user function.
1546 */
1547 static void
1548call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001549 ufunc_T *fp, // pointer to function
1550 int argcount, // nr of args
1551 typval_T *argvars, // arguments
1552 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001553 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001554 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001556 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001557 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001558 funccall_T *fc;
1559 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001560 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001562 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 int i;
1564 int ai;
1565 int islambda = FALSE;
1566 char_u numbuf[NUMBUFLEN];
1567 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001568#ifdef FEAT_PROFILE
1569 proftime_T wait_start;
1570 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001571 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001573 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001575 // If depth of calling is getting too high, don't execute the function.
1576 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001578 rettv->v_type = VAR_NUMBER;
1579 rettv->vval.v_number = -1;
1580 return;
1581 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582
Bram Moolenaare38eab22019-12-05 21:50:01 +01001583 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001585 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001586 if (fc == NULL)
1587 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588 fc->caller = current_funccal;
1589 current_funccal = fc;
1590 fc->func = fp;
1591 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001592 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001593 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1595 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001596 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001597 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001598 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001600 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001601 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001602 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001603 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001604 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001605 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001606 free_funccal(fc);
1607 return;
1608 }
1609
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1611 islambda = TRUE;
1612
1613 /*
1614 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1615 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1616 * each argument variable and saves a lot of time.
1617 */
1618 /*
1619 * Init l: variables.
1620 */
1621 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1622 if (selfdict != NULL)
1623 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001624 // Set l:self to "selfdict". Use "name" to avoid a warning from
1625 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626 v = &fc->fixvar[fixvar_idx++].var;
1627 name = v->di_key;
1628 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001629 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1631 v->di_tv.v_type = VAR_DICT;
1632 v->di_tv.v_lock = 0;
1633 v->di_tv.vval.v_dict = selfdict;
1634 ++selfdict->dv_refcount;
1635 }
1636
1637 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001638 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001639 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 * Set a:000 to a list with room for the "..." arguments.
1641 */
1642 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001643 if ((fp->uf_flags & FC_NOARGS) == 0)
1644 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001645 (varnumber_T)(argcount >= fp->uf_args.ga_len
1646 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001647 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001648 if ((fp->uf_flags & FC_NOARGS) == 0)
1649 {
1650 // Use "name" to avoid a warning from some compiler that checks the
1651 // destination size.
1652 v = &fc->fixvar[fixvar_idx++].var;
1653 name = v->di_key;
1654 STRCPY(name, "000");
1655 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1656 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1657 v->di_tv.v_type = VAR_LIST;
1658 v->di_tv.v_lock = VAR_FIXED;
1659 v->di_tv.vval.v_list = &fc->l_varlist;
1660 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001661 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001662 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1663 fc->l_varlist.lv_lock = VAR_FIXED;
1664
1665 /*
1666 * Set a:firstline to "firstline" and a:lastline to "lastline".
1667 * Set a:name to named arguments.
1668 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001669 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001670 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001671 if ((fp->uf_flags & FC_NOARGS) == 0)
1672 {
1673 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001674 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001675 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001676 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001677 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001678 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679 {
1680 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001681 typval_T def_rettv;
1682 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683
1684 ai = i - fp->uf_args.ga_len;
1685 if (ai < 0)
1686 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001687 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 name = FUNCARG(fp, i);
1689 if (islambda)
1690 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001691
1692 // evaluate named argument default expression
1693 isdefault = ai + fp->uf_def_args.ga_len >= 0
1694 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1695 && argvars[i].vval.v_number == VVAL_NONE));
1696 if (isdefault)
1697 {
1698 char_u *default_expr = NULL;
1699 def_rettv.v_type = VAR_NUMBER;
1700 def_rettv.vval.v_number = -1;
1701
1702 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1703 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001704 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001705 {
1706 default_arg_err = 1;
1707 break;
1708 }
1709 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 }
1711 else
1712 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001713 if ((fp->uf_flags & FC_NOARGS) != 0)
1714 // Bail out if no a: arguments used (in lambda).
1715 break;
1716
Bram Moolenaare38eab22019-12-05 21:50:01 +01001717 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718 sprintf((char *)numbuf, "%d", ai + 1);
1719 name = numbuf;
1720 }
1721 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1722 {
1723 v = &fc->fixvar[fixvar_idx++].var;
1724 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001725 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 }
1727 else
1728 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001729 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 if (v == NULL)
1731 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001732 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001735 // Note: the values are copied directly to avoid alloc/free.
1736 // "argvars" must have VAR_FIXED for v_lock.
1737 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738 v->di_tv.v_lock = VAR_FIXED;
1739
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 if (addlocal)
1741 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001742 // Named arguments should be accessed without the "a:" prefix in
1743 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001744 copy_tv(&v->di_tv, &v->di_tv);
1745 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001746 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001747 else
1748 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749
1750 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1751 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001752 listitem_T *li = &fc->l_listitems[ai];
1753
1754 li->li_tv = argvars[i];
1755 li->li_tv.v_lock = VAR_FIXED;
1756 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757 }
1758 }
1759
Bram Moolenaare38eab22019-12-05 21:50:01 +01001760 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001762
1763 if (fp->uf_flags & FC_SANDBOX)
1764 {
1765 using_sandbox = TRUE;
1766 ++sandbox;
1767 }
1768
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001769 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001770 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001771 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001772 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001773 ++no_wait_return;
1774 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001776 smsg(_("calling %s"), SOURCING_NAME);
1777 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001779 char_u buf[MSG_BUF_LEN];
1780 char_u numbuf2[NUMBUFLEN];
1781 char_u *tofree;
1782 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001784 msg_puts("(");
1785 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001786 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001787 if (i > 0)
1788 msg_puts(", ");
1789 if (argvars[i].v_type == VAR_NUMBER)
1790 msg_outnum((long)argvars[i].vval.v_number);
1791 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001793 // Do not want errors such as E724 here.
1794 ++emsg_off;
1795 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1796 --emsg_off;
1797 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001798 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001799 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001801 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1802 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001803 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001804 msg_puts((char *)s);
1805 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001806 }
1807 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001809 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001810 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001811 msg_puts("\n"); // don't overwrite this either
1812
1813 verbose_leave_scroll();
1814 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001815 }
1816#ifdef FEAT_PROFILE
1817 if (do_profiling == PROF_YES)
1818 {
1819 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001820 {
1821 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001823 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001824 if (fp->uf_profiling
1825 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1826 {
1827 ++fp->uf_tm_count;
1828 profile_start(&call_start);
1829 profile_zero(&fp->uf_tm_children);
1830 }
1831 script_prof_save(&wait_start);
1832 }
1833#endif
1834
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001835 save_current_sctx = current_sctx;
1836 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 save_did_emsg = did_emsg;
1838 did_emsg = FALSE;
1839
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001840 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1841 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001842 else if (islambda)
1843 {
1844 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1845
1846 // A Lambda always has the command "return {expr}". It is much faster
1847 // to evaluate {expr} directly.
1848 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001849 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001850 --ex_nesting_level;
1851 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001852 else
1853 // call do_cmdline() to execute the lines
1854 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1856
1857 --RedrawingDisabled;
1858
Bram Moolenaare38eab22019-12-05 21:50:01 +01001859 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1861 {
1862 clear_tv(rettv);
1863 rettv->v_type = VAR_NUMBER;
1864 rettv->vval.v_number = -1;
1865 }
1866
1867#ifdef FEAT_PROFILE
1868 if (do_profiling == PROF_YES && (fp->uf_profiling
1869 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1870 {
1871 profile_end(&call_start);
1872 profile_sub_wait(&wait_start, &call_start);
1873 profile_add(&fp->uf_tm_total, &call_start);
1874 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1875 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1876 {
1877 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1878 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1879 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001880 if (started_profiling)
1881 // make a ":profdel func" stop profiling the function
1882 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001883 }
1884#endif
1885
Bram Moolenaare38eab22019-12-05 21:50:01 +01001886 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887 if (p_verbose >= 12)
1888 {
1889 ++no_wait_return;
1890 verbose_enter_scroll();
1891
1892 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001893 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001894 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001895 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 (long)fc->rettv->vval.v_number);
1897 else
1898 {
1899 char_u buf[MSG_BUF_LEN];
1900 char_u numbuf2[NUMBUFLEN];
1901 char_u *tofree;
1902 char_u *s;
1903
Bram Moolenaare38eab22019-12-05 21:50:01 +01001904 // The value may be very long. Skip the middle part, so that we
1905 // have some idea how it starts and ends. smsg() would always
1906 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001907 ++emsg_off;
1908 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1909 --emsg_off;
1910 if (s != NULL)
1911 {
1912 if (vim_strsize(s) > MSG_BUF_CLEN)
1913 {
1914 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1915 s = buf;
1916 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001917 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 vim_free(tofree);
1919 }
1920 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001921 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001922
1923 verbose_leave_scroll();
1924 --no_wait_return;
1925 }
1926
Bram Moolenaare31ee862020-01-07 20:59:34 +01001927 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001928 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001929 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001930#ifdef FEAT_PROFILE
1931 if (do_profiling == PROF_YES)
1932 script_prof_restore(&wait_start);
1933#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001934 if (using_sandbox)
1935 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001936
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001937 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938 {
1939 ++no_wait_return;
1940 verbose_enter_scroll();
1941
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001942 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001943 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944
1945 verbose_leave_scroll();
1946 --no_wait_return;
1947 }
1948
1949 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001950 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001951 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001952}
1953
1954/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001955 * Check the argument count for user function "fp".
1956 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1957 */
1958 int
1959check_user_func_argcount(ufunc_T *fp, int argcount)
1960{
1961 int regular_args = fp->uf_args.ga_len;
1962
1963 if (argcount < regular_args - fp->uf_def_args.ga_len)
1964 return FCERR_TOOFEW;
1965 else if (!has_varargs(fp) && argcount > regular_args)
1966 return FCERR_TOOMANY;
1967 return FCERR_UNKNOWN;
1968}
1969
1970/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001971 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001972 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001973 int
1974call_user_func_check(
1975 ufunc_T *fp,
1976 int argcount,
1977 typval_T *argvars,
1978 typval_T *rettv,
1979 funcexe_T *funcexe,
1980 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001981{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001982 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001983
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001984 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1985 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01001986 error = check_user_func_argcount(fp, argcount);
1987 if (error != FCERR_UNKNOWN)
1988 return error;
1989 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001990 error = FCERR_DICT;
1991 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001992 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001993 int did_save_redo = FALSE;
1994 save_redo_T save_redo;
1995
1996 /*
1997 * Call the user function.
1998 * Save and restore search patterns, script variables and
1999 * redo buffer.
2000 */
2001 save_search_patterns();
2002 if (!ins_compl_active())
2003 {
2004 saveRedobuff(&save_redo);
2005 did_save_redo = TRUE;
2006 }
2007 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002008 call_user_func(fp, argcount, argvars, rettv, funcexe,
2009 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002010 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2011 // Function was unreferenced while being used, free it now.
2012 func_clear_free(fp, FALSE);
2013 if (did_save_redo)
2014 restoreRedobuff(&save_redo);
2015 restore_search_patterns();
2016 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002017 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002018 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002019}
2020
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002021static funccal_entry_T *funccal_stack = NULL;
2022
2023/*
2024 * Save the current function call pointer, and set it to NULL.
2025 * Used when executing autocommands and for ":source".
2026 */
2027 void
2028save_funccal(funccal_entry_T *entry)
2029{
2030 entry->top_funccal = current_funccal;
2031 entry->next = funccal_stack;
2032 funccal_stack = entry;
2033 current_funccal = NULL;
2034}
2035
2036 void
2037restore_funccal(void)
2038{
2039 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002040 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002041 else
2042 {
2043 current_funccal = funccal_stack->top_funccal;
2044 funccal_stack = funccal_stack->next;
2045 }
2046}
2047
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002048 funccall_T *
2049get_current_funccal(void)
2050{
2051 return current_funccal;
2052}
2053
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002054/*
2055 * Mark all functions of script "sid" as deleted.
2056 */
2057 void
2058delete_script_functions(int sid)
2059{
2060 hashitem_T *hi;
2061 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002062 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002063 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002064 size_t len;
2065
2066 buf[0] = K_SPECIAL;
2067 buf[1] = KS_EXTRA;
2068 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002069 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002070 len = STRLEN(buf);
2071
Bram Moolenaarce658352020-07-31 23:47:12 +02002072 while (todo > 0)
2073 {
2074 todo = func_hashtab.ht_used;
2075 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2076 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002077 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002078 fp = HI2UF(hi);
2079 if (STRNCMP(fp->uf_name, buf, len) == 0)
2080 {
2081 int changed = func_hashtab.ht_changed;
2082
2083 fp->uf_flags |= FC_DEAD;
2084 func_clear(fp, TRUE);
2085 // When clearing a function another function can be cleared
2086 // as a side effect. When that happens start over.
2087 if (changed != func_hashtab.ht_changed)
2088 break;
2089 }
2090 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002091 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002092 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002093}
2094
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002095#if defined(EXITFREE) || defined(PROTO)
2096 void
2097free_all_functions(void)
2098{
2099 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002100 ufunc_T *fp;
2101 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002102 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002103 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104
Bram Moolenaare38eab22019-12-05 21:50:01 +01002105 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002106 while (current_funccal != NULL)
2107 {
2108 clear_tv(current_funccal->rettv);
2109 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002110 if (current_funccal == NULL && funccal_stack != NULL)
2111 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002112 }
2113
Bram Moolenaare38eab22019-12-05 21:50:01 +01002114 // First clear what the functions contain. Since this may lower the
2115 // reference count of a function, it may also free a function and change
2116 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002117 while (todo > 0)
2118 {
2119 todo = func_hashtab.ht_used;
2120 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2121 if (!HASHITEM_EMPTY(hi))
2122 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002123 // clear the def function index now
2124 fp = HI2UF(hi);
2125 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002126 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002127
Bram Moolenaare38eab22019-12-05 21:50:01 +01002128 // Only free functions that are not refcounted, those are
2129 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002130 if (func_name_refcount(fp->uf_name))
2131 ++skipped;
2132 else
2133 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002134 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002135 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002136 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002137 {
2138 skipped = 0;
2139 break;
2140 }
2141 }
2142 --todo;
2143 }
2144 }
2145
Bram Moolenaare38eab22019-12-05 21:50:01 +01002146 // Now actually free the functions. Need to start all over every time,
2147 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002148 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002149 while (func_hashtab.ht_used > skipped)
2150 {
2151 todo = func_hashtab.ht_used;
2152 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153 if (!HASHITEM_EMPTY(hi))
2154 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002155 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002156 // Only free functions that are not refcounted, those are
2157 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002158 fp = HI2UF(hi);
2159 if (func_name_refcount(fp->uf_name))
2160 ++skipped;
2161 else
2162 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002163 if (func_free(fp, FALSE) == OK)
2164 {
2165 skipped = 0;
2166 break;
2167 }
2168 // did not actually free it
2169 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002170 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002171 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002172 }
2173 if (skipped == 0)
2174 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002175
2176 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002177}
2178#endif
2179
2180/*
2181 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002182 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 * "len" is the length of "name", or -1 for NUL terminated.
2184 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002185 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002186builtin_function(char_u *name, int len)
2187{
2188 char_u *p;
2189
Bram Moolenaara26b9702020-04-18 19:53:28 +02002190 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002191 return FALSE;
2192 p = vim_strchr(name, AUTOLOAD_CHAR);
2193 return p == NULL || (len > 0 && p > name + len);
2194}
2195
2196 int
2197func_call(
2198 char_u *name,
2199 typval_T *args,
2200 partial_T *partial,
2201 dict_T *selfdict,
2202 typval_T *rettv)
2203{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002204 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002205 listitem_T *item;
2206 typval_T argv[MAX_FUNC_ARGS + 1];
2207 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002208 int r = 0;
2209
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002210 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002211 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212 {
2213 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2214 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002215 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002216 break;
2217 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002218 // Make a copy of each argument. This is needed to be able to set
2219 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002220 copy_tv(&item->li_tv, &argv[argc++]);
2221 }
2222
2223 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002224 {
2225 funcexe_T funcexe;
2226
Bram Moolenaara80faa82020-04-12 19:37:17 +02002227 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002228 funcexe.firstline = curwin->w_cursor.lnum;
2229 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002230 funcexe.evaluate = TRUE;
2231 funcexe.partial = partial;
2232 funcexe.selfdict = selfdict;
2233 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2234 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002235
Bram Moolenaare38eab22019-12-05 21:50:01 +01002236 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002237 while (argc > 0)
2238 clear_tv(&argv[--argc]);
2239
2240 return r;
2241}
2242
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002243static int callback_depth = 0;
2244
2245 int
2246get_callback_depth(void)
2247{
2248 return callback_depth;
2249}
2250
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002251/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002252 * Invoke call_func() with a callback.
2253 */
2254 int
2255call_callback(
2256 callback_T *callback,
2257 int len, // length of "name" or -1 to use strlen()
2258 typval_T *rettv, // return value goes here
2259 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002260 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002261 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002262{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002263 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002264 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002265
Bram Moolenaara80faa82020-04-12 19:37:17 +02002266 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002267 funcexe.evaluate = TRUE;
2268 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002269 ++callback_depth;
2270 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2271 --callback_depth;
2272 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002273}
2274
2275/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002276 * Give an error message for the result of a function.
2277 * Nothing if "error" is FCERR_NONE.
2278 */
2279 void
2280user_func_error(int error, char_u *name)
2281{
2282 switch (error)
2283 {
2284 case FCERR_UNKNOWN:
2285 emsg_funcname(e_unknownfunc, name);
2286 break;
2287 case FCERR_NOTMETHOD:
2288 emsg_funcname(
2289 N_("E276: Cannot use function as a method: %s"), name);
2290 break;
2291 case FCERR_DELETED:
2292 emsg_funcname(N_(e_func_deleted), name);
2293 break;
2294 case FCERR_TOOMANY:
2295 emsg_funcname((char *)e_toomanyarg, name);
2296 break;
2297 case FCERR_TOOFEW:
2298 emsg_funcname((char *)e_toofewarg, name);
2299 break;
2300 case FCERR_SCRIPT:
2301 emsg_funcname(
2302 N_("E120: Using <SID> not in a script context: %s"), name);
2303 break;
2304 case FCERR_DICT:
2305 emsg_funcname(
2306 N_("E725: Calling dict function without Dictionary: %s"),
2307 name);
2308 break;
2309 }
2310}
2311
2312/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002313 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002314 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002315 * Return FAIL when the function can't be called, OK otherwise.
2316 * Also returns OK when an error was encountered while executing the function.
2317 */
2318 int
2319call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002320 char_u *funcname, // name of the function
2321 int len, // length of "name" or -1 to use strlen()
2322 typval_T *rettv, // return value goes here
2323 int argcount_in, // number of "argvars"
2324 typval_T *argvars_in, // vars for arguments, must have "argcount"
2325 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002326 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327{
2328 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002329 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002330 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002331 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 char_u fname_buf[FLEN_FIXED + 1];
2333 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002334 char_u *fname = NULL;
2335 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 int argcount = argcount_in;
2337 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002338 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002339 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2340 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002342 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002343 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002345 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2346 // even when call_func() returns FAIL.
2347 rettv->v_type = VAR_UNKNOWN;
2348
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002349 if (partial != NULL)
2350 fp = partial->pt_func;
2351 if (fp == NULL)
2352 {
2353 // Make a copy of the name, if it comes from a funcref variable it
2354 // could be changed or deleted in the called function.
2355 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2356 if (name == NULL)
2357 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002359 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2360 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002362 if (funcexe->doesrange != NULL)
2363 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364
2365 if (partial != NULL)
2366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002367 // When the function has a partial with a dict and there is a dict
2368 // argument, use the dict argument. That is backwards compatible.
2369 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002370 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002372 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 {
2374 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002375 {
2376 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2377 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002378 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002379 goto theend;
2380 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002382 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002383 for (i = 0; i < argcount_in; ++i)
2384 argv[i + argv_clear] = argvars_in[i];
2385 argvars = argv;
2386 argcount = partial->pt_argc + argcount_in;
2387 }
2388 }
2389
Bram Moolenaaref140542019-12-31 21:27:13 +01002390 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002391 {
2392 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002393 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394
Bram Moolenaar333894b2020-08-01 18:53:07 +02002395 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002396 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002397 {
2398 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002400 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401
Bram Moolenaare38eab22019-12-05 21:50:01 +01002402 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002403 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002404 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002406 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 {
2408 /*
2409 * User defined function.
2410 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002411 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002412 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002413
Bram Moolenaare38eab22019-12-05 21:50:01 +01002414 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002415 if (fp == NULL
2416 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002417 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 && !aborting())
2419 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002420 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002421 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002423 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002426 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002427 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002428 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002429 if (fp == NULL)
2430 {
2431 char_u *p = untrans_function_name(rfname);
2432
2433 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002434 // Don't do this if the name starts with "s:".
2435 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002436 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002437 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002439 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002440 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002441#ifdef FEAT_LUA
2442 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2443 {
2444 cfunc_T cb = fp->uf_cb;
2445
2446 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2447 }
2448#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002449 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002451 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002452 // postponed filling in the arguments, do it now
2453 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002454 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002455
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002456 if (funcexe->basetv != NULL)
2457 {
2458 // Method call: base->Method()
2459 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2460 argv[0] = *funcexe->basetv;
2461 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002462 argvars = argv;
2463 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002464 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002465
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002466 error = call_user_func_check(fp, argcount, argvars, rettv,
2467 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468 }
2469 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002470 else if (funcexe->basetv != NULL)
2471 {
2472 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002473 * expr->method(): Find the method name in the table, call its
2474 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002475 */
2476 error = call_internal_method(fname, argcount, argvars, rettv,
2477 funcexe->basetv);
2478 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 else
2480 {
2481 /*
2482 * Find the function name in the table, call its implementation.
2483 */
2484 error = call_internal_func(fname, argcount, argvars, rettv);
2485 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002486
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 /*
2488 * The function call (or "FuncUndefined" autocommand sequence) might
2489 * have been aborted by an error, an interrupt, or an explicitly thrown
2490 * exception that has not been caught so far. This situation can be
2491 * tested for by calling aborting(). For an error in an internal
2492 * function or for the "E132" error in call_user_func(), however, the
2493 * throw point at which the "force_abort" flag (temporarily reset by
2494 * emsg()) is normally updated has not been reached yet. We need to
2495 * update that flag first to make aborting() reliable.
2496 */
2497 update_force_abort();
2498 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002499 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 ret = OK;
2501
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002502theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503 /*
2504 * Report an error unless the argument evaluation or function call has been
2505 * cancelled due to an aborting error, an interrupt, or an exception.
2506 */
2507 if (!aborting())
2508 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002509 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 }
2511
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002512 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002514 clear_tv(&argv[--argv_clear + argv_base]);
2515
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 vim_free(tofree);
2517 vim_free(name);
2518
2519 return ret;
2520}
2521
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002522 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002523printable_func_name(ufunc_T *fp)
2524{
2525 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2526}
2527
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002529 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 */
2531 static void
2532list_func_head(ufunc_T *fp, int indent)
2533{
2534 int j;
2535
2536 msg_start();
2537 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002538 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002539 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002540 msg_puts("def ");
2541 else
2542 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002543 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 msg_putchar('(');
2545 for (j = 0; j < fp->uf_args.ga_len; ++j)
2546 {
2547 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002548 msg_puts(", ");
2549 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002550 if (fp->uf_arg_types != NULL)
2551 {
2552 char *tofree;
2553
2554 msg_puts(": ");
2555 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2556 vim_free(tofree);
2557 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002558 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2559 {
2560 msg_puts(" = ");
2561 msg_puts(((char **)(fp->uf_def_args.ga_data))
2562 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 }
2565 if (fp->uf_varargs)
2566 {
2567 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002568 msg_puts(", ");
2569 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002571 if (fp->uf_va_name != NULL)
2572 {
2573 if (j)
2574 msg_puts(", ");
2575 msg_puts("...");
2576 msg_puts((char *)fp->uf_va_name);
2577 if (fp->uf_va_type)
2578 {
2579 char *tofree;
2580
2581 msg_puts(": ");
2582 msg_puts(type_name(fp->uf_va_type, &tofree));
2583 vim_free(tofree);
2584 }
2585 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002587
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002588 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002589 {
2590 if (fp->uf_ret_type != &t_void)
2591 {
2592 char *tofree;
2593
2594 msg_puts(": ");
2595 msg_puts(type_name(fp->uf_ret_type, &tofree));
2596 vim_free(tofree);
2597 }
2598 }
2599 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002600 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002602 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002604 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002605 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002606 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607 msg_clr_eos();
2608 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002609 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610}
2611
2612/*
2613 * Get a function name, translating "<SID>" and "<SNR>".
2614 * Also handles a Funcref in a List or Dictionary.
2615 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002616 * Set "*is_global" to TRUE when the function must be global, unless
2617 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 * flags:
2619 * TFN_INT: internal function name OK
2620 * TFN_QUIET: be quiet
2621 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002622 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 * Advances "pp" to just after the function name (if no error).
2624 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002625 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626trans_function_name(
2627 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002628 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002629 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002631 funcdict_T *fdp, // return: info about dictionary used
2632 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633{
2634 char_u *name = NULL;
2635 char_u *start;
2636 char_u *end;
2637 int lead;
2638 char_u sid_buf[20];
2639 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002640 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002641 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002642 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002643 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644
2645 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002646 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 start = *pp;
2648
Bram Moolenaare38eab22019-12-05 21:50:01 +01002649 // Check for hard coded <SNR>: already translated function ID (from a user
2650 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2652 && (*pp)[2] == (int)KE_SNR)
2653 {
2654 *pp += 3;
2655 len = get_id_len(pp) + 3;
2656 return vim_strnsave(start, len);
2657 }
2658
Bram Moolenaare38eab22019-12-05 21:50:01 +01002659 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2660 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 lead = eval_fname_script(start);
2662 if (lead > 2)
2663 start += lead;
2664
Bram Moolenaare38eab22019-12-05 21:50:01 +01002665 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002666 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 lead > 2 ? 0 : FNE_CHECK_START);
2668 if (end == start)
2669 {
2670 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002671 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672 goto theend;
2673 }
2674 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2675 {
2676 /*
2677 * Report an invalid expression in braces, unless the expression
2678 * evaluation has been cancelled due to an aborting error, an
2679 * interrupt, or an exception.
2680 */
2681 if (!aborting())
2682 {
2683 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002684 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 }
2686 else
2687 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2688 goto theend;
2689 }
2690
2691 if (lv.ll_tv != NULL)
2692 {
2693 if (fdp != NULL)
2694 {
2695 fdp->fd_dict = lv.ll_dict;
2696 fdp->fd_newkey = lv.ll_newkey;
2697 lv.ll_newkey = NULL;
2698 fdp->fd_di = lv.ll_di;
2699 }
2700 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2701 {
2702 name = vim_strsave(lv.ll_tv->vval.v_string);
2703 *pp = end;
2704 }
2705 else if (lv.ll_tv->v_type == VAR_PARTIAL
2706 && lv.ll_tv->vval.v_partial != NULL)
2707 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002708 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 *pp = end;
2710 if (partial != NULL)
2711 *partial = lv.ll_tv->vval.v_partial;
2712 }
2713 else
2714 {
2715 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2716 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002717 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 else
2719 *pp = end;
2720 name = NULL;
2721 }
2722 goto theend;
2723 }
2724
2725 if (lv.ll_name == NULL)
2726 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002727 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 *pp = end;
2729 goto theend;
2730 }
2731
Bram Moolenaare38eab22019-12-05 21:50:01 +01002732 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 if (lv.ll_exp_name != NULL)
2734 {
2735 len = (int)STRLEN(lv.ll_exp_name);
2736 name = deref_func_name(lv.ll_exp_name, &len, partial,
2737 flags & TFN_NO_AUTOLOAD);
2738 if (name == lv.ll_exp_name)
2739 name = NULL;
2740 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002741 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 {
2743 len = (int)(end - *pp);
2744 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2745 if (name == *pp)
2746 name = NULL;
2747 }
2748 if (name != NULL)
2749 {
2750 name = vim_strsave(name);
2751 *pp = end;
2752 if (STRNCMP(name, "<SNR>", 5) == 0)
2753 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002754 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755 name[0] = K_SPECIAL;
2756 name[1] = KS_EXTRA;
2757 name[2] = (int)KE_SNR;
2758 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2759 }
2760 goto theend;
2761 }
2762
2763 if (lv.ll_exp_name != NULL)
2764 {
2765 len = (int)STRLEN(lv.ll_exp_name);
2766 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2767 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2768 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002769 // When there was "s:" already or the name expanded to get a
2770 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 lv.ll_name += 2;
2772 len -= 2;
2773 lead = 2;
2774 }
2775 }
2776 else
2777 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002778 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002780 {
2781 if (is_global != NULL && lv.ll_name[0] == 'g')
2782 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 len = (int)(end - lv.ll_name);
2786 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002787 if (len <= 0)
2788 {
2789 if (!skip)
2790 emsg(_(e_function_name));
2791 goto theend;
2792 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002794 // In Vim9 script a user function is script-local by default, unless it
2795 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002796 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002797 if (vim9script)
2798 {
2799 char_u *p;
2800
2801 // SomeScript#func() is a global function.
2802 for (p = start; *p != NUL && *p != '('; ++p)
2803 if (*p == AUTOLOAD_CHAR)
2804 vim9script = FALSE;
2805 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 /*
2808 * Copy the function name to allocated memory.
2809 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2810 * Accept <SNR>123_name() outside a script.
2811 */
2812 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002813 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002814 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002816 if (!vim9script)
2817 lead = 3;
2818 if (vim9script || (lv.ll_exp_name != NULL
2819 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 || eval_fname_sid(*pp))
2821 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002822 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002823 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002825 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 goto theend;
2827 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002828 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002829 if (vim9script)
2830 extra = 3 + (int)STRLEN(sid_buf);
2831 else
2832 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833 }
2834 }
2835 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2836 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002837 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 start);
2839 goto theend;
2840 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002841 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 {
2843 char_u *cp = vim_strchr(lv.ll_name, ':');
2844
2845 if (cp != NULL && cp < end)
2846 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002847 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 goto theend;
2849 }
2850 }
2851
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002852 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853 if (name != NULL)
2854 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002855 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856 {
2857 name[0] = K_SPECIAL;
2858 name[1] = KS_EXTRA;
2859 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002860 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 STRCPY(name + 3, sid_buf);
2862 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002863 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2864 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 }
2866 *pp = end;
2867
2868theend:
2869 clear_lval(&lv);
2870 return name;
2871}
2872
2873/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002874 * Assuming "name" is the result of trans_function_name() and it was prefixed
2875 * to use the script-local name, return the unmodified name (points into
2876 * "name"). Otherwise return NULL.
2877 * This can be used to first search for a script-local function and fall back
2878 * to the global function if not found.
2879 */
2880 char_u *
2881untrans_function_name(char_u *name)
2882{
2883 char_u *p;
2884
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002885 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002886 {
2887 p = vim_strchr(name, '_');
2888 if (p != NULL)
2889 return p + 1;
2890 }
2891 return NULL;
2892}
2893
2894/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002895 * List functions. When "regmatch" is NULL all of then.
2896 * Otherwise functions matching "regmatch".
2897 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002898 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002899list_functions(regmatch_T *regmatch)
2900{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002901 int changed = func_hashtab.ht_changed;
2902 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002903 hashitem_T *hi;
2904
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002905 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002906 {
2907 if (!HASHITEM_EMPTY(hi))
2908 {
2909 ufunc_T *fp = HI2UF(hi);
2910
2911 --todo;
2912 if ((fp->uf_flags & FC_DEAD) == 0
2913 && (regmatch == NULL
2914 ? !message_filtered(fp->uf_name)
2915 && !func_name_refcount(fp->uf_name)
2916 : !isdigit(*fp->uf_name)
2917 && vim_regexec(regmatch, fp->uf_name, 0)))
2918 {
2919 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002920 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002921 {
2922 emsg(_("E454: function list was modified"));
2923 return;
2924 }
2925 }
2926 }
2927 }
2928}
2929
2930/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002931 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2932 * return TRUE.
2933 * Otherwise return FALSE;
2934 * Do not consider "function(" to be a command.
2935 */
2936 static int
2937is_function_cmd(char_u **cmd)
2938{
2939 char_u *p = *cmd;
2940
2941 if (checkforcmd(&p, "function", 2))
2942 {
2943 if (*p == '(')
2944 return FALSE;
2945 *cmd = p;
2946 return TRUE;
2947 }
2948 return FALSE;
2949}
2950
2951/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002952 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002953 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2954 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002955 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002957 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002958define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002959{
2960 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002961 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002962 int j;
2963 int c;
2964 int saved_did_emsg;
2965 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002966 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002967 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 char_u *p;
2969 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01002970 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971 char_u *line_arg = NULL;
2972 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002973 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002974 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975 garray_T newlines;
2976 int varargs = FALSE;
2977 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002978 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002979 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002980 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002981 int indent;
2982 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002983#define MAX_FUNC_NESTING 50
2984 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002985 dictitem_T *v;
2986 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002987 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01002990 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002991 linenr_T sourcing_lnum_off;
2992 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002993 int is_heredoc = FALSE;
2994 char_u *skip_until = NULL;
2995 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002996 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002997 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998
2999 /*
3000 * ":function" without argument: list functions.
3001 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003002 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 {
3004 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003005 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003007 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 }
3009
3010 /*
3011 * ":function /pat": list functions matching pattern.
3012 */
3013 if (*eap->arg == '/')
3014 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003015 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 if (!eap->skip)
3017 {
3018 regmatch_T regmatch;
3019
3020 c = *p;
3021 *p = NUL;
3022 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3023 *p = c;
3024 if (regmatch.regprog != NULL)
3025 {
3026 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003027 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028 vim_regfree(regmatch.regprog);
3029 }
3030 }
3031 if (*p == '/')
3032 ++p;
3033 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003034 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 }
3036
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003037 ga_init(&newargs);
3038 ga_init(&argtypes);
3039 ga_init(&default_args);
3040
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 /*
3042 * Get the function name. There are these situations:
3043 * func normal function name
3044 * "name" == func, "fudi.fd_dict" == NULL
3045 * dict.func new dictionary entry
3046 * "name" == NULL, "fudi.fd_dict" set,
3047 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3048 * dict.func existing dict entry with a Funcref
3049 * "name" == func, "fudi.fd_dict" set,
3050 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3051 * dict.func existing dict entry that's not a Funcref
3052 * "name" == NULL, "fudi.fd_dict" set,
3053 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3054 * s:func script-local function name
3055 * g:func global function name, same as "func"
3056 */
3057 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003058 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003060 // nested function, argument is (args).
3061 paren = TRUE;
3062 CLEAR_FIELD(fudi);
3063 }
3064 else
3065 {
3066 name = trans_function_name(&p, &is_global, eap->skip,
3067 TFN_NO_AUTOLOAD, &fudi, NULL);
3068 paren = (vim_strchr(p, '(') != NULL);
3069 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003070 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003071 /*
3072 * Return on an invalid expression in braces, unless the expression
3073 * evaluation has been cancelled due to an aborting error, an
3074 * interrupt, or an exception.
3075 */
3076 if (!aborting())
3077 {
3078 if (!eap->skip && fudi.fd_newkey != NULL)
3079 semsg(_(e_dictkey), fudi.fd_newkey);
3080 vim_free(fudi.fd_newkey);
3081 return NULL;
3082 }
3083 else
3084 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086 }
3087
Bram Moolenaare38eab22019-12-05 21:50:01 +01003088 // An error in a function call during evaluation of an expression in magic
3089 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003090 saved_did_emsg = did_emsg;
3091 did_emsg = FALSE;
3092
3093 /*
3094 * ":function func" with only function name: list function.
3095 */
3096 if (!paren)
3097 {
3098 if (!ends_excmd(*skipwhite(p)))
3099 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003100 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 goto ret_free;
3102 }
3103 eap->nextcmd = check_nextcmd(p);
3104 if (eap->nextcmd != NULL)
3105 *p = NUL;
3106 if (!eap->skip && !got_int)
3107 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003108 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003109 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3110 {
3111 char_u *up = untrans_function_name(name);
3112
3113 // With Vim9 script the name was made script-local, if not
3114 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003115 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003116 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003117 }
3118
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 if (fp != NULL)
3120 {
3121 list_func_head(fp, TRUE);
3122 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3123 {
3124 if (FUNCLINE(fp, j) == NULL)
3125 continue;
3126 msg_putchar('\n');
3127 msg_outnum((long)(j + 1));
3128 if (j < 9)
3129 msg_putchar(' ');
3130 if (j < 99)
3131 msg_putchar(' ');
3132 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003133 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 ui_breakcheck();
3135 }
3136 if (!got_int)
3137 {
3138 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003139 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003140 msg_puts(" enddef");
3141 else
3142 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 }
3144 }
3145 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003146 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147 }
3148 goto ret_free;
3149 }
3150
3151 /*
3152 * ":function name(arg1, arg2)" Define function.
3153 */
3154 p = skipwhite(p);
3155 if (*p != '(')
3156 {
3157 if (!eap->skip)
3158 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003159 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 goto ret_free;
3161 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003162 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163 if (vim_strchr(p, '(') != NULL)
3164 p = vim_strchr(p, '(');
3165 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003166
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003167 // In Vim9 script only global functions can be redefined.
3168 if (vim9script && eap->forceit && !is_global)
3169 {
3170 emsg(_(e_nobang));
3171 goto ret_free;
3172 }
3173
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3175
Bram Moolenaar04b12692020-05-04 23:24:44 +02003176 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003178 // Check the name of the function. Unless it's a dictionary function
3179 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 if (name != NULL)
3181 arg = name;
3182 else
3183 arg = fudi.fd_newkey;
3184 if (arg != NULL && (fudi.fd_di == NULL
3185 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3186 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3187 {
3188 if (*arg == K_SPECIAL)
3189 j = 3;
3190 else
3191 j = 0;
3192 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3193 : eval_isnamec(arg[j])))
3194 ++j;
3195 if (arg[j] != NUL)
3196 emsg_funcname((char *)e_invarg2, arg);
3197 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003198 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003200 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 }
3202
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003203 // This may get more lines and make the pointers into the first line
3204 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003205 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003207 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003208 &varargs, &default_args, eap->skip,
3209 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003211 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003213 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003215 // find the return type: :def Func(): type
3216 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003218 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003219 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003220 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003221 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003222 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003223 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003224 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003225 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003226 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003227 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003228 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003229 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003230 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003232 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003234 else
3235 // find extra arguments "range", "dict", "abort" and "closure"
3236 for (;;)
3237 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003238 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003239 p = skipwhite(p);
3240 if (STRNCMP(p, "range", 5) == 0)
3241 {
3242 flags |= FC_RANGE;
3243 p += 5;
3244 }
3245 else if (STRNCMP(p, "dict", 4) == 0)
3246 {
3247 flags |= FC_DICT;
3248 p += 4;
3249 }
3250 else if (STRNCMP(p, "abort", 5) == 0)
3251 {
3252 flags |= FC_ABORT;
3253 p += 5;
3254 }
3255 else if (STRNCMP(p, "closure", 7) == 0)
3256 {
3257 flags |= FC_CLOSURE;
3258 p += 7;
3259 if (current_funccal == NULL)
3260 {
3261 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3262 name == NULL ? (char_u *)"" : name);
3263 goto erret;
3264 }
3265 }
3266 else
3267 break;
3268 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269
Bram Moolenaare38eab22019-12-05 21:50:01 +01003270 // When there is a line break use what follows for the function body.
3271 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003272 if (*p == '\n')
3273 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003274 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003275 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3276 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003277 && !(VIM_ISWHITE(*whitep) && *p == '#'
3278 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003279 && !eap->skip
3280 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003281 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282
3283 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3285 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 */
3287 if (KeyTyped)
3288 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003289 // Check if the function already exists, don't let the user type the
3290 // whole function before telling him it doesn't work! For a script we
3291 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 if (!eap->skip && !eap->forceit)
3293 {
3294 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003295 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003296 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 emsg_funcname(e_funcexts, name);
3298 }
3299
3300 if (!eap->skip && did_emsg)
3301 goto erret;
3302
Bram Moolenaare38eab22019-12-05 21:50:01 +01003303 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 cmdline_row = msg_row;
3305 }
3306
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003307 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003308 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003309
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003310 // Detect having skipped over comment lines to find the return
3311 // type. Add NULL lines to keep the line count correct.
3312 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3313 if (SOURCING_LNUM < sourcing_lnum_off)
3314 {
3315 sourcing_lnum_off -= SOURCING_LNUM;
3316 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3317 goto erret;
3318 while (sourcing_lnum_off-- > 0)
3319 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3320 }
3321
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003322 indent = 2;
3323 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003324 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003325 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003326 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327 for (;;)
3328 {
3329 if (KeyTyped)
3330 {
3331 msg_scroll = TRUE;
3332 saved_wait_return = FALSE;
3333 }
3334 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335
3336 if (line_arg != NULL)
3337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 theline = line_arg;
3340 p = vim_strchr(theline, '\n');
3341 if (p == NULL)
3342 line_arg += STRLEN(line_arg);
3343 else
3344 {
3345 *p = NUL;
3346 line_arg = p + 1;
3347 }
3348 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003350 {
3351 vim_free(line_to_free);
3352 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003353 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003354 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003355 theline = eap->getline(':', eap->cookie, indent,
3356 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003357 line_to_free = theline;
3358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 if (KeyTyped)
3360 lines_left = Rows - 1;
3361 if (theline == NULL)
3362 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003363 // Use the start of the function for the line number.
3364 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003365 if (skip_until != NULL)
3366 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3367 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003368 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003369 else
3370 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 goto erret;
3372 }
3373
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003374 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003375 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003376 if (SOURCING_LNUM < sourcing_lnum_off)
3377 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 else
3379 sourcing_lnum_off = 0;
3380
3381 if (skip_until != NULL)
3382 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003383 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003384 // * ":append" and "."
3385 // * ":python <<EOF" and "EOF"
3386 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3387 if (heredoc_trimmed == NULL
3388 || (is_heredoc && skipwhite(theline) == theline)
3389 || STRNCMP(theline, heredoc_trimmed,
3390 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003391 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003392 if (heredoc_trimmed == NULL)
3393 p = theline;
3394 else if (is_heredoc)
3395 p = skipwhite(theline) == theline
3396 ? theline : theline + STRLEN(heredoc_trimmed);
3397 else
3398 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003399 if (STRCMP(p, skip_until) == 0)
3400 {
3401 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003402 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003403 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003404 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003405 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003406 }
3407 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 }
3409 else
3410 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003411 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003412 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 ;
3414
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003415 // Check for "endfunction" or "enddef".
3416 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003417 ? "enddef" : "endfunction", 4))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003419 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003420 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003421 char_u *nextcmd = NULL;
3422
3423 if (*p == '|')
3424 nextcmd = p + 1;
3425 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3426 nextcmd = line_arg;
3427 else if (*p != NUL && *p != '"' && p_verbose > 0)
3428 give_warning2(eap->cmdidx == CMD_def
3429 ? (char_u *)_("W1001: Text found after :enddef: %s")
3430 : (char_u *)_("W22: Text found after :endfunction: %s"),
3431 p, TRUE);
3432 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003433 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003434 // Another command follows. If the line came from "eap"
3435 // we can simply point into it, otherwise we need to
3436 // change "eap->cmdlinep".
3437 eap->nextcmd = nextcmd;
3438 if (line_to_free != NULL)
3439 {
3440 vim_free(*eap->cmdlinep);
3441 *eap->cmdlinep = line_to_free;
3442 line_to_free = NULL;
3443 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003444 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003445 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003446 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 }
3448
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003449 // Check for mismatched "endfunc" or "enddef".
3450 // We don't check for "def" inside "func" thus we also can't check
3451 // for "enddef".
3452 // We continue to find the end of the function, although we might
3453 // not find it.
3454 else if (nesting_def[nesting])
3455 {
3456 if (checkforcmd(&p, "endfunction", 4))
3457 emsg(_(e_mismatched_endfunction));
3458 }
3459 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3460 emsg(_(e_mismatched_enddef));
3461
Bram Moolenaare38eab22019-12-05 21:50:01 +01003462 // Increase indent inside "if", "while", "for" and "try", decrease
3463 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 indent -= 2;
3466 else if (STRNCMP(p, "if", 2) == 0
3467 || STRNCMP(p, "wh", 2) == 0
3468 || STRNCMP(p, "for", 3) == 0
3469 || STRNCMP(p, "try", 3) == 0)
3470 indent += 2;
3471
Bram Moolenaare38eab22019-12-05 21:50:01 +01003472 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003473 // Only recognize "def" inside "def", not inside "function",
3474 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003475 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003476 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003477 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 {
3479 if (*p == '!')
3480 p = skipwhite(p + 1);
3481 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003482 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003483 if (*skipwhite(p) == '(')
3484 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003485 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003486 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003487 else
3488 {
3489 ++nesting;
3490 nesting_def[nesting] = (c == 'd');
3491 indent += 2;
3492 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 }
3494 }
3495
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003496 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003497 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003498 if (eap->cmdidx != CMD_def
3499 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003500 || (p[0] == 'c'
3501 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3502 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3503 && (STRNCMP(&p[3], "nge", 3) != 0
3504 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 || (p[0] == 'i'
3506 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003507 && (!ASCII_ISALPHA(p[2])
3508 || (p[2] == 's'
3509 && (!ASCII_ISALPHA(p[3])
3510 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 skip_until = vim_strsave((char_u *)".");
3512
Bram Moolenaare38eab22019-12-05 21:50:01 +01003513 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 arg = skipwhite(skiptowhite(p));
3515 if (arg[0] == '<' && arg[1] =='<'
3516 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003517 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3518 || ((p[2] == '3' || p[2] == 'x')
3519 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 || (p[0] == 'p' && p[1] == 'e'
3521 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3522 || (p[0] == 't' && p[1] == 'c'
3523 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3524 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3525 && !ASCII_ISALPHA(p[3]))
3526 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3527 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3528 || (p[0] == 'm' && p[1] == 'z'
3529 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3530 ))
3531 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003532 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003534 if (STRNCMP(p, "trim", 4) == 0)
3535 {
3536 // Ignore leading white space.
3537 p = skipwhite(p + 4);
3538 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003539 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003540 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 if (*p == NUL)
3542 skip_until = vim_strsave((char_u *)".");
3543 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003544 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003545 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003546 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003548
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003549 // Check for ":cmd v =<< [trim] EOF"
3550 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003551 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003552 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003553 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003554 if (*arg == '[')
3555 arg = vim_strchr(arg, ']');
3556 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003557 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003558 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3559 && arg[1] == '<' && arg[2] =='<');
3560
3561 if (!found)
3562 // skip over the argument after "cmd"
3563 arg = skipwhite(skiptowhite(arg));
3564 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003565 && (checkforcmd(&p, "let", 2)
3566 || checkforcmd(&p, "var", 3)
3567 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003568 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003569 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003570 p = skipwhite(arg + 3);
3571 if (STRNCMP(p, "trim", 4) == 0)
3572 {
3573 // Ignore leading white space.
3574 p = skipwhite(p + 4);
3575 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003576 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003577 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003578 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003579 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003580 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003581 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003582 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 }
3584
Bram Moolenaare38eab22019-12-05 21:50:01 +01003585 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003588
Bram Moolenaare38eab22019-12-05 21:50:01 +01003589 // Copy the line to newly allocated memory. get_one_sourceline()
3590 // allocates 250 bytes per line, this saves 80% on average. The cost
3591 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003593 if (p == NULL)
3594 goto erret;
3595 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596
Bram Moolenaare38eab22019-12-05 21:50:01 +01003597 // Add NULL lines for continuation lines, so that the line count is
3598 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 while (sourcing_lnum_off-- > 0)
3600 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3601
Bram Moolenaare38eab22019-12-05 21:50:01 +01003602 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603 if (line_arg != NULL && *line_arg == NUL)
3604 line_arg = NULL;
3605 }
3606
Bram Moolenaare38eab22019-12-05 21:50:01 +01003607 // Don't define the function when skipping commands or when an error was
3608 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 if (eap->skip || did_emsg)
3610 goto erret;
3611
3612 /*
3613 * If there are no errors, add the function
3614 */
3615 if (fudi.fd_dict == NULL)
3616 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003617 hashtab_T *ht;
3618
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 v = find_var(name, &ht, FALSE);
3620 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3621 {
3622 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3623 name);
3624 goto erret;
3625 }
3626
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003627 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003628 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003630 char_u *uname = untrans_function_name(name);
3631
3632 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3633 }
3634
3635 if (fp != NULL || import != NULL)
3636 {
3637 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003638
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003639 // Function can be replaced with "function!" and when sourcing the
3640 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003641 // A name that is used by an import can not be overruled.
3642 if (import != NULL
3643 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003644 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003645 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003647 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003648 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003649 else
3650 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 goto erret;
3652 }
3653 if (fp->uf_calls > 0)
3654 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003655 emsg_funcname(
3656 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 name);
3658 goto erret;
3659 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003660 if (fp->uf_refcount > 1)
3661 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003662 // This function is referenced somewhere, don't redefine it but
3663 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003664 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003665 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003666 fp = NULL;
3667 overwrite = TRUE;
3668 }
3669 else
3670 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003671 char_u *exp_name = fp->uf_name_exp;
3672
3673 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003674 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003675 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003676 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003677 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003678 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003679#ifdef FEAT_PROFILE
3680 fp->uf_profiling = FALSE;
3681 fp->uf_prof_initialized = FALSE;
3682#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003683 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003684 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 }
3686 }
3687 else
3688 {
3689 char numbuf[20];
3690
3691 fp = NULL;
3692 if (fudi.fd_newkey == NULL && !eap->forceit)
3693 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003694 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 goto erret;
3696 }
3697 if (fudi.fd_di == NULL)
3698 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003699 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003700 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 goto erret;
3702 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003703 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003704 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705 goto erret;
3706
Bram Moolenaare38eab22019-12-05 21:50:01 +01003707 // Give the function a sequential number. Can only be used with a
3708 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 vim_free(name);
3710 sprintf(numbuf, "%d", ++func_nr);
3711 name = vim_strsave((char_u *)numbuf);
3712 if (name == NULL)
3713 goto erret;
3714 }
3715
3716 if (fp == NULL)
3717 {
3718 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3719 {
3720 int slen, plen;
3721 char_u *scriptname;
3722
Bram Moolenaare38eab22019-12-05 21:50:01 +01003723 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003725 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 {
3727 scriptname = autoload_name(name);
3728 if (scriptname != NULL)
3729 {
3730 p = vim_strchr(scriptname, '/');
3731 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003732 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003734 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 j = OK;
3736 vim_free(scriptname);
3737 }
3738 }
3739 if (j == FAIL)
3740 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003741 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742 goto erret;
3743 }
3744 }
3745
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003746 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 if (fp == NULL)
3748 goto erret;
3749
3750 if (fudi.fd_dict != NULL)
3751 {
3752 if (fudi.fd_di == NULL)
3753 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003754 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3756 if (fudi.fd_di == NULL)
3757 {
3758 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003759 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 goto erret;
3761 }
3762 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3763 {
3764 vim_free(fudi.fd_di);
3765 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003766 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 goto erret;
3768 }
3769 }
3770 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003771 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 clear_tv(&fudi.fd_di->di_tv);
3773 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775
Bram Moolenaare38eab22019-12-05 21:50:01 +01003776 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 flags |= FC_DICT;
3778 }
3779
Bram Moolenaare38eab22019-12-05 21:50:01 +01003780 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003781 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003782 if (overwrite)
3783 {
3784 hi = hash_find(&func_hashtab, name);
3785 hi->hi_key = UF2HIKEY(fp);
3786 }
3787 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 {
3789 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003790 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 goto erret;
3792 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003793 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 }
3795 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003796 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003797 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003798 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003799
3800 if (eap->cmdidx == CMD_def)
3801 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003802 int lnum_save = SOURCING_LNUM;
3803 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003804
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003805 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003806
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003807 // error messages are for the first function line
3808 SOURCING_LNUM = sourcing_lnum_top;
3809
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003810 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003811 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003812 int count = cstack->cs_idx + 1;
3813 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003814
3815 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003816 // a block that is visible now but not when the function is called
3817 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003818 fp->uf_block_ids = ALLOC_MULT(int, count);
3819 if (fp->uf_block_ids != NULL)
3820 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003821 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003822 sizeof(int) * count);
3823 fp->uf_block_depth = count;
3824 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003825
3826 // Set flag in each block to indicate a function was defined. This
3827 // is used to keep the variable when leaving the block, see
3828 // hide_script_var().
3829 for (i = 0; i <= cstack->cs_idx; ++i)
3830 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003831 }
3832
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003833 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003835 SOURCING_LNUM = lnum_save;
3836 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003837 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003838 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003839
3840 // parse the return type, if any
3841 if (ret_type == NULL)
3842 fp->uf_ret_type = &t_void;
3843 else
3844 {
3845 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003846 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003847 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003848 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003849 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003850 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003851 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003852
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003854 if ((flags & FC_CLOSURE) != 0)
3855 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003856 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003857 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003858 }
3859 else
3860 fp->uf_scoped = NULL;
3861
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863 if (prof_def_func())
3864 func_do_profile(fp);
3865#endif
3866 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003867 if (sandbox)
3868 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003869 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003870 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 fp->uf_flags = flags;
3872 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003873 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003874 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003875 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003876 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003877 if (is_export)
3878 {
3879 fp->uf_flags |= FC_EXPORT;
3880 // let ex_export() know the export worked.
3881 is_export = FALSE;
3882 }
3883
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003884 if (eap->cmdidx == CMD_def)
3885 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003886 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3887 // :func does not use Vim9 script syntax, even in a Vim9 script file
3888 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003889
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003890 goto ret_free;
3891
3892erret:
3893 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003894 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895errret_2:
3896 ga_clear_strings(&newlines);
3897ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003898 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003900 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003901 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003902 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003903 if (name != name_arg)
3904 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003905 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 did_emsg |= saved_did_emsg;
3907 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003908
3909 return fp;
3910}
3911
3912/*
3913 * ":function"
3914 */
3915 void
3916ex_function(exarg_T *eap)
3917{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003918 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003919}
3920
3921/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003922 * :defcompile - compile all :def functions in the current script that need to
3923 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003924 */
3925 void
3926ex_defcompile(exarg_T *eap UNUSED)
3927{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003928 long todo = (long)func_hashtab.ht_used;
3929 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003930 hashitem_T *hi;
3931 ufunc_T *ufunc;
3932
3933 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3934 {
3935 if (!HASHITEM_EMPTY(hi))
3936 {
3937 --todo;
3938 ufunc = HI2UF(hi);
3939 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003940 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3941 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003942 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003943 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003944
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003945 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003946 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003947 // a function has been added or removed, need to start over
3948 todo = (long)func_hashtab.ht_used;
3949 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003950 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003951 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003952 }
3953 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003954 }
3955 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003956}
3957
3958/*
3959 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3960 * Return 2 if "p" starts with "s:".
3961 * Return 0 otherwise.
3962 */
3963 int
3964eval_fname_script(char_u *p)
3965{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003966 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3967 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3969 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3970 return 5;
3971 if (p[0] == 's' && p[1] == ':')
3972 return 2;
3973 return 0;
3974}
3975
3976 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003977translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978{
3979 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003980 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003981 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003982}
3983
3984/*
3985 * Return TRUE when "ufunc" has old-style "..." varargs
3986 * or named varargs "...name: type".
3987 */
3988 int
3989has_varargs(ufunc_T *ufunc)
3990{
3991 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003992}
3993
3994/*
3995 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003996 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003997 */
3998 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003999function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000{
4001 char_u *nm = name;
4002 char_u *p;
4003 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004004 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004005 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004007 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4008 if (no_deref)
4009 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004010 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 nm = skipwhite(nm);
4012
Bram Moolenaare38eab22019-12-05 21:50:01 +01004013 // Only accept "funcname", "funcname ", "funcname (..." and
4014 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004016 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 vim_free(p);
4018 return n;
4019}
4020
Bram Moolenaar113e1072019-01-20 15:30:40 +01004021#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 char_u *
4023get_expanded_name(char_u *name, int check)
4024{
4025 char_u *nm = name;
4026 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004027 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004029 p = trans_function_name(&nm, &is_global, FALSE,
4030 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004032 if (p != NULL && *nm == NUL
4033 && (!check || translated_function_exists(p, is_global)))
4034 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035
4036 vim_free(p);
4037 return NULL;
4038}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004039#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041/*
4042 * Function given to ExpandGeneric() to obtain the list of user defined
4043 * function names.
4044 */
4045 char_u *
4046get_user_func_name(expand_T *xp, int idx)
4047{
4048 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004049 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050 static hashitem_T *hi;
4051 ufunc_T *fp;
4052
4053 if (idx == 0)
4054 {
4055 done = 0;
4056 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004057 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004059 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 {
4061 if (done++ > 0)
4062 ++hi;
4063 while (HASHITEM_EMPTY(hi))
4064 ++hi;
4065 fp = HI2UF(hi);
4066
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004067 // don't show dead, dict and lambda functions
4068 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004069 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004070 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071
4072 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004073 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074
4075 cat_func_name(IObuff, fp);
4076 if (xp->xp_context != EXPAND_USER_FUNC)
4077 {
4078 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004079 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 STRCAT(IObuff, ")");
4081 }
4082 return IObuff;
4083 }
4084 return NULL;
4085}
4086
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087/*
4088 * ":delfunction {name}"
4089 */
4090 void
4091ex_delfunction(exarg_T *eap)
4092{
4093 ufunc_T *fp = NULL;
4094 char_u *p;
4095 char_u *name;
4096 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004097 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098
4099 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004100 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 vim_free(fudi.fd_newkey);
4102 if (name == NULL)
4103 {
4104 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004105 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 return;
4107 }
4108 if (!ends_excmd(*skipwhite(p)))
4109 {
4110 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004111 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 return;
4113 }
4114 eap->nextcmd = check_nextcmd(p);
4115 if (eap->nextcmd != NULL)
4116 *p = NUL;
4117
4118 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004119 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120 vim_free(name);
4121
4122 if (!eap->skip)
4123 {
4124 if (fp == NULL)
4125 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004126 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004127 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 return;
4129 }
4130 if (fp->uf_calls > 0)
4131 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004132 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133 return;
4134 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004135 if (fp->uf_flags & FC_VIM9)
4136 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004137 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004138 return;
4139 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140
4141 if (fudi.fd_dict != NULL)
4142 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004143 // Delete the dict item that refers to the function, it will
4144 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4146 }
4147 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004148 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004149 // A normal function (not a numbered function or lambda) has a
4150 // refcount of 1 for the entry in the hashtable. When deleting
4151 // it and the refcount is more than one, it should be kept.
4152 // A numbered function and lambda should be kept if the refcount is
4153 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004154 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004155 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004156 // Function is still referenced somewhere. Don't free it but
4157 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004158 if (func_remove(fp))
4159 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004160 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004161 }
4162 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004163 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004164 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 }
4166}
4167
4168/*
4169 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004170 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 */
4172 void
4173func_unref(char_u *name)
4174{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004175 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004177 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004179 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004180 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004183 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004185 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004187 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004189 // Only delete it when it's not being used. Otherwise it's done
4190 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004191 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004192 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004193 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004194}
4195
4196/*
4197 * Unreference a Function: decrement the reference count and free it when it
4198 * becomes zero.
4199 */
4200 void
4201func_ptr_unref(ufunc_T *fp)
4202{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004203 if (fp != NULL && --fp->uf_refcount <= 0)
4204 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004205 // Only delete it when it's not being used. Otherwise it's done
4206 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004207 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004208 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 }
4210}
4211
4212/*
4213 * Count a reference to a Function.
4214 */
4215 void
4216func_ref(char_u *name)
4217{
4218 ufunc_T *fp;
4219
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004220 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004222 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004223 if (fp != NULL)
4224 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004226 // Only give an error for a numbered function.
4227 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004228 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004229}
4230
4231/*
4232 * Count a reference to a Function.
4233 */
4234 void
4235func_ptr_ref(ufunc_T *fp)
4236{
4237 if (fp != NULL)
4238 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239}
4240
4241/*
4242 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4243 * referenced from anywhere that is in use.
4244 */
4245 static int
4246can_free_funccal(funccall_T *fc, int copyID)
4247{
4248 return (fc->l_varlist.lv_copyID != copyID
4249 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004250 && fc->l_avars.dv_copyID != copyID
4251 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252}
4253
4254/*
4255 * ":return [expr]"
4256 */
4257 void
4258ex_return(exarg_T *eap)
4259{
4260 char_u *arg = eap->arg;
4261 typval_T rettv;
4262 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004263 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264
4265 if (current_funccal == NULL)
4266 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004267 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 return;
4269 }
4270
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004271 CLEAR_FIELD(evalarg);
4272 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4273
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274 if (eap->skip)
4275 ++emsg_skip;
4276
4277 eap->nextcmd = NULL;
4278 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004279 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 {
4281 if (!eap->skip)
4282 returning = do_return(eap, FALSE, TRUE, &rettv);
4283 else
4284 clear_tv(&rettv);
4285 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004286 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004287 else if (!eap->skip)
4288 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004289 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004290 update_force_abort();
4291
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 /*
4293 * Return unless the expression evaluation has been cancelled due to an
4294 * aborting error, an interrupt, or an exception.
4295 */
4296 if (!aborting())
4297 returning = do_return(eap, FALSE, TRUE, NULL);
4298 }
4299
Bram Moolenaare38eab22019-12-05 21:50:01 +01004300 // When skipping or the return gets pending, advance to the next command
4301 // in this line (!returning). Otherwise, ignore the rest of the line.
4302 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 if (returning)
4304 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004305 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 eap->nextcmd = check_nextcmd(arg);
4307
4308 if (eap->skip)
4309 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004310 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311}
4312
4313/*
4314 * ":1,25call func(arg1, arg2)" function call.
4315 */
4316 void
4317ex_call(exarg_T *eap)
4318{
4319 char_u *arg = eap->arg;
4320 char_u *startarg;
4321 char_u *name;
4322 char_u *tofree;
4323 int len;
4324 typval_T rettv;
4325 linenr_T lnum;
4326 int doesrange;
4327 int failed = FALSE;
4328 funcdict_T fudi;
4329 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004330 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331
Bram Moolenaare6b53242020-07-01 17:28:33 +02004332 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333 if (eap->skip)
4334 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004335 // trans_function_name() doesn't work well when skipping, use eval0()
4336 // instead to skip to any following command, e.g. for:
4337 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004339 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 clear_tv(&rettv);
4341 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004342 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 return;
4344 }
4345
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004346 tofree = trans_function_name(&arg, NULL, eap->skip,
4347 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348 if (fudi.fd_newkey != NULL)
4349 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004350 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004351 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 vim_free(fudi.fd_newkey);
4353 }
4354 if (tofree == NULL)
4355 return;
4356
Bram Moolenaare38eab22019-12-05 21:50:01 +01004357 // Increase refcount on dictionary, it could get deleted when evaluating
4358 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359 if (fudi.fd_dict != NULL)
4360 ++fudi.fd_dict->dv_refcount;
4361
Bram Moolenaare38eab22019-12-05 21:50:01 +01004362 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4363 // contents. For VAR_PARTIAL get its partial, unless we already have one
4364 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004365 len = (int)STRLEN(tofree);
4366 name = deref_func_name(tofree, &len,
4367 partial != NULL ? NULL : &partial, FALSE);
4368
Bram Moolenaare38eab22019-12-05 21:50:01 +01004369 // Skip white space to allow ":call func ()". Not good, but required for
4370 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004371 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004372 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004373
4374 if (*startarg != '(')
4375 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004376 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 goto end;
4378 }
4379
4380 /*
4381 * When skipping, evaluate the function once, to find the end of the
4382 * arguments.
4383 * When the function takes a range, this is discovered after the first
4384 * call, and the loop is broken.
4385 */
4386 if (eap->skip)
4387 {
4388 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004389 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 }
4391 else
4392 lnum = eap->line1;
4393 for ( ; lnum <= eap->line2; ++lnum)
4394 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004395 funcexe_T funcexe;
4396
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397 if (!eap->skip && eap->addr_count > 0)
4398 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004399 if (lnum > curbuf->b_ml.ml_line_count)
4400 {
4401 // If the function deleted lines or switched to another buffer
4402 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004403 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004404 break;
4405 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406 curwin->w_cursor.lnum = lnum;
4407 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004409 }
4410 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004411
Bram Moolenaara80faa82020-04-12 19:37:17 +02004412 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004413 funcexe.firstline = eap->line1;
4414 funcexe.lastline = eap->line2;
4415 funcexe.doesrange = &doesrange;
4416 funcexe.evaluate = !eap->skip;
4417 funcexe.partial = partial;
4418 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004419 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 {
4421 failed = TRUE;
4422 break;
4423 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004424 if (has_watchexpr())
4425 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004427 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004428 if (handle_subscript(&arg, &rettv,
4429 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430 {
4431 failed = TRUE;
4432 break;
4433 }
4434
4435 clear_tv(&rettv);
4436 if (doesrange || eap->skip)
4437 break;
4438
Bram Moolenaare38eab22019-12-05 21:50:01 +01004439 // Stop when immediately aborting on error, or when an interrupt
4440 // occurred or an exception was thrown but not caught.
4441 // get_func_tv() returned OK, so that the check for trailing
4442 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 if (aborting())
4444 break;
4445 }
4446 if (eap->skip)
4447 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004448 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449
Bram Moolenaare51bb172020-02-16 19:42:23 +01004450 // When inside :try we need to check for following "| catch".
4451 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004453 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004454 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004455 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004456 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004457 if (!failed)
4458 {
4459 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004460 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004461 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462 }
4463 else
4464 eap->nextcmd = check_nextcmd(arg);
4465 }
4466
4467end:
4468 dict_unref(fudi.fd_dict);
4469 vim_free(tofree);
4470}
4471
4472/*
4473 * Return from a function. Possibly makes the return pending. Also called
4474 * for a pending return at the ":endtry" or after returning from an extra
4475 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4476 * when called due to a ":return" command. "rettv" may point to a typval_T
4477 * with the return rettv. Returns TRUE when the return can be carried out,
4478 * FALSE when the return gets pending.
4479 */
4480 int
4481do_return(
4482 exarg_T *eap,
4483 int reanimate,
4484 int is_cmd,
4485 void *rettv)
4486{
4487 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004488 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489
4490 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004491 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004492 current_funccal->returned = FALSE;
4493
4494 /*
4495 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4496 * not in its finally clause (which then is to be executed next) is found.
4497 * In this case, make the ":return" pending for execution at the ":endtry".
4498 * Otherwise, return normally.
4499 */
4500 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4501 if (idx >= 0)
4502 {
4503 cstack->cs_pending[idx] = CSTP_RETURN;
4504
4505 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004506 // A pending return again gets pending. "rettv" points to an
4507 // allocated variable with the rettv of the original ":return"'s
4508 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 cstack->cs_rettv[idx] = rettv;
4510 else
4511 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004512 // When undoing a return in order to make it pending, get the stored
4513 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 if (reanimate)
4515 rettv = current_funccal->rettv;
4516
4517 if (rettv != NULL)
4518 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004519 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4521 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4522 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004523 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 }
4525 else
4526 cstack->cs_rettv[idx] = NULL;
4527
4528 if (reanimate)
4529 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004530 // The pending return value could be overwritten by a ":return"
4531 // without argument in a finally clause; reset the default
4532 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533 current_funccal->rettv->v_type = VAR_NUMBER;
4534 current_funccal->rettv->vval.v_number = 0;
4535 }
4536 }
4537 report_make_pending(CSTP_RETURN, rettv);
4538 }
4539 else
4540 {
4541 current_funccal->returned = TRUE;
4542
Bram Moolenaare38eab22019-12-05 21:50:01 +01004543 // If the return is carried out now, store the return value. For
4544 // a return immediately after reanimation, the value is already
4545 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546 if (!reanimate && rettv != NULL)
4547 {
4548 clear_tv(current_funccal->rettv);
4549 *current_funccal->rettv = *(typval_T *)rettv;
4550 if (!is_cmd)
4551 vim_free(rettv);
4552 }
4553 }
4554
4555 return idx < 0;
4556}
4557
4558/*
4559 * Free the variable with a pending return value.
4560 */
4561 void
4562discard_pending_return(void *rettv)
4563{
4564 free_tv((typval_T *)rettv);
4565}
4566
4567/*
4568 * Generate a return command for producing the value of "rettv". The result
4569 * is an allocated string. Used by report_pending() for verbose messages.
4570 */
4571 char_u *
4572get_return_cmd(void *rettv)
4573{
4574 char_u *s = NULL;
4575 char_u *tofree = NULL;
4576 char_u numbuf[NUMBUFLEN];
4577
4578 if (rettv != NULL)
4579 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4580 if (s == NULL)
4581 s = (char_u *)"";
4582
4583 STRCPY(IObuff, ":return ");
4584 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4585 if (STRLEN(s) + 8 >= IOSIZE)
4586 STRCPY(IObuff + IOSIZE - 4, "...");
4587 vim_free(tofree);
4588 return vim_strsave(IObuff);
4589}
4590
4591/*
4592 * Get next function line.
4593 * Called by do_cmdline() to get the next line.
4594 * Returns allocated string, or NULL for end of function.
4595 */
4596 char_u *
4597get_func_line(
4598 int c UNUSED,
4599 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004600 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004601 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004602{
4603 funccall_T *fcp = (funccall_T *)cookie;
4604 ufunc_T *fp = fcp->func;
4605 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004606 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607
Bram Moolenaare38eab22019-12-05 21:50:01 +01004608 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 if (fcp->dbg_tick != debug_tick)
4610 {
4611 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004612 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 fcp->dbg_tick = debug_tick;
4614 }
4615#ifdef FEAT_PROFILE
4616 if (do_profiling == PROF_YES)
4617 func_line_end(cookie);
4618#endif
4619
4620 gap = &fp->uf_lines;
4621 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4622 || fcp->returned)
4623 retval = NULL;
4624 else
4625 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004626 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627 while (fcp->linenr < gap->ga_len
4628 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4629 ++fcp->linenr;
4630 if (fcp->linenr >= gap->ga_len)
4631 retval = NULL;
4632 else
4633 {
4634 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004635 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004636#ifdef FEAT_PROFILE
4637 if (do_profiling == PROF_YES)
4638 func_line_start(cookie);
4639#endif
4640 }
4641 }
4642
Bram Moolenaare38eab22019-12-05 21:50:01 +01004643 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004644 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004646 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004647 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004648 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004649 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 fcp->dbg_tick = debug_tick;
4651 }
4652
4653 return retval;
4654}
4655
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656/*
4657 * Return TRUE if the currently active function should be ended, because a
4658 * return was encountered or an error occurred. Used inside a ":while".
4659 */
4660 int
4661func_has_ended(void *cookie)
4662{
4663 funccall_T *fcp = (funccall_T *)cookie;
4664
Bram Moolenaare38eab22019-12-05 21:50:01 +01004665 // Ignore the "abort" flag if the abortion behavior has been changed due to
4666 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4668 || fcp->returned);
4669}
4670
4671/*
4672 * return TRUE if cookie indicates a function which "abort"s on errors.
4673 */
4674 int
4675func_has_abort(
4676 void *cookie)
4677{
4678 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4679}
4680
4681
4682/*
4683 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4684 * Don't do this when "Func" is already a partial that was bound
4685 * explicitly (pt_auto is FALSE).
4686 * Changes "rettv" in-place.
4687 * Returns the updated "selfdict_in".
4688 */
4689 dict_T *
4690make_partial(dict_T *selfdict_in, typval_T *rettv)
4691{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004692 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 char_u *tofree = NULL;
4694 ufunc_T *fp;
4695 char_u fname_buf[FLEN_FIXED + 1];
4696 int error;
4697 dict_T *selfdict = selfdict_in;
4698
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004699 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4700 fp = rettv->vval.v_partial->pt_func;
4701 else
4702 {
4703 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4704 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004705 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004706 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004707 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004708 vim_free(tofree);
4709 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710
4711 if (fp != NULL && (fp->uf_flags & FC_DICT))
4712 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004713 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004714
4715 if (pt != NULL)
4716 {
4717 pt->pt_refcount = 1;
4718 pt->pt_dict = selfdict;
4719 pt->pt_auto = TRUE;
4720 selfdict = NULL;
4721 if (rettv->v_type == VAR_FUNC)
4722 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004723 // Just a function: Take over the function name and use
4724 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 pt->pt_name = rettv->vval.v_string;
4726 }
4727 else
4728 {
4729 partial_T *ret_pt = rettv->vval.v_partial;
4730 int i;
4731
Bram Moolenaare38eab22019-12-05 21:50:01 +01004732 // Partial: copy the function name, use selfdict and copy
4733 // args. Can't take over name or args, the partial might
4734 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004735 if (ret_pt->pt_name != NULL)
4736 {
4737 pt->pt_name = vim_strsave(ret_pt->pt_name);
4738 func_ref(pt->pt_name);
4739 }
4740 else
4741 {
4742 pt->pt_func = ret_pt->pt_func;
4743 func_ptr_ref(pt->pt_func);
4744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745 if (ret_pt->pt_argc > 0)
4746 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004747 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004749 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 pt->pt_argc = 0;
4751 else
4752 {
4753 pt->pt_argc = ret_pt->pt_argc;
4754 for (i = 0; i < pt->pt_argc; i++)
4755 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4756 }
4757 }
4758 partial_unref(ret_pt);
4759 }
4760 rettv->v_type = VAR_PARTIAL;
4761 rettv->vval.v_partial = pt;
4762 }
4763 }
4764 return selfdict;
4765}
4766
4767/*
4768 * Return the name of the executed function.
4769 */
4770 char_u *
4771func_name(void *cookie)
4772{
4773 return ((funccall_T *)cookie)->func->uf_name;
4774}
4775
4776/*
4777 * Return the address holding the next breakpoint line for a funccall cookie.
4778 */
4779 linenr_T *
4780func_breakpoint(void *cookie)
4781{
4782 return &((funccall_T *)cookie)->breakpoint;
4783}
4784
4785/*
4786 * Return the address holding the debug tick for a funccall cookie.
4787 */
4788 int *
4789func_dbg_tick(void *cookie)
4790{
4791 return &((funccall_T *)cookie)->dbg_tick;
4792}
4793
4794/*
4795 * Return the nesting level for a funccall cookie.
4796 */
4797 int
4798func_level(void *cookie)
4799{
4800 return ((funccall_T *)cookie)->level;
4801}
4802
4803/*
4804 * Return TRUE when a function was ended by a ":return" command.
4805 */
4806 int
4807current_func_returned(void)
4808{
4809 return current_funccal->returned;
4810}
4811
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 int
4813free_unref_funccal(int copyID, int testing)
4814{
4815 int did_free = FALSE;
4816 int did_free_funccal = FALSE;
4817 funccall_T *fc, **pfc;
4818
4819 for (pfc = &previous_funccal; *pfc != NULL; )
4820 {
4821 if (can_free_funccal(*pfc, copyID))
4822 {
4823 fc = *pfc;
4824 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004825 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 did_free = TRUE;
4827 did_free_funccal = TRUE;
4828 }
4829 else
4830 pfc = &(*pfc)->caller;
4831 }
4832 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004833 // When a funccal was freed some more items might be garbage
4834 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004835 (void)garbage_collect(testing);
4836
4837 return did_free;
4838}
4839
4840/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004841 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004842 */
4843 static funccall_T *
4844get_funccal(void)
4845{
4846 int i;
4847 funccall_T *funccal;
4848 funccall_T *temp_funccal;
4849
4850 funccal = current_funccal;
4851 if (debug_backtrace_level > 0)
4852 {
4853 for (i = 0; i < debug_backtrace_level; i++)
4854 {
4855 temp_funccal = funccal->caller;
4856 if (temp_funccal)
4857 funccal = temp_funccal;
4858 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004859 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 debug_backtrace_level = i;
4861 }
4862 }
4863 return funccal;
4864}
4865
4866/*
4867 * Return the hashtable used for local variables in the current funccal.
4868 * Return NULL if there is no current funccal.
4869 */
4870 hashtab_T *
4871get_funccal_local_ht()
4872{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004873 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 return NULL;
4875 return &get_funccal()->l_vars.dv_hashtab;
4876}
4877
4878/*
4879 * Return the l: scope variable.
4880 * Return NULL if there is no current funccal.
4881 */
4882 dictitem_T *
4883get_funccal_local_var()
4884{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004885 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004886 return NULL;
4887 return &get_funccal()->l_vars_var;
4888}
4889
4890/*
4891 * Return the hashtable used for argument in the current funccal.
4892 * Return NULL if there is no current funccal.
4893 */
4894 hashtab_T *
4895get_funccal_args_ht()
4896{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004897 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 return NULL;
4899 return &get_funccal()->l_avars.dv_hashtab;
4900}
4901
4902/*
4903 * Return the a: scope variable.
4904 * Return NULL if there is no current funccal.
4905 */
4906 dictitem_T *
4907get_funccal_args_var()
4908{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004909 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004911 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912}
4913
4914/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915 * List function variables, if there is a function.
4916 */
4917 void
4918list_func_vars(int *first)
4919{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004920 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004921 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004922 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923}
4924
4925/*
4926 * If "ht" is the hashtable for local variables in the current funccal, return
4927 * the dict that contains it.
4928 * Otherwise return NULL.
4929 */
4930 dict_T *
4931get_current_funccal_dict(hashtab_T *ht)
4932{
4933 if (current_funccal != NULL
4934 && ht == &current_funccal->l_vars.dv_hashtab)
4935 return &current_funccal->l_vars;
4936 return NULL;
4937}
4938
4939/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004940 * Search hashitem in parent scope.
4941 */
4942 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004943find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004944{
4945 funccall_T *old_current_funccal = current_funccal;
4946 hashtab_T *ht;
4947 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004948 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004949
4950 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4951 return NULL;
4952
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004953 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004954 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004955 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004956 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004957 ht = find_var_ht(name, &varname);
4958 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004959 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004960 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004961 if (!HASHITEM_EMPTY(hi))
4962 {
4963 *pht = ht;
4964 break;
4965 }
4966 }
4967 if (current_funccal == current_funccal->func->uf_scoped)
4968 break;
4969 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004970 }
4971 current_funccal = old_current_funccal;
4972
4973 return hi;
4974}
4975
4976/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004977 * Search variable in parent scope.
4978 */
4979 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004980find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004981{
4982 dictitem_T *v = NULL;
4983 funccall_T *old_current_funccal = current_funccal;
4984 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004985 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004986
4987 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4988 return NULL;
4989
Bram Moolenaare38eab22019-12-05 21:50:01 +01004990 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004991 current_funccal = current_funccal->func->uf_scoped;
4992 while (current_funccal)
4993 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004994 ht = find_var_ht(name, &varname);
4995 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004996 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004997 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004998 if (v != NULL)
4999 break;
5000 }
5001 if (current_funccal == current_funccal->func->uf_scoped)
5002 break;
5003 current_funccal = current_funccal->func->uf_scoped;
5004 }
5005 current_funccal = old_current_funccal;
5006
5007 return v;
5008}
5009
5010/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011 * Set "copyID + 1" in previous_funccal and callers.
5012 */
5013 int
5014set_ref_in_previous_funccal(int copyID)
5015{
5016 int abort = FALSE;
5017 funccall_T *fc;
5018
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005019 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005021 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005022 abort = abort
5023 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5024 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005025 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026 }
5027 return abort;
5028}
5029
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005030 static int
5031set_ref_in_funccal(funccall_T *fc, int copyID)
5032{
5033 int abort = FALSE;
5034
5035 if (fc->fc_copyID != copyID)
5036 {
5037 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005038 abort = abort
5039 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5040 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005041 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005042 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005043 }
5044 return abort;
5045}
5046
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047/*
5048 * Set "copyID" in all local vars and arguments in the call stack.
5049 */
5050 int
5051set_ref_in_call_stack(int copyID)
5052{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005053 int abort = FALSE;
5054 funccall_T *fc;
5055 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005056
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005057 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005058 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005059
5060 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005061 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5062 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005063 abort = abort || set_ref_in_funccal(fc, copyID);
5064
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005065 return abort;
5066}
5067
5068/*
5069 * Set "copyID" in all functions available by name.
5070 */
5071 int
5072set_ref_in_functions(int copyID)
5073{
5074 int todo;
5075 hashitem_T *hi = NULL;
5076 int abort = FALSE;
5077 ufunc_T *fp;
5078
5079 todo = (int)func_hashtab.ht_used;
5080 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005082 if (!HASHITEM_EMPTY(hi))
5083 {
5084 --todo;
5085 fp = HI2UF(hi);
5086 if (!func_name_refcount(fp->uf_name))
5087 abort = abort || set_ref_in_func(NULL, fp, copyID);
5088 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 }
5090 return abort;
5091}
5092
5093/*
5094 * Set "copyID" in all function arguments.
5095 */
5096 int
5097set_ref_in_func_args(int copyID)
5098{
5099 int i;
5100 int abort = FALSE;
5101
5102 for (i = 0; i < funcargs.ga_len; ++i)
5103 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5104 copyID, NULL, NULL);
5105 return abort;
5106}
5107
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005108/*
5109 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005110 * Returns TRUE if setting references failed somehow.
5111 */
5112 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005113set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005114{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005115 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005116 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005117 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005118 char_u fname_buf[FLEN_FIXED + 1];
5119 char_u *tofree = NULL;
5120 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005121 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005122
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005123 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005124 return FALSE;
5125
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005126 if (fp_in == NULL)
5127 {
5128 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005129 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005130 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005131 if (fp != NULL)
5132 {
5133 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005134 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005135 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005136
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005137 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005138 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005139}
5140
Bram Moolenaare38eab22019-12-05 21:50:01 +01005141#endif // FEAT_EVAL