blob: bf701b42eb13180bf725db3152c46873f8b46309 [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 Moolenaarf898f7c2021-01-16 18:09:52 +0100542 char_u *tofree1 = NULL;
543 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100544 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100545 int white_error = FALSE;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100546
547 if (equal_arrow && !in_vim9script())
548 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200549
550 ga_init(&newargs);
551 ga_init(&newlines);
552
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100553 // First, check if this is really a lambda expression. "->" or "=>" must
554 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100555 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100557 types_optional ? &argtypes : NULL, types_optional,
558 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100559 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100560 {
561 if (types_optional)
562 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200563 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100564 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200565
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200567 if (evaluate)
568 pnewargs = &newargs;
569 else
570 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100571 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100572 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100573 types_optional ? &argtypes : NULL, types_optional,
574 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100577 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100578 {
579 if (types_optional)
580 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100581 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100582 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100583 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200585
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100586 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
587 if (ret_type != NULL)
588 {
589 ret_type = vim_strsave(ret_type);
590 tofree2 = ret_type;
591 }
592
Bram Moolenaare38eab22019-12-05 21:50:01 +0100593 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200594 if (evaluate)
595 eval_lavars_used = &eval_lavars;
596
Bram Moolenaar65c44152020-12-24 15:14:01 +0100597 *arg = skipwhite_and_linebreak(*arg, evalarg);
598
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100599 // Recognize "{" as the start of a function body.
600 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100601 {
602 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100603 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100604 emsg("Lambda function body not supported yet");
605 goto errret;
606 }
607
Bram Moolenaare38eab22019-12-05 21:50:01 +0100608 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200609 start = *arg;
610 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200611 if (ret == FAIL)
612 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200613 if (evalarg != NULL)
614 {
615 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100616 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200617 evalarg->eval_tofree = NULL;
618 }
619
Bram Moolenaar65c44152020-12-24 15:14:01 +0100620 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100621 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100622 *arg = skipwhite_and_linebreak(*arg, evalarg);
623 if (**arg != '}')
624 {
625 semsg(_("E451: Expected }: %s"), *arg);
626 goto errret;
627 }
628 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100629 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200630
631 if (evaluate)
632 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200633 int len;
634 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200635 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200636 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200637
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200638 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200639 if (fp == NULL)
640 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200641 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200642 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200643 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200644 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200646 ga_init2(&newlines, (int)sizeof(char_u *), 1);
647 if (ga_grow(&newlines, 1) == FAIL)
648 goto errret;
649
Bram Moolenaare38eab22019-12-05 21:50:01 +0100650 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200651 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200652 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653 if (p == NULL)
654 goto errret;
655 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
656 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200657 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200658 if (strstr((char *)p + 7, "a:") == NULL)
659 // No a: variables are used for sure.
660 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200661
662 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100663 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200664 hash_add(&func_hashtab, UF2HIKEY(fp));
665 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200666 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100667 if (types_optional)
668 {
669 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
670 goto errret;
671 if (ret_type != NULL)
672 {
673 fp->uf_ret_type = parse_type(&ret_type,
674 &fp->uf_type_list, TRUE);
675 if (fp->uf_ret_type == NULL)
676 goto errret;
677 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100678 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100679 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100680 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100681
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200682 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200683 if (current_funccal != NULL && eval_lavars)
684 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200685 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200686 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200687 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200688 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200689
690#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691 if (prof_def_func())
692 func_do_profile(fp);
693#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200694 if (sandbox)
695 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100696 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200697 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200698 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200699 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200700 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100701 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200702
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200703 pt->pt_func = fp;
704 pt->pt_refcount = 1;
705 rettv->vval.v_partial = pt;
706 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200708
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200709 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200710 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100711 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200712 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100713 vim_free(tofree1);
714 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100715 if (types_optional)
716 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200717 return OK;
718
719errret:
720 ga_clear_strings(&newargs);
721 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100722 if (types_optional)
723 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200724 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100725 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200726 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100727 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200728 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100729 vim_free(tofree1);
730 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200731 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200732 return FAIL;
733}
734
735/*
736 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
737 * name it contains, otherwise return "name".
738 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
739 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100740 * If "type" is not NULL and a Vim9 script-local variable is found look up the
741 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200742 */
743 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100744deref_func_name(
745 char_u *name,
746 int *lenp,
747 partial_T **partialp,
748 type_T **type,
749 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200750{
751 dictitem_T *v;
752 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100753 char_u *s = NULL;
754 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200755
756 if (partialp != NULL)
757 *partialp = NULL;
758
759 cc = name[*lenp];
760 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100761 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200762 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100763 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200764 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100765 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200766 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100767 if (v->di_tv.vval.v_string == NULL)
768 {
769 *lenp = 0;
770 return (char_u *)""; // just in case
771 }
772 s = v->di_tv.vval.v_string;
773 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200774 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200775
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100776 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200777 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100778 partial_T *pt = v->di_tv.vval.v_partial;
779
780 if (pt == NULL)
781 {
782 *lenp = 0;
783 return (char_u *)""; // just in case
784 }
785 if (partialp != NULL)
786 *partialp = pt;
787 s = partial_name(pt);
788 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200789 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100790
791 if (s != NULL)
792 {
793 if (type != NULL && ht == get_script_local_ht())
794 {
795 svar_T *sv = find_typval_in_script(&v->di_tv);
796
797 if (sv != NULL)
798 *type = sv->sv_type;
799 }
800 return s;
801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200802 }
803
804 return name;
805}
806
807/*
808 * Give an error message with a function name. Handle <SNR> things.
809 * "ermsg" is to be passed without translation, use N_() instead of _().
810 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100811 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200812emsg_funcname(char *ermsg, char_u *name)
813{
814 char_u *p;
815
816 if (*name == K_SPECIAL)
817 p = concat_str((char_u *)"<SNR>", name + 3);
818 else
819 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100820 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200821 if (p != name)
822 vim_free(p);
823}
824
825/*
826 * Allocate a variable for the result of a function.
827 * Return OK or FAIL.
828 */
829 int
830get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200831 char_u *name, // name of the function
832 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200833 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200834 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200835 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200836 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200837{
838 char_u *argp;
839 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100840 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
841 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200842 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200843
844 /*
845 * Get the arguments.
846 */
847 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200848 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
849 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200850 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200851 // skip the '(' or ',' and possibly line breaks
852 argp = skipwhite_and_linebreak(argp + 1, evalarg);
853
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200854 if (*argp == ')' || *argp == ',' || *argp == NUL)
855 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200856 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200857 {
858 ret = FAIL;
859 break;
860 }
861 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200862 // The comma should come right after the argument, but this wasn't
863 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200864 if (vim9script)
865 {
866 if (*argp != ',' && *skipwhite(argp) == ',')
867 {
868 semsg(_(e_no_white_space_allowed_before_str), ",");
869 ret = FAIL;
870 break;
871 }
872 }
873 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200874 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200875 if (*argp != ',')
876 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200877 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
878 {
879 semsg(_(e_white_space_required_after_str), ",");
880 ret = FAIL;
881 break;
882 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200883 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200884 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200885 if (*argp == ')')
886 ++argp;
887 else
888 ret = FAIL;
889
890 if (ret == OK)
891 {
892 int i = 0;
893
894 if (get_vim_var_nr(VV_TESTING))
895 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100896 // Prepare for calling test_garbagecollect_now(), need to know
897 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200898 if (funcargs.ga_itemsize == 0)
899 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
900 for (i = 0; i < argcount; ++i)
901 if (ga_grow(&funcargs, 1) == OK)
902 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
903 &argvars[i];
904 }
905
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200906 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200907
908 funcargs.ga_len -= i;
909 }
910 else if (!aborting())
911 {
912 if (argcount == MAX_FUNC_ARGS)
913 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
914 else
915 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
916 }
917
918 while (--argcount >= 0)
919 clear_tv(&argvars[argcount]);
920
Bram Moolenaar8294d492020-08-10 22:40:56 +0200921 if (in_vim9script())
922 *arg = argp;
923 else
924 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200925 return ret;
926}
927
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200928/*
929 * Return TRUE if "p" starts with "<SID>" or "s:".
930 * Only works if eval_fname_script() returned non-zero for "p"!
931 */
932 static int
933eval_fname_sid(char_u *p)
934{
935 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
936}
937
938/*
939 * In a script change <SID>name() and s:name() to K_SNR 123_name().
940 * Change <SNR>123_name() to K_SNR 123_name().
941 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
942 * (slow).
943 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100944 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200945fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
946{
947 int llen;
948 char_u *fname;
949 int i;
950
951 llen = eval_fname_script(name);
952 if (llen > 0)
953 {
954 fname_buf[0] = K_SPECIAL;
955 fname_buf[1] = KS_EXTRA;
956 fname_buf[2] = (int)KE_SNR;
957 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100958 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200959 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200960 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100961 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200962 else
963 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200964 sprintf((char *)fname_buf + 3, "%ld_",
965 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200966 i = (int)STRLEN(fname_buf);
967 }
968 }
969 if (i + STRLEN(name + llen) < FLEN_FIXED)
970 {
971 STRCPY(fname_buf + i, name + llen);
972 fname = fname_buf;
973 }
974 else
975 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200976 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200977 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100978 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200979 else
980 {
981 *tofree = fname;
982 mch_memmove(fname, fname_buf, (size_t)i);
983 STRCPY(fname + i, name + llen);
984 }
985 }
986 }
987 else
988 fname = name;
989 return fname;
990}
991
992/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100993 * Find a function "name" in script "sid".
994 */
995 static ufunc_T *
996find_func_with_sid(char_u *name, int sid)
997{
998 hashitem_T *hi;
999 char_u buffer[200];
1000
1001 buffer[0] = K_SPECIAL;
1002 buffer[1] = KS_EXTRA;
1003 buffer[2] = (int)KE_SNR;
1004 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1005 (long)sid, name);
1006 hi = hash_find(&func_hashtab, buffer);
1007 if (!HASHITEM_EMPTY(hi))
1008 return HI2UF(hi);
1009
1010 return NULL;
1011}
1012
1013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001015 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001016 * Return NULL for unknown function.
1017 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001018 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001019find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001020{
1021 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001022 ufunc_T *func;
1023 imported_T *imported;
1024
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001025 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001026 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001027 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001028 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001029 int find_script_local = in_vim9script()
1030 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001031
Bram Moolenaar95006e32020-08-29 17:47:08 +02001032 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001033 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001034 // Find script-local function before global one.
1035 func = find_func_with_sid(name, current_sctx.sc_sid);
1036 if (func != NULL)
1037 return func;
1038 }
1039
Bram Moolenaarefa94442020-08-08 22:16:00 +02001040 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001041 && name[1] == KS_EXTRA
1042 && name[2] == KE_SNR)
1043 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001044 // Caller changes s: to <SNR>99_name.
1045
1046 after_script = name + 3;
1047 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001048 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001049 ++after_script;
1050 else
1051 after_script = NULL;
1052 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001053 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001054 {
1055 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001056 if (after_script != NULL && sid != current_sctx.sc_sid)
1057 imported = find_imported_in_script(after_script, 0, sid);
1058 else
1059 imported = find_imported(after_script == NULL
1060 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001061 if (imported != NULL && imported->imp_funcname != NULL)
1062 {
1063 hi = hash_find(&func_hashtab, imported->imp_funcname);
1064 if (!HASHITEM_EMPTY(hi))
1065 return HI2UF(hi);
1066 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001067 }
1068 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001069
Bram Moolenaara26b9702020-04-18 19:53:28 +02001070 hi = hash_find(&func_hashtab,
1071 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001072 if (!HASHITEM_EMPTY(hi))
1073 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001074
1075 return NULL;
1076}
1077
1078/*
1079 * Find a function by name, return pointer to it in ufuncs.
1080 * "cctx" is passed in a :def function to find imported functions.
1081 * Return NULL for unknown or dead function.
1082 */
1083 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001084find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001085{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001086 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001087
1088 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1089 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001090 return NULL;
1091}
1092
1093/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001094 * Return TRUE if "ufunc" is a global function.
1095 */
1096 int
1097func_is_global(ufunc_T *ufunc)
1098{
1099 return ufunc->uf_name[0] != K_SPECIAL;
1100}
1101
1102/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001103 * Copy the function name of "fp" to buffer "buf".
1104 * "buf" must be able to hold the function name plus three bytes.
1105 * Takes care of script-local function names.
1106 */
1107 static void
1108cat_func_name(char_u *buf, ufunc_T *fp)
1109{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001110 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111 {
1112 STRCPY(buf, "<SNR>");
1113 STRCAT(buf, fp->uf_name + 3);
1114 }
1115 else
1116 STRCPY(buf, fp->uf_name);
1117}
1118
1119/*
1120 * Add a number variable "name" to dict "dp" with value "nr".
1121 */
1122 static void
1123add_nr_var(
1124 dict_T *dp,
1125 dictitem_T *v,
1126 char *name,
1127 varnumber_T nr)
1128{
1129 STRCPY(v->di_key, name);
1130 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1131 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1132 v->di_tv.v_type = VAR_NUMBER;
1133 v->di_tv.v_lock = VAR_FIXED;
1134 v->di_tv.vval.v_number = nr;
1135}
1136
1137/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001138 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001139 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001140 static void
1141free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001142{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001143 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001144
1145 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1146 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001147 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001148
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001149 // When garbage collecting a funccall_T may be freed before the
1150 // function that references it, clear its uf_scoped field.
1151 // The function may have been redefined and point to another
1152 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001153 if (fp != NULL && fp->uf_scoped == fc)
1154 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001155 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001156 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001157
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001158 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001159 vim_free(fc);
1160}
1161
1162/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001163 * Free "fc" and what it contains.
1164 * Can be called only when "fc" is kept beyond the period of it called,
1165 * i.e. after cleanup_function_call(fc).
1166 */
1167 static void
1168free_funccal_contents(funccall_T *fc)
1169{
1170 listitem_T *li;
1171
1172 // Free all l: variables.
1173 vars_clear(&fc->l_vars.dv_hashtab);
1174
1175 // Free all a: variables.
1176 vars_clear(&fc->l_avars.dv_hashtab);
1177
1178 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001179 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001180 clear_tv(&li->li_tv);
1181
1182 free_funccal(fc);
1183}
1184
1185/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001186 * Handle the last part of returning from a function: free the local hashtable.
1187 * Unless it is still in use by a closure.
1188 */
1189 static void
1190cleanup_function_call(funccall_T *fc)
1191{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001192 int may_free_fc = fc->fc_refcount <= 0;
1193 int free_fc = TRUE;
1194
Bram Moolenaar6914c642017-04-01 21:21:30 +02001195 current_funccal = fc->caller;
1196
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001197 // Free all l: variables if not referred.
1198 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1199 vars_clear(&fc->l_vars.dv_hashtab);
1200 else
1201 free_fc = FALSE;
1202
1203 // If the a:000 list and the l: and a: dicts are not referenced and
1204 // there is no closure using it, we can free the funccall_T and what's
1205 // in it.
1206 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1207 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001208 else
1209 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001210 int todo;
1211 hashitem_T *hi;
1212 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001213
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001214 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001215
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001216 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001217 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1218 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1219 {
1220 if (!HASHITEM_EMPTY(hi))
1221 {
1222 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001223 di = HI2DI(hi);
1224 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001225 }
1226 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001227 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001228
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001229 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1230 fc->l_varlist.lv_first = NULL;
1231 else
1232 {
1233 listitem_T *li;
1234
1235 free_fc = FALSE;
1236
1237 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001238 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001239 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001240 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001241
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001242 if (free_fc)
1243 free_funccal(fc);
1244 else
1245 {
1246 static int made_copy = 0;
1247
1248 // "fc" is still in use. This can happen when returning "a:000",
1249 // assigning "l:" to a global variable or defining a closure.
1250 // Link "fc" in the list for garbage collection later.
1251 fc->caller = previous_funccal;
1252 previous_funccal = fc;
1253
1254 if (want_garbage_collect)
1255 // If garbage collector is ready, clear count.
1256 made_copy = 0;
1257 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001258 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001259 // We have made a lot of copies, worth 4 Mbyte. This can happen
1260 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001261 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001262 // too much memory.
1263 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001264 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001265 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001266 }
1267}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001268
1269/*
1270 * There are two kinds of function names:
1271 * 1. ordinary names, function defined with :function or :def
1272 * 2. numbered functions and lambdas
1273 * For the first we only count the name stored in func_hashtab as a reference,
1274 * using function() does not count as a reference, because the function is
1275 * looked up by name.
1276 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001277 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001278func_name_refcount(char_u *name)
1279{
1280 return isdigit(*name) || *name == '<';
1281}
1282
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001283/*
1284 * Unreference "fc": decrement the reference count and free it when it
1285 * becomes zero. "fp" is detached from "fc".
1286 * When "force" is TRUE we are exiting.
1287 */
1288 static void
1289funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1290{
1291 funccall_T **pfc;
1292 int i;
1293
1294 if (fc == NULL)
1295 return;
1296
1297 if (--fc->fc_refcount <= 0 && (force || (
1298 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1299 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1300 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1301 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1302 {
1303 if (fc == *pfc)
1304 {
1305 *pfc = fc->caller;
1306 free_funccal_contents(fc);
1307 return;
1308 }
1309 }
1310 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1311 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1312 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1313}
1314
1315/*
1316 * Remove the function from the function hashtable. If the function was
1317 * deleted while it still has references this was already done.
1318 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1319 */
1320 static int
1321func_remove(ufunc_T *fp)
1322{
1323 hashitem_T *hi;
1324
1325 // Return if it was already virtually deleted.
1326 if (fp->uf_flags & FC_DEAD)
1327 return FALSE;
1328
1329 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1330 if (!HASHITEM_EMPTY(hi))
1331 {
1332 // When there is a def-function index do not actually remove the
1333 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001334 // Do remove it when it's a copy.
1335 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001336 fp->uf_flags |= FC_DEAD;
1337 else
1338 hash_remove(&func_hashtab, hi);
1339 return TRUE;
1340 }
1341 return FALSE;
1342}
1343
1344 static void
1345func_clear_items(ufunc_T *fp)
1346{
1347 ga_clear_strings(&(fp->uf_args));
1348 ga_clear_strings(&(fp->uf_def_args));
1349 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001350 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001351 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001352 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001353 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001354 clear_type_list(&fp->uf_type_list);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001355 partial_unref(fp->uf_partial);
1356 fp->uf_partial = NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001357
1358#ifdef FEAT_LUA
1359 if (fp->uf_cb_free != NULL)
1360 {
1361 fp->uf_cb_free(fp->uf_cb_state);
1362 fp->uf_cb_free = NULL;
1363 }
1364
1365 fp->uf_cb_state = NULL;
1366 fp->uf_cb = NULL;
1367#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001368#ifdef FEAT_PROFILE
1369 VIM_CLEAR(fp->uf_tml_count);
1370 VIM_CLEAR(fp->uf_tml_total);
1371 VIM_CLEAR(fp->uf_tml_self);
1372#endif
1373}
1374
1375/*
1376 * Free all things that a function contains. Does not free the function
1377 * itself, use func_free() for that.
1378 * When "force" is TRUE we are exiting.
1379 */
1380 static void
1381func_clear(ufunc_T *fp, int force)
1382{
1383 if (fp->uf_cleared)
1384 return;
1385 fp->uf_cleared = TRUE;
1386
1387 // clear this function
1388 func_clear_items(fp);
1389 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001390 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001391}
1392
1393/*
1394 * Free a function and remove it from the list of functions. Does not free
1395 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001396 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001397 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001398 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001399 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001400func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001401{
1402 // Only remove it when not done already, otherwise we would remove a newer
1403 // version of the function with the same name.
1404 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1405 func_remove(fp);
1406
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001407 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001408 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001409 if (fp->uf_dfunc_idx > 0)
1410 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001411 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001412 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001413 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001414 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001415 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001416}
1417
1418/*
1419 * Free all things that a function contains and free the function itself.
1420 * When "force" is TRUE we are exiting.
1421 */
1422 static void
1423func_clear_free(ufunc_T *fp, int force)
1424{
1425 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001426 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1427 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001428 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001429 else
1430 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001431}
1432
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001433/*
1434 * Copy already defined function "lambda" to a new function with name "global".
1435 * This is for when a compiled function defines a global function.
1436 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001437 int
1438copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001439{
1440 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001441 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001442
1443 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001444 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001445 semsg(_(e_lambda_function_not_found_str), lambda);
1446 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001447 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001448
1449 // TODO: handle ! to overwrite
1450 fp = find_func(global, TRUE, NULL);
1451 if (fp != NULL)
1452 {
1453 semsg(_(e_funcexts), global);
1454 return FAIL;
1455 }
1456
1457 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1458 if (fp == NULL)
1459 return FAIL;
1460
1461 fp->uf_varargs = ufunc->uf_varargs;
1462 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1463 fp->uf_def_status = ufunc->uf_def_status;
1464 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1465 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1466 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1467 == FAIL
1468 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1469 goto failed;
1470
1471 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1472 : vim_strsave(ufunc->uf_name_exp);
1473 if (ufunc->uf_arg_types != NULL)
1474 {
1475 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1476 if (fp->uf_arg_types == NULL)
1477 goto failed;
1478 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1479 sizeof(type_T *) * fp->uf_args.ga_len);
1480 }
1481 if (ufunc->uf_def_arg_idx != NULL)
1482 {
1483 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1484 if (fp->uf_def_arg_idx == NULL)
1485 goto failed;
1486 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1487 sizeof(int) * fp->uf_def_args.ga_len + 1);
1488 }
1489 if (ufunc->uf_va_name != NULL)
1490 {
1491 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1492 if (fp->uf_va_name == NULL)
1493 goto failed;
1494 }
1495 fp->uf_ret_type = ufunc->uf_ret_type;
1496
1497 fp->uf_refcount = 1;
1498 STRCPY(fp->uf_name, global);
1499 hash_add(&func_hashtab, UF2HIKEY(fp));
1500
1501 // the referenced dfunc_T is now used one more time
1502 link_def_function(fp);
1503
1504 // Create a partial to store the context of the function, if not done
1505 // already.
1506 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1507 {
1508 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1509
1510 if (pt == NULL)
1511 goto failed;
1512 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
1513 goto failed;
1514 ufunc->uf_partial = pt;
1515 --pt->pt_refcount; // not referenced here yet
1516 }
1517 if (ufunc->uf_partial != NULL)
1518 {
1519 fp->uf_partial = ufunc->uf_partial;
1520 ++fp->uf_partial->pt_refcount;
1521 }
1522
1523 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001524
1525failed:
1526 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001527 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001528}
1529
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001530static int funcdepth = 0;
1531
1532/*
1533 * Increment the function call depth count.
1534 * Return FAIL when going over 'maxfuncdepth'.
1535 * Otherwise return OK, must call funcdepth_decrement() later!
1536 */
1537 int
1538funcdepth_increment(void)
1539{
1540 if (funcdepth >= p_mfd)
1541 {
1542 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1543 return FAIL;
1544 }
1545 ++funcdepth;
1546 return OK;
1547}
1548
1549 void
1550funcdepth_decrement(void)
1551{
1552 --funcdepth;
1553}
1554
1555/*
1556 * Get the current function call depth.
1557 */
1558 int
1559funcdepth_get(void)
1560{
1561 return funcdepth;
1562}
1563
1564/*
1565 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001566 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001567 * times as funcdepth_increment().
1568 */
1569 void
1570funcdepth_restore(int depth)
1571{
1572 funcdepth = depth;
1573}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001574
1575/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 * Call a user function.
1577 */
1578 static void
1579call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001580 ufunc_T *fp, // pointer to function
1581 int argcount, // nr of args
1582 typval_T *argvars, // arguments
1583 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001584 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001585 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001586{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001587 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001588 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 funccall_T *fc;
1590 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001591 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001592 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001593 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 int i;
1595 int ai;
1596 int islambda = FALSE;
1597 char_u numbuf[NUMBUFLEN];
1598 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599#ifdef FEAT_PROFILE
1600 proftime_T wait_start;
1601 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001602 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001604 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001605
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001606 // If depth of calling is getting too high, don't execute the function.
1607 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 rettv->v_type = VAR_NUMBER;
1610 rettv->vval.v_number = -1;
1611 return;
1612 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613
Bram Moolenaare38eab22019-12-05 21:50:01 +01001614 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001616 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001617 if (fc == NULL)
1618 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619 fc->caller = current_funccal;
1620 current_funccal = fc;
1621 fc->func = fp;
1622 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001624 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1626 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001627 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001628 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001629 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001631 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001632 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001633 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001634 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001635 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001636 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001637 free_funccal(fc);
1638 return;
1639 }
1640
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001641 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1642 islambda = TRUE;
1643
1644 /*
1645 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1646 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1647 * each argument variable and saves a lot of time.
1648 */
1649 /*
1650 * Init l: variables.
1651 */
1652 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1653 if (selfdict != NULL)
1654 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001655 // Set l:self to "selfdict". Use "name" to avoid a warning from
1656 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 v = &fc->fixvar[fixvar_idx++].var;
1658 name = v->di_key;
1659 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001660 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1662 v->di_tv.v_type = VAR_DICT;
1663 v->di_tv.v_lock = 0;
1664 v->di_tv.vval.v_dict = selfdict;
1665 ++selfdict->dv_refcount;
1666 }
1667
1668 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001669 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001670 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001671 * Set a:000 to a list with room for the "..." arguments.
1672 */
1673 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001674 if ((fp->uf_flags & FC_NOARGS) == 0)
1675 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001676 (varnumber_T)(argcount >= fp->uf_args.ga_len
1677 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001678 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001679 if ((fp->uf_flags & FC_NOARGS) == 0)
1680 {
1681 // Use "name" to avoid a warning from some compiler that checks the
1682 // destination size.
1683 v = &fc->fixvar[fixvar_idx++].var;
1684 name = v->di_key;
1685 STRCPY(name, "000");
1686 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1687 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1688 v->di_tv.v_type = VAR_LIST;
1689 v->di_tv.v_lock = VAR_FIXED;
1690 v->di_tv.vval.v_list = &fc->l_varlist;
1691 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001692 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1694 fc->l_varlist.lv_lock = VAR_FIXED;
1695
1696 /*
1697 * Set a:firstline to "firstline" and a:lastline to "lastline".
1698 * Set a:name to named arguments.
1699 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001700 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001702 if ((fp->uf_flags & FC_NOARGS) == 0)
1703 {
1704 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001705 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001706 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001707 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001708 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001709 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 {
1711 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001712 typval_T def_rettv;
1713 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714
1715 ai = i - fp->uf_args.ga_len;
1716 if (ai < 0)
1717 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001718 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 name = FUNCARG(fp, i);
1720 if (islambda)
1721 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001722
1723 // evaluate named argument default expression
1724 isdefault = ai + fp->uf_def_args.ga_len >= 0
1725 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1726 && argvars[i].vval.v_number == VVAL_NONE));
1727 if (isdefault)
1728 {
1729 char_u *default_expr = NULL;
1730 def_rettv.v_type = VAR_NUMBER;
1731 def_rettv.vval.v_number = -1;
1732
1733 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1734 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001735 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001736 {
1737 default_arg_err = 1;
1738 break;
1739 }
1740 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 }
1742 else
1743 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001744 if ((fp->uf_flags & FC_NOARGS) != 0)
1745 // Bail out if no a: arguments used (in lambda).
1746 break;
1747
Bram Moolenaare38eab22019-12-05 21:50:01 +01001748 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 sprintf((char *)numbuf, "%d", ai + 1);
1750 name = numbuf;
1751 }
1752 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1753 {
1754 v = &fc->fixvar[fixvar_idx++].var;
1755 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001756 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757 }
1758 else
1759 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001760 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761 if (v == NULL)
1762 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001763 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001766 // Note: the values are copied directly to avoid alloc/free.
1767 // "argvars" must have VAR_FIXED for v_lock.
1768 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 v->di_tv.v_lock = VAR_FIXED;
1770
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 if (addlocal)
1772 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001773 // Named arguments should be accessed without the "a:" prefix in
1774 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001775 copy_tv(&v->di_tv, &v->di_tv);
1776 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001778 else
1779 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780
1781 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1782 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001783 listitem_T *li = &fc->l_listitems[ai];
1784
1785 li->li_tv = argvars[i];
1786 li->li_tv.v_lock = VAR_FIXED;
1787 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 }
1789 }
1790
Bram Moolenaare38eab22019-12-05 21:50:01 +01001791 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001793
1794 if (fp->uf_flags & FC_SANDBOX)
1795 {
1796 using_sandbox = TRUE;
1797 ++sandbox;
1798 }
1799
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001800 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001801 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001802 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001803 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001804 ++no_wait_return;
1805 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001806
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001807 smsg(_("calling %s"), SOURCING_NAME);
1808 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001809 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001810 char_u buf[MSG_BUF_LEN];
1811 char_u numbuf2[NUMBUFLEN];
1812 char_u *tofree;
1813 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001815 msg_puts("(");
1816 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001817 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001818 if (i > 0)
1819 msg_puts(", ");
1820 if (argvars[i].v_type == VAR_NUMBER)
1821 msg_outnum((long)argvars[i].vval.v_number);
1822 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001824 // Do not want errors such as E724 here.
1825 ++emsg_off;
1826 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1827 --emsg_off;
1828 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001829 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001830 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001832 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1833 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001835 msg_puts((char *)s);
1836 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 }
1838 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001839 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001840 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001842 msg_puts("\n"); // don't overwrite this either
1843
1844 verbose_leave_scroll();
1845 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846 }
1847#ifdef FEAT_PROFILE
1848 if (do_profiling == PROF_YES)
1849 {
1850 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001851 {
1852 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001854 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 if (fp->uf_profiling
1856 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1857 {
1858 ++fp->uf_tm_count;
1859 profile_start(&call_start);
1860 profile_zero(&fp->uf_tm_children);
1861 }
1862 script_prof_save(&wait_start);
1863 }
1864#endif
1865
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001866 save_current_sctx = current_sctx;
1867 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 save_did_emsg = did_emsg;
1869 did_emsg = FALSE;
1870
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001871 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1872 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001873 else if (islambda)
1874 {
1875 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1876
1877 // A Lambda always has the command "return {expr}". It is much faster
1878 // to evaluate {expr} directly.
1879 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001880 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001881 --ex_nesting_level;
1882 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001883 else
1884 // call do_cmdline() to execute the lines
1885 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001886 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1887
1888 --RedrawingDisabled;
1889
Bram Moolenaare38eab22019-12-05 21:50:01 +01001890 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001891 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1892 {
1893 clear_tv(rettv);
1894 rettv->v_type = VAR_NUMBER;
1895 rettv->vval.v_number = -1;
1896 }
1897
1898#ifdef FEAT_PROFILE
1899 if (do_profiling == PROF_YES && (fp->uf_profiling
1900 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1901 {
1902 profile_end(&call_start);
1903 profile_sub_wait(&wait_start, &call_start);
1904 profile_add(&fp->uf_tm_total, &call_start);
1905 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1906 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1907 {
1908 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1909 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1910 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001911 if (started_profiling)
1912 // make a ":profdel func" stop profiling the function
1913 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001914 }
1915#endif
1916
Bram Moolenaare38eab22019-12-05 21:50:01 +01001917 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 if (p_verbose >= 12)
1919 {
1920 ++no_wait_return;
1921 verbose_enter_scroll();
1922
1923 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001924 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001925 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001926 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 (long)fc->rettv->vval.v_number);
1928 else
1929 {
1930 char_u buf[MSG_BUF_LEN];
1931 char_u numbuf2[NUMBUFLEN];
1932 char_u *tofree;
1933 char_u *s;
1934
Bram Moolenaare38eab22019-12-05 21:50:01 +01001935 // The value may be very long. Skip the middle part, so that we
1936 // have some idea how it starts and ends. smsg() would always
1937 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938 ++emsg_off;
1939 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1940 --emsg_off;
1941 if (s != NULL)
1942 {
1943 if (vim_strsize(s) > MSG_BUF_CLEN)
1944 {
1945 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1946 s = buf;
1947 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001948 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001949 vim_free(tofree);
1950 }
1951 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001952 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001953
1954 verbose_leave_scroll();
1955 --no_wait_return;
1956 }
1957
Bram Moolenaare31ee862020-01-07 20:59:34 +01001958 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001959 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001960 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961#ifdef FEAT_PROFILE
1962 if (do_profiling == PROF_YES)
1963 script_prof_restore(&wait_start);
1964#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001965 if (using_sandbox)
1966 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001968 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001969 {
1970 ++no_wait_return;
1971 verbose_enter_scroll();
1972
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001973 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001974 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001975
1976 verbose_leave_scroll();
1977 --no_wait_return;
1978 }
1979
1980 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001981 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001982 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001983}
1984
1985/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001986 * Check the argument count for user function "fp".
1987 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1988 */
1989 int
1990check_user_func_argcount(ufunc_T *fp, int argcount)
1991{
1992 int regular_args = fp->uf_args.ga_len;
1993
1994 if (argcount < regular_args - fp->uf_def_args.ga_len)
1995 return FCERR_TOOFEW;
1996 else if (!has_varargs(fp) && argcount > regular_args)
1997 return FCERR_TOOMANY;
1998 return FCERR_UNKNOWN;
1999}
2000
2001/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002003 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002004 int
2005call_user_func_check(
2006 ufunc_T *fp,
2007 int argcount,
2008 typval_T *argvars,
2009 typval_T *rettv,
2010 funcexe_T *funcexe,
2011 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002012{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002014
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002015 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2016 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002017 error = check_user_func_argcount(fp, argcount);
2018 if (error != FCERR_UNKNOWN)
2019 return error;
2020 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002021 error = FCERR_DICT;
2022 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002023 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 int did_save_redo = FALSE;
2025 save_redo_T save_redo;
2026
2027 /*
2028 * Call the user function.
2029 * Save and restore search patterns, script variables and
2030 * redo buffer.
2031 */
2032 save_search_patterns();
2033 if (!ins_compl_active())
2034 {
2035 saveRedobuff(&save_redo);
2036 did_save_redo = TRUE;
2037 }
2038 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002039 call_user_func(fp, argcount, argvars, rettv, funcexe,
2040 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002041 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2042 // Function was unreferenced while being used, free it now.
2043 func_clear_free(fp, FALSE);
2044 if (did_save_redo)
2045 restoreRedobuff(&save_redo);
2046 restore_search_patterns();
2047 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002048 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002049 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002050}
2051
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002052static funccal_entry_T *funccal_stack = NULL;
2053
2054/*
2055 * Save the current function call pointer, and set it to NULL.
2056 * Used when executing autocommands and for ":source".
2057 */
2058 void
2059save_funccal(funccal_entry_T *entry)
2060{
2061 entry->top_funccal = current_funccal;
2062 entry->next = funccal_stack;
2063 funccal_stack = entry;
2064 current_funccal = NULL;
2065}
2066
2067 void
2068restore_funccal(void)
2069{
2070 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002071 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002072 else
2073 {
2074 current_funccal = funccal_stack->top_funccal;
2075 funccal_stack = funccal_stack->next;
2076 }
2077}
2078
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002079 funccall_T *
2080get_current_funccal(void)
2081{
2082 return current_funccal;
2083}
2084
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002085/*
2086 * Mark all functions of script "sid" as deleted.
2087 */
2088 void
2089delete_script_functions(int sid)
2090{
2091 hashitem_T *hi;
2092 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002093 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002094 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002095 size_t len;
2096
2097 buf[0] = K_SPECIAL;
2098 buf[1] = KS_EXTRA;
2099 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002100 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002101 len = STRLEN(buf);
2102
Bram Moolenaarce658352020-07-31 23:47:12 +02002103 while (todo > 0)
2104 {
2105 todo = func_hashtab.ht_used;
2106 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2107 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002108 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002109 fp = HI2UF(hi);
2110 if (STRNCMP(fp->uf_name, buf, len) == 0)
2111 {
2112 int changed = func_hashtab.ht_changed;
2113
2114 fp->uf_flags |= FC_DEAD;
2115 func_clear(fp, TRUE);
2116 // When clearing a function another function can be cleared
2117 // as a side effect. When that happens start over.
2118 if (changed != func_hashtab.ht_changed)
2119 break;
2120 }
2121 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002122 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002123 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002124}
2125
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002126#if defined(EXITFREE) || defined(PROTO)
2127 void
2128free_all_functions(void)
2129{
2130 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002131 ufunc_T *fp;
2132 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002133 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002134 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002135
Bram Moolenaare38eab22019-12-05 21:50:01 +01002136 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002137 while (current_funccal != NULL)
2138 {
2139 clear_tv(current_funccal->rettv);
2140 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002141 if (current_funccal == NULL && funccal_stack != NULL)
2142 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002143 }
2144
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 // First clear what the functions contain. Since this may lower the
2146 // reference count of a function, it may also free a function and change
2147 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002148 while (todo > 0)
2149 {
2150 todo = func_hashtab.ht_used;
2151 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2152 if (!HASHITEM_EMPTY(hi))
2153 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002154 // clear the def function index now
2155 fp = HI2UF(hi);
2156 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002157 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002158
Bram Moolenaare38eab22019-12-05 21:50:01 +01002159 // Only free functions that are not refcounted, those are
2160 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002161 if (func_name_refcount(fp->uf_name))
2162 ++skipped;
2163 else
2164 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002165 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002166 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002167 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002168 {
2169 skipped = 0;
2170 break;
2171 }
2172 }
2173 --todo;
2174 }
2175 }
2176
Bram Moolenaare38eab22019-12-05 21:50:01 +01002177 // Now actually free the functions. Need to start all over every time,
2178 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002179 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002180 while (func_hashtab.ht_used > skipped)
2181 {
2182 todo = func_hashtab.ht_used;
2183 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184 if (!HASHITEM_EMPTY(hi))
2185 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002186 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002187 // Only free functions that are not refcounted, those are
2188 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002189 fp = HI2UF(hi);
2190 if (func_name_refcount(fp->uf_name))
2191 ++skipped;
2192 else
2193 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002194 if (func_free(fp, FALSE) == OK)
2195 {
2196 skipped = 0;
2197 break;
2198 }
2199 // did not actually free it
2200 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002201 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002202 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002203 }
2204 if (skipped == 0)
2205 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002206
2207 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002208}
2209#endif
2210
2211/*
2212 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002213 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 * "len" is the length of "name", or -1 for NUL terminated.
2215 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002216 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217builtin_function(char_u *name, int len)
2218{
2219 char_u *p;
2220
Bram Moolenaara26b9702020-04-18 19:53:28 +02002221 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002222 return FALSE;
2223 p = vim_strchr(name, AUTOLOAD_CHAR);
2224 return p == NULL || (len > 0 && p > name + len);
2225}
2226
2227 int
2228func_call(
2229 char_u *name,
2230 typval_T *args,
2231 partial_T *partial,
2232 dict_T *selfdict,
2233 typval_T *rettv)
2234{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002235 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002236 listitem_T *item;
2237 typval_T argv[MAX_FUNC_ARGS + 1];
2238 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002239 int r = 0;
2240
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002241 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002242 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002243 {
2244 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2245 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002246 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 break;
2248 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002249 // Make a copy of each argument. This is needed to be able to set
2250 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002251 copy_tv(&item->li_tv, &argv[argc++]);
2252 }
2253
2254 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002255 {
2256 funcexe_T funcexe;
2257
Bram Moolenaara80faa82020-04-12 19:37:17 +02002258 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002259 funcexe.firstline = curwin->w_cursor.lnum;
2260 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002261 funcexe.evaluate = TRUE;
2262 funcexe.partial = partial;
2263 funcexe.selfdict = selfdict;
2264 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002266
Bram Moolenaare38eab22019-12-05 21:50:01 +01002267 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268 while (argc > 0)
2269 clear_tv(&argv[--argc]);
2270
2271 return r;
2272}
2273
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002274static int callback_depth = 0;
2275
2276 int
2277get_callback_depth(void)
2278{
2279 return callback_depth;
2280}
2281
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002282/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002283 * Invoke call_func() with a callback.
2284 */
2285 int
2286call_callback(
2287 callback_T *callback,
2288 int len, // length of "name" or -1 to use strlen()
2289 typval_T *rettv, // return value goes here
2290 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002291 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002292 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002293{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002294 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002295 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002296
Bram Moolenaara80faa82020-04-12 19:37:17 +02002297 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002298 funcexe.evaluate = TRUE;
2299 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002300 ++callback_depth;
2301 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2302 --callback_depth;
2303 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002304}
2305
2306/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002307 * Give an error message for the result of a function.
2308 * Nothing if "error" is FCERR_NONE.
2309 */
2310 void
2311user_func_error(int error, char_u *name)
2312{
2313 switch (error)
2314 {
2315 case FCERR_UNKNOWN:
2316 emsg_funcname(e_unknownfunc, name);
2317 break;
2318 case FCERR_NOTMETHOD:
2319 emsg_funcname(
2320 N_("E276: Cannot use function as a method: %s"), name);
2321 break;
2322 case FCERR_DELETED:
2323 emsg_funcname(N_(e_func_deleted), name);
2324 break;
2325 case FCERR_TOOMANY:
2326 emsg_funcname((char *)e_toomanyarg, name);
2327 break;
2328 case FCERR_TOOFEW:
2329 emsg_funcname((char *)e_toofewarg, name);
2330 break;
2331 case FCERR_SCRIPT:
2332 emsg_funcname(
2333 N_("E120: Using <SID> not in a script context: %s"), name);
2334 break;
2335 case FCERR_DICT:
2336 emsg_funcname(
2337 N_("E725: Calling dict function without Dictionary: %s"),
2338 name);
2339 break;
2340 }
2341}
2342
2343/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002345 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002346 * Return FAIL when the function can't be called, OK otherwise.
2347 * Also returns OK when an error was encountered while executing the function.
2348 */
2349 int
2350call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002351 char_u *funcname, // name of the function
2352 int len, // length of "name" or -1 to use strlen()
2353 typval_T *rettv, // return value goes here
2354 int argcount_in, // number of "argvars"
2355 typval_T *argvars_in, // vars for arguments, must have "argcount"
2356 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002357 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358{
2359 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002360 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002362 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 char_u fname_buf[FLEN_FIXED + 1];
2364 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002365 char_u *fname = NULL;
2366 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 int argcount = argcount_in;
2368 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002369 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002370 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2371 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002373 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002374 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002375
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002376 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2377 // even when call_func() returns FAIL.
2378 rettv->v_type = VAR_UNKNOWN;
2379
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002380 if (partial != NULL)
2381 fp = partial->pt_func;
2382 if (fp == NULL)
2383 {
2384 // Make a copy of the name, if it comes from a funcref variable it
2385 // could be changed or deleted in the called function.
2386 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2387 if (name == NULL)
2388 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002389
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002390 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2391 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002393 if (funcexe->doesrange != NULL)
2394 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002395
2396 if (partial != NULL)
2397 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002398 // When the function has a partial with a dict and there is a dict
2399 // argument, use the dict argument. That is backwards compatible.
2400 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002401 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002402 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002403 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 {
2405 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002406 {
2407 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2408 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002409 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002410 goto theend;
2411 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002413 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002414 for (i = 0; i < argcount_in; ++i)
2415 argv[i + argv_clear] = argvars_in[i];
2416 argvars = argv;
2417 argcount = partial->pt_argc + argcount_in;
2418 }
2419 }
2420
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002421 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2422 {
2423 // Check that the argument types are OK for the types of the funcref.
2424 if (check_argument_types(funcexe->check_type, argvars, argcount,
2425 name) == FAIL)
2426 error = FCERR_OTHER;
2427 }
2428
Bram Moolenaaref140542019-12-31 21:27:13 +01002429 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 {
2431 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002432 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433
Bram Moolenaar333894b2020-08-01 18:53:07 +02002434 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002435 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002436 {
2437 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002439 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440
Bram Moolenaare38eab22019-12-05 21:50:01 +01002441 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002443 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002445 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 {
2447 /*
2448 * User defined function.
2449 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002450 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002451 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452
Bram Moolenaare38eab22019-12-05 21:50:01 +01002453 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 if (fp == NULL
2455 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002456 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 && !aborting())
2458 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002459 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002460 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002462 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2464 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002465 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002466 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002468 if (fp == NULL)
2469 {
2470 char_u *p = untrans_function_name(rfname);
2471
2472 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002473 // Don't do this if the name starts with "s:".
2474 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002475 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002476 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002478 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002479 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002480#ifdef FEAT_LUA
2481 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2482 {
2483 cfunc_T cb = fp->uf_cb;
2484
2485 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2486 }
2487#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002488 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002490 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002491 // postponed filling in the arguments, do it now
2492 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002493 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002494
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002495 if (funcexe->basetv != NULL)
2496 {
2497 // Method call: base->Method()
2498 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2499 argv[0] = *funcexe->basetv;
2500 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002501 argvars = argv;
2502 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002503 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002504
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002505 error = call_user_func_check(fp, argcount, argvars, rettv,
2506 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 }
2508 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002509 else if (funcexe->basetv != NULL)
2510 {
2511 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002512 * expr->method(): Find the method name in the table, call its
2513 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002514 */
2515 error = call_internal_method(fname, argcount, argvars, rettv,
2516 funcexe->basetv);
2517 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 else
2519 {
2520 /*
2521 * Find the function name in the table, call its implementation.
2522 */
2523 error = call_internal_func(fname, argcount, argvars, rettv);
2524 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002525
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 /*
2527 * The function call (or "FuncUndefined" autocommand sequence) might
2528 * have been aborted by an error, an interrupt, or an explicitly thrown
2529 * exception that has not been caught so far. This situation can be
2530 * tested for by calling aborting(). For an error in an internal
2531 * function or for the "E132" error in call_user_func(), however, the
2532 * throw point at which the "force_abort" flag (temporarily reset by
2533 * emsg()) is normally updated has not been reached yet. We need to
2534 * update that flag first to make aborting() reliable.
2535 */
2536 update_force_abort();
2537 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002538 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 ret = OK;
2540
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002541theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 /*
2543 * Report an error unless the argument evaluation or function call has been
2544 * cancelled due to an aborting error, an interrupt, or an exception.
2545 */
2546 if (!aborting())
2547 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002548 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 }
2550
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002551 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002553 clear_tv(&argv[--argv_clear + argv_base]);
2554
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555 vim_free(tofree);
2556 vim_free(name);
2557
2558 return ret;
2559}
2560
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002561 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002562printable_func_name(ufunc_T *fp)
2563{
2564 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2565}
2566
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002567/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002568 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 */
2570 static void
2571list_func_head(ufunc_T *fp, int indent)
2572{
2573 int j;
2574
2575 msg_start();
2576 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002577 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002578 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002579 msg_puts("def ");
2580 else
2581 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002582 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002583 msg_putchar('(');
2584 for (j = 0; j < fp->uf_args.ga_len; ++j)
2585 {
2586 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002587 msg_puts(", ");
2588 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002589 if (fp->uf_arg_types != NULL)
2590 {
2591 char *tofree;
2592
2593 msg_puts(": ");
2594 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2595 vim_free(tofree);
2596 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002597 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2598 {
2599 msg_puts(" = ");
2600 msg_puts(((char **)(fp->uf_def_args.ga_data))
2601 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2602 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 }
2604 if (fp->uf_varargs)
2605 {
2606 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002607 msg_puts(", ");
2608 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002609 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002610 if (fp->uf_va_name != NULL)
2611 {
2612 if (j)
2613 msg_puts(", ");
2614 msg_puts("...");
2615 msg_puts((char *)fp->uf_va_name);
2616 if (fp->uf_va_type)
2617 {
2618 char *tofree;
2619
2620 msg_puts(": ");
2621 msg_puts(type_name(fp->uf_va_type, &tofree));
2622 vim_free(tofree);
2623 }
2624 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002625 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002626
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002627 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002628 {
2629 if (fp->uf_ret_type != &t_void)
2630 {
2631 char *tofree;
2632
2633 msg_puts(": ");
2634 msg_puts(type_name(fp->uf_ret_type, &tofree));
2635 vim_free(tofree);
2636 }
2637 }
2638 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002639 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002641 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002643 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002644 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002645 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 msg_clr_eos();
2647 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002648 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649}
2650
2651/*
2652 * Get a function name, translating "<SID>" and "<SNR>".
2653 * Also handles a Funcref in a List or Dictionary.
2654 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002655 * Set "*is_global" to TRUE when the function must be global, unless
2656 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 * flags:
2658 * TFN_INT: internal function name OK
2659 * TFN_QUIET: be quiet
2660 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002661 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 * Advances "pp" to just after the function name (if no error).
2663 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002664 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665trans_function_name(
2666 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002667 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002668 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002670 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002671 partial_T **partial, // return: partial of a FuncRef
2672 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673{
2674 char_u *name = NULL;
2675 char_u *start;
2676 char_u *end;
2677 int lead;
2678 char_u sid_buf[20];
2679 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002680 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002682 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002683 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684
2685 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002686 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 start = *pp;
2688
Bram Moolenaare38eab22019-12-05 21:50:01 +01002689 // Check for hard coded <SNR>: already translated function ID (from a user
2690 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2692 && (*pp)[2] == (int)KE_SNR)
2693 {
2694 *pp += 3;
2695 len = get_id_len(pp) + 3;
2696 return vim_strnsave(start, len);
2697 }
2698
Bram Moolenaare38eab22019-12-05 21:50:01 +01002699 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2700 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 lead = eval_fname_script(start);
2702 if (lead > 2)
2703 start += lead;
2704
Bram Moolenaare38eab22019-12-05 21:50:01 +01002705 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002706 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 lead > 2 ? 0 : FNE_CHECK_START);
2708 if (end == start)
2709 {
2710 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002711 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 goto theend;
2713 }
2714 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2715 {
2716 /*
2717 * Report an invalid expression in braces, unless the expression
2718 * evaluation has been cancelled due to an aborting error, an
2719 * interrupt, or an exception.
2720 */
2721 if (!aborting())
2722 {
2723 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002724 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 }
2726 else
2727 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2728 goto theend;
2729 }
2730
2731 if (lv.ll_tv != NULL)
2732 {
2733 if (fdp != NULL)
2734 {
2735 fdp->fd_dict = lv.ll_dict;
2736 fdp->fd_newkey = lv.ll_newkey;
2737 lv.ll_newkey = NULL;
2738 fdp->fd_di = lv.ll_di;
2739 }
2740 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2741 {
2742 name = vim_strsave(lv.ll_tv->vval.v_string);
2743 *pp = end;
2744 }
2745 else if (lv.ll_tv->v_type == VAR_PARTIAL
2746 && lv.ll_tv->vval.v_partial != NULL)
2747 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002748 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002749 *pp = end;
2750 if (partial != NULL)
2751 *partial = lv.ll_tv->vval.v_partial;
2752 }
2753 else
2754 {
2755 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2756 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002757 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 else
2759 *pp = end;
2760 name = NULL;
2761 }
2762 goto theend;
2763 }
2764
2765 if (lv.ll_name == NULL)
2766 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002767 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 *pp = end;
2769 goto theend;
2770 }
2771
Bram Moolenaare38eab22019-12-05 21:50:01 +01002772 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 if (lv.ll_exp_name != NULL)
2774 {
2775 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002776 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 flags & TFN_NO_AUTOLOAD);
2778 if (name == lv.ll_exp_name)
2779 name = NULL;
2780 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002781 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 {
2783 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002784 name = deref_func_name(*pp, &len, partial, type,
2785 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 if (name == *pp)
2787 name = NULL;
2788 }
2789 if (name != NULL)
2790 {
2791 name = vim_strsave(name);
2792 *pp = end;
2793 if (STRNCMP(name, "<SNR>", 5) == 0)
2794 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002795 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 name[0] = K_SPECIAL;
2797 name[1] = KS_EXTRA;
2798 name[2] = (int)KE_SNR;
2799 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2800 }
2801 goto theend;
2802 }
2803
2804 if (lv.ll_exp_name != NULL)
2805 {
2806 len = (int)STRLEN(lv.ll_exp_name);
2807 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2808 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2809 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002810 // When there was "s:" already or the name expanded to get a
2811 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 lv.ll_name += 2;
2813 len -= 2;
2814 lead = 2;
2815 }
2816 }
2817 else
2818 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002819 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002821 {
2822 if (is_global != NULL && lv.ll_name[0] == 'g')
2823 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 len = (int)(end - lv.ll_name);
2827 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002828 if (len <= 0)
2829 {
2830 if (!skip)
2831 emsg(_(e_function_name));
2832 goto theend;
2833 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002835 // In Vim9 script a user function is script-local by default, unless it
2836 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002837 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002838 if (vim9script)
2839 {
2840 char_u *p;
2841
2842 // SomeScript#func() is a global function.
2843 for (p = start; *p != NUL && *p != '('; ++p)
2844 if (*p == AUTOLOAD_CHAR)
2845 vim9script = FALSE;
2846 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002847
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 /*
2849 * Copy the function name to allocated memory.
2850 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2851 * Accept <SNR>123_name() outside a script.
2852 */
2853 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002854 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 if (!vim9script)
2858 lead = 3;
2859 if (vim9script || (lv.ll_exp_name != NULL
2860 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 || eval_fname_sid(*pp))
2862 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002863 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002864 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002866 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 goto theend;
2868 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002869 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002870 if (vim9script)
2871 extra = 3 + (int)STRLEN(sid_buf);
2872 else
2873 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 }
2875 }
2876 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2877 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002878 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002879 start);
2880 goto theend;
2881 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002882 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 {
2884 char_u *cp = vim_strchr(lv.ll_name, ':');
2885
2886 if (cp != NULL && cp < end)
2887 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002888 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889 goto theend;
2890 }
2891 }
2892
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002893 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002894 if (name != NULL)
2895 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002896 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897 {
2898 name[0] = K_SPECIAL;
2899 name[1] = KS_EXTRA;
2900 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 STRCPY(name + 3, sid_buf);
2903 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002904 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2905 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 }
2907 *pp = end;
2908
2909theend:
2910 clear_lval(&lv);
2911 return name;
2912}
2913
2914/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002915 * Assuming "name" is the result of trans_function_name() and it was prefixed
2916 * to use the script-local name, return the unmodified name (points into
2917 * "name"). Otherwise return NULL.
2918 * This can be used to first search for a script-local function and fall back
2919 * to the global function if not found.
2920 */
2921 char_u *
2922untrans_function_name(char_u *name)
2923{
2924 char_u *p;
2925
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002926 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002927 {
2928 p = vim_strchr(name, '_');
2929 if (p != NULL)
2930 return p + 1;
2931 }
2932 return NULL;
2933}
2934
2935/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002936 * List functions. When "regmatch" is NULL all of then.
2937 * Otherwise functions matching "regmatch".
2938 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002939 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002940list_functions(regmatch_T *regmatch)
2941{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002942 int changed = func_hashtab.ht_changed;
2943 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002944 hashitem_T *hi;
2945
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002946 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002947 {
2948 if (!HASHITEM_EMPTY(hi))
2949 {
2950 ufunc_T *fp = HI2UF(hi);
2951
2952 --todo;
2953 if ((fp->uf_flags & FC_DEAD) == 0
2954 && (regmatch == NULL
2955 ? !message_filtered(fp->uf_name)
2956 && !func_name_refcount(fp->uf_name)
2957 : !isdigit(*fp->uf_name)
2958 && vim_regexec(regmatch, fp->uf_name, 0)))
2959 {
2960 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002961 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002962 {
2963 emsg(_("E454: function list was modified"));
2964 return;
2965 }
2966 }
2967 }
2968 }
2969}
2970
2971/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002972 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2973 * return TRUE.
2974 * Otherwise return FALSE;
2975 * Do not consider "function(" to be a command.
2976 */
2977 static int
2978is_function_cmd(char_u **cmd)
2979{
2980 char_u *p = *cmd;
2981
2982 if (checkforcmd(&p, "function", 2))
2983 {
2984 if (*p == '(')
2985 return FALSE;
2986 *cmd = p;
2987 return TRUE;
2988 }
2989 return FALSE;
2990}
2991
2992/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002993 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002994 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2995 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002996 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002997 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002998 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002999define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000{
3001 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003002 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 int j;
3004 int c;
3005 int saved_did_emsg;
3006 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003007 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003008 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009 char_u *p;
3010 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003011 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 char_u *line_arg = NULL;
3013 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003014 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003015 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 garray_T newlines;
3017 int varargs = FALSE;
3018 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003019 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003020 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003021 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 int indent;
3023 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003024#define MAX_FUNC_NESTING 50
3025 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 dictitem_T *v;
3027 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003028 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003031 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003032 linenr_T sourcing_lnum_off;
3033 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003034 int is_heredoc = FALSE;
3035 char_u *skip_until = NULL;
3036 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003037 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003038 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039
3040 /*
3041 * ":function" without argument: list functions.
3042 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003043 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044 {
3045 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003046 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003048 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 }
3050
3051 /*
3052 * ":function /pat": list functions matching pattern.
3053 */
3054 if (*eap->arg == '/')
3055 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003056 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057 if (!eap->skip)
3058 {
3059 regmatch_T regmatch;
3060
3061 c = *p;
3062 *p = NUL;
3063 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3064 *p = c;
3065 if (regmatch.regprog != NULL)
3066 {
3067 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003068 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003069 vim_regfree(regmatch.regprog);
3070 }
3071 }
3072 if (*p == '/')
3073 ++p;
3074 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003075 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003076 }
3077
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003078 ga_init(&newargs);
3079 ga_init(&argtypes);
3080 ga_init(&default_args);
3081
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082 /*
3083 * Get the function name. There are these situations:
3084 * func normal function name
3085 * "name" == func, "fudi.fd_dict" == NULL
3086 * dict.func new dictionary entry
3087 * "name" == NULL, "fudi.fd_dict" set,
3088 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3089 * dict.func existing dict entry with a Funcref
3090 * "name" == func, "fudi.fd_dict" set,
3091 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3092 * dict.func existing dict entry that's not a Funcref
3093 * "name" == NULL, "fudi.fd_dict" set,
3094 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3095 * s:func script-local function name
3096 * g:func global function name, same as "func"
3097 */
3098 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003099 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003100 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003101 // nested function, argument is (args).
3102 paren = TRUE;
3103 CLEAR_FIELD(fudi);
3104 }
3105 else
3106 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003107 if (STRNCMP(p, "<lambda>", 8) == 0)
3108 {
3109 p += 8;
3110 (void)getdigits(&p);
3111 name = vim_strnsave(eap->arg, p - eap->arg);
3112 CLEAR_FIELD(fudi);
3113 }
3114 else
3115 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003116 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003117 paren = (vim_strchr(p, '(') != NULL);
3118 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003120 /*
3121 * Return on an invalid expression in braces, unless the expression
3122 * evaluation has been cancelled due to an aborting error, an
3123 * interrupt, or an exception.
3124 */
3125 if (!aborting())
3126 {
3127 if (!eap->skip && fudi.fd_newkey != NULL)
3128 semsg(_(e_dictkey), fudi.fd_newkey);
3129 vim_free(fudi.fd_newkey);
3130 return NULL;
3131 }
3132 else
3133 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135 }
3136
Bram Moolenaare38eab22019-12-05 21:50:01 +01003137 // An error in a function call during evaluation of an expression in magic
3138 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 saved_did_emsg = did_emsg;
3140 did_emsg = FALSE;
3141
3142 /*
3143 * ":function func" with only function name: list function.
3144 */
3145 if (!paren)
3146 {
3147 if (!ends_excmd(*skipwhite(p)))
3148 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003149 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003150 goto ret_free;
3151 }
3152 eap->nextcmd = check_nextcmd(p);
3153 if (eap->nextcmd != NULL)
3154 *p = NUL;
3155 if (!eap->skip && !got_int)
3156 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003157 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003158 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3159 {
3160 char_u *up = untrans_function_name(name);
3161
3162 // With Vim9 script the name was made script-local, if not
3163 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003164 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003165 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003166 }
3167
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003168 if (fp != NULL)
3169 {
3170 list_func_head(fp, TRUE);
3171 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3172 {
3173 if (FUNCLINE(fp, j) == NULL)
3174 continue;
3175 msg_putchar('\n');
3176 msg_outnum((long)(j + 1));
3177 if (j < 9)
3178 msg_putchar(' ');
3179 if (j < 99)
3180 msg_putchar(' ');
3181 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003182 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003183 ui_breakcheck();
3184 }
3185 if (!got_int)
3186 {
3187 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003188 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003189 msg_puts(" enddef");
3190 else
3191 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192 }
3193 }
3194 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003195 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003196 }
3197 goto ret_free;
3198 }
3199
3200 /*
3201 * ":function name(arg1, arg2)" Define function.
3202 */
3203 p = skipwhite(p);
3204 if (*p != '(')
3205 {
3206 if (!eap->skip)
3207 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003208 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 goto ret_free;
3210 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003211 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212 if (vim_strchr(p, '(') != NULL)
3213 p = vim_strchr(p, '(');
3214 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003216 // In Vim9 script only global functions can be redefined.
3217 if (vim9script && eap->forceit && !is_global)
3218 {
3219 emsg(_(e_nobang));
3220 goto ret_free;
3221 }
3222
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3224
Bram Moolenaar04b12692020-05-04 23:24:44 +02003225 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003227 // Check the name of the function. Unless it's a dictionary function
3228 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 if (name != NULL)
3230 arg = name;
3231 else
3232 arg = fudi.fd_newkey;
3233 if (arg != NULL && (fudi.fd_di == NULL
3234 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3235 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3236 {
3237 if (*arg == K_SPECIAL)
3238 j = 3;
3239 else
3240 j = 0;
3241 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3242 : eval_isnamec(arg[j])))
3243 ++j;
3244 if (arg[j] != NUL)
3245 emsg_funcname((char *)e_invarg2, arg);
3246 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003247 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003249 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 }
3251
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003252 // This may get more lines and make the pointers into the first line
3253 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003254 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003256 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003257 &varargs, &default_args, eap->skip,
3258 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003260 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003262 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003264 // find the return type: :def Func(): type
3265 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003266 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003268 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003269 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003270 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003271 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003272 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003274 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003275 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003276 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003277 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003278 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003279 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003281 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003283 else
3284 // find extra arguments "range", "dict", "abort" and "closure"
3285 for (;;)
3286 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003287 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 p = skipwhite(p);
3289 if (STRNCMP(p, "range", 5) == 0)
3290 {
3291 flags |= FC_RANGE;
3292 p += 5;
3293 }
3294 else if (STRNCMP(p, "dict", 4) == 0)
3295 {
3296 flags |= FC_DICT;
3297 p += 4;
3298 }
3299 else if (STRNCMP(p, "abort", 5) == 0)
3300 {
3301 flags |= FC_ABORT;
3302 p += 5;
3303 }
3304 else if (STRNCMP(p, "closure", 7) == 0)
3305 {
3306 flags |= FC_CLOSURE;
3307 p += 7;
3308 if (current_funccal == NULL)
3309 {
3310 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3311 name == NULL ? (char_u *)"" : name);
3312 goto erret;
3313 }
3314 }
3315 else
3316 break;
3317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318
Bram Moolenaare38eab22019-12-05 21:50:01 +01003319 // When there is a line break use what follows for the function body.
3320 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321 if (*p == '\n')
3322 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003323 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003324 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3325 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003326 && !(VIM_ISWHITE(*whitep) && *p == '#'
3327 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003328 && !eap->skip
3329 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003330 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331
3332 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003333 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3334 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 */
3336 if (KeyTyped)
3337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 // Check if the function already exists, don't let the user type the
3339 // whole function before telling him it doesn't work! For a script we
3340 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 if (!eap->skip && !eap->forceit)
3342 {
3343 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003344 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003345 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 emsg_funcname(e_funcexts, name);
3347 }
3348
3349 if (!eap->skip && did_emsg)
3350 goto erret;
3351
Bram Moolenaare38eab22019-12-05 21:50:01 +01003352 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 cmdline_row = msg_row;
3354 }
3355
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003356 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003357 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003358
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003359 // Detect having skipped over comment lines to find the return
3360 // type. Add NULL lines to keep the line count correct.
3361 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3362 if (SOURCING_LNUM < sourcing_lnum_off)
3363 {
3364 sourcing_lnum_off -= SOURCING_LNUM;
3365 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3366 goto erret;
3367 while (sourcing_lnum_off-- > 0)
3368 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3369 }
3370
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 indent = 2;
3372 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003373 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003374 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003375 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 for (;;)
3377 {
3378 if (KeyTyped)
3379 {
3380 msg_scroll = TRUE;
3381 saved_wait_return = FALSE;
3382 }
3383 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384
3385 if (line_arg != NULL)
3386 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003387 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 theline = line_arg;
3389 p = vim_strchr(theline, '\n');
3390 if (p == NULL)
3391 line_arg += STRLEN(line_arg);
3392 else
3393 {
3394 *p = NUL;
3395 line_arg = p + 1;
3396 }
3397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003399 {
3400 vim_free(line_to_free);
3401 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003402 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003403 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003404 theline = eap->getline(':', eap->cookie, indent,
3405 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003406 line_to_free = theline;
3407 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 if (KeyTyped)
3409 lines_left = Rows - 1;
3410 if (theline == NULL)
3411 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003412 // Use the start of the function for the line number.
3413 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003414 if (skip_until != NULL)
3415 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3416 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003417 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418 else
3419 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 goto erret;
3421 }
3422
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003423 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003424 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003425 if (SOURCING_LNUM < sourcing_lnum_off)
3426 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 else
3428 sourcing_lnum_off = 0;
3429
3430 if (skip_until != NULL)
3431 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003432 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003433 // * ":append" and "."
3434 // * ":python <<EOF" and "EOF"
3435 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3436 if (heredoc_trimmed == NULL
3437 || (is_heredoc && skipwhite(theline) == theline)
3438 || STRNCMP(theline, heredoc_trimmed,
3439 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003440 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003441 if (heredoc_trimmed == NULL)
3442 p = theline;
3443 else if (is_heredoc)
3444 p = skipwhite(theline) == theline
3445 ? theline : theline + STRLEN(heredoc_trimmed);
3446 else
3447 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003448 if (STRCMP(p, skip_until) == 0)
3449 {
3450 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003451 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003452 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003453 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003454 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003455 }
3456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 }
3458 else
3459 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003460 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003461 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 ;
3463
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003465 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003467 ? "enddef" : "endfunction", 4)
3468 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003469 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003470 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003471 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003472 char_u *nextcmd = NULL;
3473
3474 if (*p == '|')
3475 nextcmd = p + 1;
3476 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3477 nextcmd = line_arg;
3478 else if (*p != NUL && *p != '"' && p_verbose > 0)
3479 give_warning2(eap->cmdidx == CMD_def
3480 ? (char_u *)_("W1001: Text found after :enddef: %s")
3481 : (char_u *)_("W22: Text found after :endfunction: %s"),
3482 p, TRUE);
3483 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003484 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003485 // Another command follows. If the line came from "eap"
3486 // we can simply point into it, otherwise we need to
3487 // change "eap->cmdlinep".
3488 eap->nextcmd = nextcmd;
3489 if (line_to_free != NULL)
3490 {
3491 vim_free(*eap->cmdlinep);
3492 *eap->cmdlinep = line_to_free;
3493 line_to_free = NULL;
3494 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003495 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003496 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003497 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 }
3499
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003500 // Check for mismatched "endfunc" or "enddef".
3501 // We don't check for "def" inside "func" thus we also can't check
3502 // for "enddef".
3503 // We continue to find the end of the function, although we might
3504 // not find it.
3505 else if (nesting_def[nesting])
3506 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003507 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003508 emsg(_(e_mismatched_endfunction));
3509 }
3510 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3511 emsg(_(e_mismatched_enddef));
3512
Bram Moolenaare38eab22019-12-05 21:50:01 +01003513 // Increase indent inside "if", "while", "for" and "try", decrease
3514 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003515 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 indent -= 2;
3517 else if (STRNCMP(p, "if", 2) == 0
3518 || STRNCMP(p, "wh", 2) == 0
3519 || STRNCMP(p, "for", 3) == 0
3520 || STRNCMP(p, "try", 3) == 0)
3521 indent += 2;
3522
Bram Moolenaare38eab22019-12-05 21:50:01 +01003523 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003524 // Only recognize "def" inside "def", not inside "function",
3525 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003526 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003527 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003528 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003529 {
3530 if (*p == '!')
3531 p = skipwhite(p + 1);
3532 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003533 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3534 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 if (*skipwhite(p) == '(')
3536 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003537 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003538 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003539 else
3540 {
3541 ++nesting;
3542 nesting_def[nesting] = (c == 'd');
3543 indent += 2;
3544 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 }
3546 }
3547
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003548 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003549 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003550 if (eap->cmdidx != CMD_def
3551 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003552 || (p[0] == 'c'
3553 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3554 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3555 && (STRNCMP(&p[3], "nge", 3) != 0
3556 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 || (p[0] == 'i'
3558 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003559 && (!ASCII_ISALPHA(p[2])
3560 || (p[2] == 's'
3561 && (!ASCII_ISALPHA(p[3])
3562 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 skip_until = vim_strsave((char_u *)".");
3564
Bram Moolenaare38eab22019-12-05 21:50:01 +01003565 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 arg = skipwhite(skiptowhite(p));
3567 if (arg[0] == '<' && arg[1] =='<'
3568 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003569 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3570 || ((p[2] == '3' || p[2] == 'x')
3571 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 || (p[0] == 'p' && p[1] == 'e'
3573 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3574 || (p[0] == 't' && p[1] == 'c'
3575 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3576 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3577 && !ASCII_ISALPHA(p[3]))
3578 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3579 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3580 || (p[0] == 'm' && p[1] == 'z'
3581 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3582 ))
3583 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003584 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003586 if (STRNCMP(p, "trim", 4) == 0)
3587 {
3588 // Ignore leading white space.
3589 p = skipwhite(p + 4);
3590 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003591 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003592 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593 if (*p == NUL)
3594 skip_until = vim_strsave((char_u *)".");
3595 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003596 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003597 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003598 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003600
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003601 // Check for ":cmd v =<< [trim] EOF"
3602 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003603 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003604 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003605 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003606 if (*arg == '[')
3607 arg = vim_strchr(arg, ']');
3608 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003609 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003610 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3611 && arg[1] == '<' && arg[2] =='<');
3612
3613 if (!found)
3614 // skip over the argument after "cmd"
3615 arg = skipwhite(skiptowhite(arg));
3616 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003617 && (checkforcmd(&p, "let", 2)
3618 || checkforcmd(&p, "var", 3)
3619 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003620 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003621 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003622 p = skipwhite(arg + 3);
3623 if (STRNCMP(p, "trim", 4) == 0)
3624 {
3625 // Ignore leading white space.
3626 p = skipwhite(p + 4);
3627 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003628 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003629 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003630 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003631 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003632 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003633 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003634 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 }
3636
Bram Moolenaare38eab22019-12-05 21:50:01 +01003637 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640
Bram Moolenaare38eab22019-12-05 21:50:01 +01003641 // Copy the line to newly allocated memory. get_one_sourceline()
3642 // allocates 250 bytes per line, this saves 80% on average. The cost
3643 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003645 if (p == NULL)
3646 goto erret;
3647 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648
Bram Moolenaare38eab22019-12-05 21:50:01 +01003649 // Add NULL lines for continuation lines, so that the line count is
3650 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 while (sourcing_lnum_off-- > 0)
3652 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3653
Bram Moolenaare38eab22019-12-05 21:50:01 +01003654 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 if (line_arg != NULL && *line_arg == NUL)
3656 line_arg = NULL;
3657 }
3658
Bram Moolenaare38eab22019-12-05 21:50:01 +01003659 // Don't define the function when skipping commands or when an error was
3660 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 if (eap->skip || did_emsg)
3662 goto erret;
3663
3664 /*
3665 * If there are no errors, add the function
3666 */
3667 if (fudi.fd_dict == NULL)
3668 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003669 hashtab_T *ht;
3670
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003671 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3673 {
3674 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3675 name);
3676 goto erret;
3677 }
3678
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003679 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003680 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003682 char_u *uname = untrans_function_name(name);
3683
3684 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3685 }
3686
3687 if (fp != NULL || import != NULL)
3688 {
3689 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003690
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003691 // Function can be replaced with "function!" and when sourcing the
3692 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003693 // A name that is used by an import can not be overruled.
3694 if (import != NULL
3695 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003696 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003697 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003699 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003700 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003701 else
3702 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 goto erret;
3704 }
3705 if (fp->uf_calls > 0)
3706 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003707 emsg_funcname(
3708 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 name);
3710 goto erret;
3711 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003712 if (fp->uf_refcount > 1)
3713 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003714 // This function is referenced somewhere, don't redefine it but
3715 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003716 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003717 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003718 fp = NULL;
3719 overwrite = TRUE;
3720 }
3721 else
3722 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003723 char_u *exp_name = fp->uf_name_exp;
3724
3725 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003726 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003727 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003728 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003729 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003730 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003731#ifdef FEAT_PROFILE
3732 fp->uf_profiling = FALSE;
3733 fp->uf_prof_initialized = FALSE;
3734#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003735 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003736 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 }
3738 }
3739 else
3740 {
3741 char numbuf[20];
3742
3743 fp = NULL;
3744 if (fudi.fd_newkey == NULL && !eap->forceit)
3745 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003746 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 goto erret;
3748 }
3749 if (fudi.fd_di == NULL)
3750 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003751 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003752 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 goto erret;
3754 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003756 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 goto erret;
3758
Bram Moolenaare38eab22019-12-05 21:50:01 +01003759 // Give the function a sequential number. Can only be used with a
3760 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 vim_free(name);
3762 sprintf(numbuf, "%d", ++func_nr);
3763 name = vim_strsave((char_u *)numbuf);
3764 if (name == NULL)
3765 goto erret;
3766 }
3767
3768 if (fp == NULL)
3769 {
3770 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3771 {
3772 int slen, plen;
3773 char_u *scriptname;
3774
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003777 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 {
3779 scriptname = autoload_name(name);
3780 if (scriptname != NULL)
3781 {
3782 p = vim_strchr(scriptname, '/');
3783 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003784 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003786 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 j = OK;
3788 vim_free(scriptname);
3789 }
3790 }
3791 if (j == FAIL)
3792 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003793 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 goto erret;
3795 }
3796 }
3797
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003798 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 if (fp == NULL)
3800 goto erret;
3801
3802 if (fudi.fd_dict != NULL)
3803 {
3804 if (fudi.fd_di == NULL)
3805 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003806 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3808 if (fudi.fd_di == NULL)
3809 {
3810 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003811 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 goto erret;
3813 }
3814 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3815 {
3816 vim_free(fudi.fd_di);
3817 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003818 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 goto erret;
3820 }
3821 }
3822 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003823 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 clear_tv(&fudi.fd_di->di_tv);
3825 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827
Bram Moolenaare38eab22019-12-05 21:50:01 +01003828 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 flags |= FC_DICT;
3830 }
3831
Bram Moolenaare38eab22019-12-05 21:50:01 +01003832 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003833 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003834 if (overwrite)
3835 {
3836 hi = hash_find(&func_hashtab, name);
3837 hi->hi_key = UF2HIKEY(fp);
3838 }
3839 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 {
3841 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003842 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 goto erret;
3844 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003845 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 }
3847 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003848 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003849 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003850 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003851
3852 if (eap->cmdidx == CMD_def)
3853 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003854 int lnum_save = SOURCING_LNUM;
3855 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003856
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003857 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003858
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003859 // error messages are for the first function line
3860 SOURCING_LNUM = sourcing_lnum_top;
3861
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003862 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003863 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003864 int count = cstack->cs_idx + 1;
3865 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003866
3867 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003868 // a block that is visible now but not when the function is called
3869 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003870 fp->uf_block_ids = ALLOC_MULT(int, count);
3871 if (fp->uf_block_ids != NULL)
3872 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003873 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003874 sizeof(int) * count);
3875 fp->uf_block_depth = count;
3876 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003877
3878 // Set flag in each block to indicate a function was defined. This
3879 // is used to keep the variable when leaving the block, see
3880 // hide_script_var().
3881 for (i = 0; i <= cstack->cs_idx; ++i)
3882 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003883 }
3884
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003885 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003886 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003887 SOURCING_LNUM = lnum_save;
3888 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003890 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003891
3892 // parse the return type, if any
3893 if (ret_type == NULL)
3894 fp->uf_ret_type = &t_void;
3895 else
3896 {
3897 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003898 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003899 if (fp->uf_ret_type == NULL)
3900 {
3901 fp->uf_ret_type = &t_void;
3902 SOURCING_LNUM = lnum_save;
3903 goto erret;
3904 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003905 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003906 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003907 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003908 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003909 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003910
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003912 if ((flags & FC_CLOSURE) != 0)
3913 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003914 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003915 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003916 }
3917 else
3918 fp->uf_scoped = NULL;
3919
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921 if (prof_def_func())
3922 func_do_profile(fp);
3923#endif
3924 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003925 if (sandbox)
3926 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003927 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003928 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929 fp->uf_flags = flags;
3930 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003931 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003932 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003933 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003934 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003935 if (is_export)
3936 {
3937 fp->uf_flags |= FC_EXPORT;
3938 // let ex_export() know the export worked.
3939 is_export = FALSE;
3940 }
3941
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003942 if (eap->cmdidx == CMD_def)
3943 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003944 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3945 // :func does not use Vim9 script syntax, even in a Vim9 script file
3946 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003947
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 goto ret_free;
3949
3950erret:
3951 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003952 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953errret_2:
3954 ga_clear_strings(&newlines);
3955ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003956 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003958 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003959 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003961 if (name != name_arg)
3962 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003963 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 did_emsg |= saved_did_emsg;
3965 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003966
3967 return fp;
3968}
3969
3970/*
3971 * ":function"
3972 */
3973 void
3974ex_function(exarg_T *eap)
3975{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003976 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003977}
3978
3979/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003980 * :defcompile - compile all :def functions in the current script that need to
3981 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003982 */
3983 void
3984ex_defcompile(exarg_T *eap UNUSED)
3985{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003986 long todo = (long)func_hashtab.ht_used;
3987 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003988 hashitem_T *hi;
3989 ufunc_T *ufunc;
3990
3991 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3992 {
3993 if (!HASHITEM_EMPTY(hi))
3994 {
3995 --todo;
3996 ufunc = HI2UF(hi);
3997 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003998 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3999 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004000 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02004001 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004002
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004003 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004004 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004005 // a function has been added or removed, need to start over
4006 todo = (long)func_hashtab.ht_used;
4007 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004008 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004009 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004010 }
4011 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004012 }
4013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014}
4015
4016/*
4017 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4018 * Return 2 if "p" starts with "s:".
4019 * Return 0 otherwise.
4020 */
4021 int
4022eval_fname_script(char_u *p)
4023{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004024 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4025 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4027 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4028 return 5;
4029 if (p[0] == 's' && p[1] == ':')
4030 return 2;
4031 return 0;
4032}
4033
4034 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004035translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036{
4037 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004038 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004039 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004040}
4041
4042/*
4043 * Return TRUE when "ufunc" has old-style "..." varargs
4044 * or named varargs "...name: type".
4045 */
4046 int
4047has_varargs(ufunc_T *ufunc)
4048{
4049 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050}
4051
4052/*
4053 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004054 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 */
4056 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004057function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058{
4059 char_u *nm = name;
4060 char_u *p;
4061 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004062 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004063 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004064
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004065 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4066 if (no_deref)
4067 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004068 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 nm = skipwhite(nm);
4070
Bram Moolenaare38eab22019-12-05 21:50:01 +01004071 // Only accept "funcname", "funcname ", "funcname (..." and
4072 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004074 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 vim_free(p);
4076 return n;
4077}
4078
Bram Moolenaar113e1072019-01-20 15:30:40 +01004079#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 char_u *
4081get_expanded_name(char_u *name, int check)
4082{
4083 char_u *nm = name;
4084 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004085 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004087 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004088 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004090 if (p != NULL && *nm == NUL
4091 && (!check || translated_function_exists(p, is_global)))
4092 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093
4094 vim_free(p);
4095 return NULL;
4096}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004097#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099/*
4100 * Function given to ExpandGeneric() to obtain the list of user defined
4101 * function names.
4102 */
4103 char_u *
4104get_user_func_name(expand_T *xp, int idx)
4105{
4106 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004107 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 static hashitem_T *hi;
4109 ufunc_T *fp;
4110
4111 if (idx == 0)
4112 {
4113 done = 0;
4114 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004115 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004117 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 {
4119 if (done++ > 0)
4120 ++hi;
4121 while (HASHITEM_EMPTY(hi))
4122 ++hi;
4123 fp = HI2UF(hi);
4124
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004125 // don't show dead, dict and lambda functions
4126 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004127 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004128 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129
4130 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004131 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132
4133 cat_func_name(IObuff, fp);
4134 if (xp->xp_context != EXPAND_USER_FUNC)
4135 {
4136 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004137 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138 STRCAT(IObuff, ")");
4139 }
4140 return IObuff;
4141 }
4142 return NULL;
4143}
4144
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145/*
4146 * ":delfunction {name}"
4147 */
4148 void
4149ex_delfunction(exarg_T *eap)
4150{
4151 ufunc_T *fp = NULL;
4152 char_u *p;
4153 char_u *name;
4154 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004155 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156
4157 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004158 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4159 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160 vim_free(fudi.fd_newkey);
4161 if (name == NULL)
4162 {
4163 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004164 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 return;
4166 }
4167 if (!ends_excmd(*skipwhite(p)))
4168 {
4169 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004170 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 return;
4172 }
4173 eap->nextcmd = check_nextcmd(p);
4174 if (eap->nextcmd != NULL)
4175 *p = NUL;
4176
4177 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004178 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 vim_free(name);
4180
4181 if (!eap->skip)
4182 {
4183 if (fp == NULL)
4184 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004185 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004186 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 return;
4188 }
4189 if (fp->uf_calls > 0)
4190 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004191 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 return;
4193 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004194 if (fp->uf_flags & FC_VIM9)
4195 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004196 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004197 return;
4198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199
4200 if (fudi.fd_dict != NULL)
4201 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004202 // Delete the dict item that refers to the function, it will
4203 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4205 }
4206 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004207 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004208 // A normal function (not a numbered function or lambda) has a
4209 // refcount of 1 for the entry in the hashtable. When deleting
4210 // it and the refcount is more than one, it should be kept.
4211 // A numbered function and lambda should be kept if the refcount is
4212 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004213 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004214 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004215 // Function is still referenced somewhere. Don't free it but
4216 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004217 if (func_remove(fp))
4218 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004219 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004220 }
4221 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004222 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004224 }
4225}
4226
4227/*
4228 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004229 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230 */
4231 void
4232func_unref(char_u *name)
4233{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004234 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004236 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004238 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004239 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004242 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004244 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004246 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004248 // Only delete it when it's not being used. Otherwise it's done
4249 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004250 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004251 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004252 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004253}
4254
4255/*
4256 * Unreference a Function: decrement the reference count and free it when it
4257 * becomes zero.
4258 */
4259 void
4260func_ptr_unref(ufunc_T *fp)
4261{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004262 if (fp != NULL && --fp->uf_refcount <= 0)
4263 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004264 // Only delete it when it's not being used. Otherwise it's done
4265 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004266 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004267 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 }
4269}
4270
4271/*
4272 * Count a reference to a Function.
4273 */
4274 void
4275func_ref(char_u *name)
4276{
4277 ufunc_T *fp;
4278
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004279 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004281 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004282 if (fp != NULL)
4283 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004285 // Only give an error for a numbered function.
4286 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004287 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004288}
4289
4290/*
4291 * Count a reference to a Function.
4292 */
4293 void
4294func_ptr_ref(ufunc_T *fp)
4295{
4296 if (fp != NULL)
4297 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298}
4299
4300/*
4301 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4302 * referenced from anywhere that is in use.
4303 */
4304 static int
4305can_free_funccal(funccall_T *fc, int copyID)
4306{
4307 return (fc->l_varlist.lv_copyID != copyID
4308 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004309 && fc->l_avars.dv_copyID != copyID
4310 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311}
4312
4313/*
4314 * ":return [expr]"
4315 */
4316 void
4317ex_return(exarg_T *eap)
4318{
4319 char_u *arg = eap->arg;
4320 typval_T rettv;
4321 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004322 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323
4324 if (current_funccal == NULL)
4325 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004326 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327 return;
4328 }
4329
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004330 CLEAR_FIELD(evalarg);
4331 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4332
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333 if (eap->skip)
4334 ++emsg_skip;
4335
4336 eap->nextcmd = NULL;
4337 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004338 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004339 {
4340 if (!eap->skip)
4341 returning = do_return(eap, FALSE, TRUE, &rettv);
4342 else
4343 clear_tv(&rettv);
4344 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004345 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 else if (!eap->skip)
4347 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004348 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004349 update_force_abort();
4350
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 /*
4352 * Return unless the expression evaluation has been cancelled due to an
4353 * aborting error, an interrupt, or an exception.
4354 */
4355 if (!aborting())
4356 returning = do_return(eap, FALSE, TRUE, NULL);
4357 }
4358
Bram Moolenaare38eab22019-12-05 21:50:01 +01004359 // When skipping or the return gets pending, advance to the next command
4360 // in this line (!returning). Otherwise, ignore the rest of the line.
4361 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004362 if (returning)
4363 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004364 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004365 eap->nextcmd = check_nextcmd(arg);
4366
4367 if (eap->skip)
4368 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004369 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370}
4371
4372/*
4373 * ":1,25call func(arg1, arg2)" function call.
4374 */
4375 void
4376ex_call(exarg_T *eap)
4377{
4378 char_u *arg = eap->arg;
4379 char_u *startarg;
4380 char_u *name;
4381 char_u *tofree;
4382 int len;
4383 typval_T rettv;
4384 linenr_T lnum;
4385 int doesrange;
4386 int failed = FALSE;
4387 funcdict_T fudi;
4388 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004389 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004390 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391
Bram Moolenaare6b53242020-07-01 17:28:33 +02004392 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 if (eap->skip)
4394 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004395 // trans_function_name() doesn't work well when skipping, use eval0()
4396 // instead to skip to any following command, e.g. for:
4397 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004399 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 clear_tv(&rettv);
4401 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004402 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004403 return;
4404 }
4405
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004406 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4407 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 if (fudi.fd_newkey != NULL)
4409 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004410 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004411 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004412 vim_free(fudi.fd_newkey);
4413 }
4414 if (tofree == NULL)
4415 return;
4416
Bram Moolenaare38eab22019-12-05 21:50:01 +01004417 // Increase refcount on dictionary, it could get deleted when evaluating
4418 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 if (fudi.fd_dict != NULL)
4420 ++fudi.fd_dict->dv_refcount;
4421
Bram Moolenaare38eab22019-12-05 21:50:01 +01004422 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4423 // contents. For VAR_PARTIAL get its partial, unless we already have one
4424 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004426 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4427 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428
Bram Moolenaare38eab22019-12-05 21:50:01 +01004429 // Skip white space to allow ":call func ()". Not good, but required for
4430 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004432 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433
4434 if (*startarg != '(')
4435 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004436 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 goto end;
4438 }
4439
4440 /*
4441 * When skipping, evaluate the function once, to find the end of the
4442 * arguments.
4443 * When the function takes a range, this is discovered after the first
4444 * call, and the loop is broken.
4445 */
4446 if (eap->skip)
4447 {
4448 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004449 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 }
4451 else
4452 lnum = eap->line1;
4453 for ( ; lnum <= eap->line2; ++lnum)
4454 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004455 funcexe_T funcexe;
4456
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 if (!eap->skip && eap->addr_count > 0)
4458 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004459 if (lnum > curbuf->b_ml.ml_line_count)
4460 {
4461 // If the function deleted lines or switched to another buffer
4462 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004463 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004464 break;
4465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 curwin->w_cursor.lnum = lnum;
4467 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 }
4470 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004471
Bram Moolenaara80faa82020-04-12 19:37:17 +02004472 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004473 funcexe.firstline = eap->line1;
4474 funcexe.lastline = eap->line2;
4475 funcexe.doesrange = &doesrange;
4476 funcexe.evaluate = !eap->skip;
4477 funcexe.partial = partial;
4478 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004479 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004480 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 {
4482 failed = TRUE;
4483 break;
4484 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004485 if (has_watchexpr())
4486 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004488 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004489 if (handle_subscript(&arg, &rettv,
4490 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 {
4492 failed = TRUE;
4493 break;
4494 }
4495
4496 clear_tv(&rettv);
4497 if (doesrange || eap->skip)
4498 break;
4499
Bram Moolenaare38eab22019-12-05 21:50:01 +01004500 // Stop when immediately aborting on error, or when an interrupt
4501 // occurred or an exception was thrown but not caught.
4502 // get_func_tv() returned OK, so that the check for trailing
4503 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 if (aborting())
4505 break;
4506 }
4507 if (eap->skip)
4508 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004509 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510
Bram Moolenaare51bb172020-02-16 19:42:23 +01004511 // When inside :try we need to check for following "| catch".
4512 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004513 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004514 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004515 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004516 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004518 if (!failed)
4519 {
4520 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004521 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004522 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 }
4524 else
4525 eap->nextcmd = check_nextcmd(arg);
4526 }
4527
4528end:
4529 dict_unref(fudi.fd_dict);
4530 vim_free(tofree);
4531}
4532
4533/*
4534 * Return from a function. Possibly makes the return pending. Also called
4535 * for a pending return at the ":endtry" or after returning from an extra
4536 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4537 * when called due to a ":return" command. "rettv" may point to a typval_T
4538 * with the return rettv. Returns TRUE when the return can be carried out,
4539 * FALSE when the return gets pending.
4540 */
4541 int
4542do_return(
4543 exarg_T *eap,
4544 int reanimate,
4545 int is_cmd,
4546 void *rettv)
4547{
4548 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004549 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550
4551 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004552 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004553 current_funccal->returned = FALSE;
4554
4555 /*
4556 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4557 * not in its finally clause (which then is to be executed next) is found.
4558 * In this case, make the ":return" pending for execution at the ":endtry".
4559 * Otherwise, return normally.
4560 */
4561 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4562 if (idx >= 0)
4563 {
4564 cstack->cs_pending[idx] = CSTP_RETURN;
4565
4566 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004567 // A pending return again gets pending. "rettv" points to an
4568 // allocated variable with the rettv of the original ":return"'s
4569 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570 cstack->cs_rettv[idx] = rettv;
4571 else
4572 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004573 // When undoing a return in order to make it pending, get the stored
4574 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 if (reanimate)
4576 rettv = current_funccal->rettv;
4577
4578 if (rettv != NULL)
4579 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004580 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4582 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4583 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004584 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 }
4586 else
4587 cstack->cs_rettv[idx] = NULL;
4588
4589 if (reanimate)
4590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004591 // The pending return value could be overwritten by a ":return"
4592 // without argument in a finally clause; reset the default
4593 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594 current_funccal->rettv->v_type = VAR_NUMBER;
4595 current_funccal->rettv->vval.v_number = 0;
4596 }
4597 }
4598 report_make_pending(CSTP_RETURN, rettv);
4599 }
4600 else
4601 {
4602 current_funccal->returned = TRUE;
4603
Bram Moolenaare38eab22019-12-05 21:50:01 +01004604 // If the return is carried out now, store the return value. For
4605 // a return immediately after reanimation, the value is already
4606 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607 if (!reanimate && rettv != NULL)
4608 {
4609 clear_tv(current_funccal->rettv);
4610 *current_funccal->rettv = *(typval_T *)rettv;
4611 if (!is_cmd)
4612 vim_free(rettv);
4613 }
4614 }
4615
4616 return idx < 0;
4617}
4618
4619/*
4620 * Free the variable with a pending return value.
4621 */
4622 void
4623discard_pending_return(void *rettv)
4624{
4625 free_tv((typval_T *)rettv);
4626}
4627
4628/*
4629 * Generate a return command for producing the value of "rettv". The result
4630 * is an allocated string. Used by report_pending() for verbose messages.
4631 */
4632 char_u *
4633get_return_cmd(void *rettv)
4634{
4635 char_u *s = NULL;
4636 char_u *tofree = NULL;
4637 char_u numbuf[NUMBUFLEN];
4638
4639 if (rettv != NULL)
4640 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4641 if (s == NULL)
4642 s = (char_u *)"";
4643
4644 STRCPY(IObuff, ":return ");
4645 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4646 if (STRLEN(s) + 8 >= IOSIZE)
4647 STRCPY(IObuff + IOSIZE - 4, "...");
4648 vim_free(tofree);
4649 return vim_strsave(IObuff);
4650}
4651
4652/*
4653 * Get next function line.
4654 * Called by do_cmdline() to get the next line.
4655 * Returns allocated string, or NULL for end of function.
4656 */
4657 char_u *
4658get_func_line(
4659 int c UNUSED,
4660 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004661 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004662 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663{
4664 funccall_T *fcp = (funccall_T *)cookie;
4665 ufunc_T *fp = fcp->func;
4666 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004667 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668
Bram Moolenaare38eab22019-12-05 21:50:01 +01004669 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670 if (fcp->dbg_tick != debug_tick)
4671 {
4672 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004673 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 fcp->dbg_tick = debug_tick;
4675 }
4676#ifdef FEAT_PROFILE
4677 if (do_profiling == PROF_YES)
4678 func_line_end(cookie);
4679#endif
4680
4681 gap = &fp->uf_lines;
4682 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4683 || fcp->returned)
4684 retval = NULL;
4685 else
4686 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004687 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 while (fcp->linenr < gap->ga_len
4689 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4690 ++fcp->linenr;
4691 if (fcp->linenr >= gap->ga_len)
4692 retval = NULL;
4693 else
4694 {
4695 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004696 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697#ifdef FEAT_PROFILE
4698 if (do_profiling == PROF_YES)
4699 func_line_start(cookie);
4700#endif
4701 }
4702 }
4703
Bram Moolenaare38eab22019-12-05 21:50:01 +01004704 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004705 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004706 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004707 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004708 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004710 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 fcp->dbg_tick = debug_tick;
4712 }
4713
4714 return retval;
4715}
4716
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717/*
4718 * Return TRUE if the currently active function should be ended, because a
4719 * return was encountered or an error occurred. Used inside a ":while".
4720 */
4721 int
4722func_has_ended(void *cookie)
4723{
4724 funccall_T *fcp = (funccall_T *)cookie;
4725
Bram Moolenaare38eab22019-12-05 21:50:01 +01004726 // Ignore the "abort" flag if the abortion behavior has been changed due to
4727 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4729 || fcp->returned);
4730}
4731
4732/*
4733 * return TRUE if cookie indicates a function which "abort"s on errors.
4734 */
4735 int
4736func_has_abort(
4737 void *cookie)
4738{
4739 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4740}
4741
4742
4743/*
4744 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4745 * Don't do this when "Func" is already a partial that was bound
4746 * explicitly (pt_auto is FALSE).
4747 * Changes "rettv" in-place.
4748 * Returns the updated "selfdict_in".
4749 */
4750 dict_T *
4751make_partial(dict_T *selfdict_in, typval_T *rettv)
4752{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004753 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 char_u *tofree = NULL;
4755 ufunc_T *fp;
4756 char_u fname_buf[FLEN_FIXED + 1];
4757 int error;
4758 dict_T *selfdict = selfdict_in;
4759
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004760 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4761 fp = rettv->vval.v_partial->pt_func;
4762 else
4763 {
4764 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4765 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004766 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004767 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004768 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004769 vim_free(tofree);
4770 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771
4772 if (fp != NULL && (fp->uf_flags & FC_DICT))
4773 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004774 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775
4776 if (pt != NULL)
4777 {
4778 pt->pt_refcount = 1;
4779 pt->pt_dict = selfdict;
4780 pt->pt_auto = TRUE;
4781 selfdict = NULL;
4782 if (rettv->v_type == VAR_FUNC)
4783 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004784 // Just a function: Take over the function name and use
4785 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 pt->pt_name = rettv->vval.v_string;
4787 }
4788 else
4789 {
4790 partial_T *ret_pt = rettv->vval.v_partial;
4791 int i;
4792
Bram Moolenaare38eab22019-12-05 21:50:01 +01004793 // Partial: copy the function name, use selfdict and copy
4794 // args. Can't take over name or args, the partial might
4795 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004796 if (ret_pt->pt_name != NULL)
4797 {
4798 pt->pt_name = vim_strsave(ret_pt->pt_name);
4799 func_ref(pt->pt_name);
4800 }
4801 else
4802 {
4803 pt->pt_func = ret_pt->pt_func;
4804 func_ptr_ref(pt->pt_func);
4805 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 if (ret_pt->pt_argc > 0)
4807 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004808 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004810 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 pt->pt_argc = 0;
4812 else
4813 {
4814 pt->pt_argc = ret_pt->pt_argc;
4815 for (i = 0; i < pt->pt_argc; i++)
4816 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4817 }
4818 }
4819 partial_unref(ret_pt);
4820 }
4821 rettv->v_type = VAR_PARTIAL;
4822 rettv->vval.v_partial = pt;
4823 }
4824 }
4825 return selfdict;
4826}
4827
4828/*
4829 * Return the name of the executed function.
4830 */
4831 char_u *
4832func_name(void *cookie)
4833{
4834 return ((funccall_T *)cookie)->func->uf_name;
4835}
4836
4837/*
4838 * Return the address holding the next breakpoint line for a funccall cookie.
4839 */
4840 linenr_T *
4841func_breakpoint(void *cookie)
4842{
4843 return &((funccall_T *)cookie)->breakpoint;
4844}
4845
4846/*
4847 * Return the address holding the debug tick for a funccall cookie.
4848 */
4849 int *
4850func_dbg_tick(void *cookie)
4851{
4852 return &((funccall_T *)cookie)->dbg_tick;
4853}
4854
4855/*
4856 * Return the nesting level for a funccall cookie.
4857 */
4858 int
4859func_level(void *cookie)
4860{
4861 return ((funccall_T *)cookie)->level;
4862}
4863
4864/*
4865 * Return TRUE when a function was ended by a ":return" command.
4866 */
4867 int
4868current_func_returned(void)
4869{
4870 return current_funccal->returned;
4871}
4872
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873 int
4874free_unref_funccal(int copyID, int testing)
4875{
4876 int did_free = FALSE;
4877 int did_free_funccal = FALSE;
4878 funccall_T *fc, **pfc;
4879
4880 for (pfc = &previous_funccal; *pfc != NULL; )
4881 {
4882 if (can_free_funccal(*pfc, copyID))
4883 {
4884 fc = *pfc;
4885 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004886 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004887 did_free = TRUE;
4888 did_free_funccal = TRUE;
4889 }
4890 else
4891 pfc = &(*pfc)->caller;
4892 }
4893 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004894 // When a funccal was freed some more items might be garbage
4895 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004896 (void)garbage_collect(testing);
4897
4898 return did_free;
4899}
4900
4901/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004902 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903 */
4904 static funccall_T *
4905get_funccal(void)
4906{
4907 int i;
4908 funccall_T *funccal;
4909 funccall_T *temp_funccal;
4910
4911 funccal = current_funccal;
4912 if (debug_backtrace_level > 0)
4913 {
4914 for (i = 0; i < debug_backtrace_level; i++)
4915 {
4916 temp_funccal = funccal->caller;
4917 if (temp_funccal)
4918 funccal = temp_funccal;
4919 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004920 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004921 debug_backtrace_level = i;
4922 }
4923 }
4924 return funccal;
4925}
4926
4927/*
4928 * Return the hashtable used for local variables in the current funccal.
4929 * Return NULL if there is no current funccal.
4930 */
4931 hashtab_T *
4932get_funccal_local_ht()
4933{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004934 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 return NULL;
4936 return &get_funccal()->l_vars.dv_hashtab;
4937}
4938
4939/*
4940 * Return the l: scope variable.
4941 * Return NULL if there is no current funccal.
4942 */
4943 dictitem_T *
4944get_funccal_local_var()
4945{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004946 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004947 return NULL;
4948 return &get_funccal()->l_vars_var;
4949}
4950
4951/*
4952 * Return the hashtable used for argument in the current funccal.
4953 * Return NULL if there is no current funccal.
4954 */
4955 hashtab_T *
4956get_funccal_args_ht()
4957{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004958 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004959 return NULL;
4960 return &get_funccal()->l_avars.dv_hashtab;
4961}
4962
4963/*
4964 * Return the a: scope variable.
4965 * Return NULL if there is no current funccal.
4966 */
4967 dictitem_T *
4968get_funccal_args_var()
4969{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004970 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004972 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973}
4974
4975/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976 * List function variables, if there is a function.
4977 */
4978 void
4979list_func_vars(int *first)
4980{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004981 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004983 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004984}
4985
4986/*
4987 * If "ht" is the hashtable for local variables in the current funccal, return
4988 * the dict that contains it.
4989 * Otherwise return NULL.
4990 */
4991 dict_T *
4992get_current_funccal_dict(hashtab_T *ht)
4993{
4994 if (current_funccal != NULL
4995 && ht == &current_funccal->l_vars.dv_hashtab)
4996 return &current_funccal->l_vars;
4997 return NULL;
4998}
4999
5000/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005001 * Search hashitem in parent scope.
5002 */
5003 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005004find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005005{
5006 funccall_T *old_current_funccal = current_funccal;
5007 hashtab_T *ht;
5008 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005009 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005010
5011 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5012 return NULL;
5013
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005014 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005015 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005016 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005017 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005018 ht = find_var_ht(name, &varname);
5019 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005020 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005021 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005022 if (!HASHITEM_EMPTY(hi))
5023 {
5024 *pht = ht;
5025 break;
5026 }
5027 }
5028 if (current_funccal == current_funccal->func->uf_scoped)
5029 break;
5030 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005031 }
5032 current_funccal = old_current_funccal;
5033
5034 return hi;
5035}
5036
5037/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005038 * Search variable in parent scope.
5039 */
5040 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005041find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005042{
5043 dictitem_T *v = NULL;
5044 funccall_T *old_current_funccal = current_funccal;
5045 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005046 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005047
5048 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5049 return NULL;
5050
Bram Moolenaare38eab22019-12-05 21:50:01 +01005051 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005052 current_funccal = current_funccal->func->uf_scoped;
5053 while (current_funccal)
5054 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005055 ht = find_var_ht(name, &varname);
5056 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005057 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005058 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005059 if (v != NULL)
5060 break;
5061 }
5062 if (current_funccal == current_funccal->func->uf_scoped)
5063 break;
5064 current_funccal = current_funccal->func->uf_scoped;
5065 }
5066 current_funccal = old_current_funccal;
5067
5068 return v;
5069}
5070
5071/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005072 * Set "copyID + 1" in previous_funccal and callers.
5073 */
5074 int
5075set_ref_in_previous_funccal(int copyID)
5076{
5077 int abort = FALSE;
5078 funccall_T *fc;
5079
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005080 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005082 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005083 abort = abort
5084 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5085 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005086 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005087 }
5088 return abort;
5089}
5090
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005091 static int
5092set_ref_in_funccal(funccall_T *fc, int copyID)
5093{
5094 int abort = FALSE;
5095
5096 if (fc->fc_copyID != copyID)
5097 {
5098 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005099 abort = abort
5100 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5101 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005102 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005103 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005104 }
5105 return abort;
5106}
5107
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005108/*
5109 * Set "copyID" in all local vars and arguments in the call stack.
5110 */
5111 int
5112set_ref_in_call_stack(int copyID)
5113{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005114 int abort = FALSE;
5115 funccall_T *fc;
5116 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005117
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005118 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005119 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005120
5121 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005122 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5123 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005124 abort = abort || set_ref_in_funccal(fc, copyID);
5125
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005126 return abort;
5127}
5128
5129/*
5130 * Set "copyID" in all functions available by name.
5131 */
5132 int
5133set_ref_in_functions(int copyID)
5134{
5135 int todo;
5136 hashitem_T *hi = NULL;
5137 int abort = FALSE;
5138 ufunc_T *fp;
5139
5140 todo = (int)func_hashtab.ht_used;
5141 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005142 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005143 if (!HASHITEM_EMPTY(hi))
5144 {
5145 --todo;
5146 fp = HI2UF(hi);
5147 if (!func_name_refcount(fp->uf_name))
5148 abort = abort || set_ref_in_func(NULL, fp, copyID);
5149 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150 }
5151 return abort;
5152}
5153
5154/*
5155 * Set "copyID" in all function arguments.
5156 */
5157 int
5158set_ref_in_func_args(int copyID)
5159{
5160 int i;
5161 int abort = FALSE;
5162
5163 for (i = 0; i < funcargs.ga_len; ++i)
5164 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5165 copyID, NULL, NULL);
5166 return abort;
5167}
5168
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005169/*
5170 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005171 * Returns TRUE if setting references failed somehow.
5172 */
5173 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005174set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005175{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005176 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005177 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005178 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005179 char_u fname_buf[FLEN_FIXED + 1];
5180 char_u *tofree = NULL;
5181 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005182 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005183
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005184 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005185 return FALSE;
5186
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005187 if (fp_in == NULL)
5188 {
5189 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005190 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005191 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005192 if (fp != NULL)
5193 {
5194 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005195 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005196 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005197
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005198 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005199 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005200}
5201
Bram Moolenaare38eab22019-12-05 21:50:01 +01005202#endif // FEAT_EVAL