blob: 814d400fb2d437555f8ba3382f096f3c32b332be [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
67 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010068{
Bram Moolenaar6e949782020-04-13 17:21:00 +020069 char_u *p = arg;
70 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010071
72 while (ASCII_ISALNUM(*p) || *p == '_')
73 ++p;
74 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020075 || (argtypes == NULL
76 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
77 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010078 {
79 if (!skip)
80 semsg(_("E125: Illegal argument: %s"), arg);
81 return arg;
82 }
83 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
84 return arg;
85 if (newargs != NULL)
86 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010087 int c;
88 int i;
89
90 c = *p;
91 *p = NUL;
92 arg_copy = vim_strsave(arg);
93 if (arg_copy == NULL)
94 {
95 *p = c;
96 return arg;
97 }
98
99 // Check for duplicate argument name.
100 for (i = 0; i < newargs->ga_len; ++i)
101 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
102 {
103 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
104 vim_free(arg_copy);
105 return arg;
106 }
107 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
108 newargs->ga_len++;
109
110 *p = c;
111 }
112
113 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100114 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100115 {
116 char_u *type = NULL;
117
Bram Moolenaar6e949782020-04-13 17:21:00 +0200118 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
119 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200120 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200121 arg_copy == NULL ? arg : arg_copy);
122 p = skipwhite(p);
123 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 if (*p == ':')
125 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200126 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100127 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200128 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200129 semsg(_(e_white_space_required_after_str), ":");
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200130 return arg;
131 }
132 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200133 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100134 if (!skip)
135 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100136 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100137 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200138 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200139 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200140 arg_copy == NULL ? arg : arg_copy);
141 return arg;
142 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 {
145 if (type == NULL && types_optional)
146 // lambda arguments default to "any" type
147 type = vim_strsave((char_u *)"any");
148 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
149 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
151
152 return p;
153}
154
155/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200156 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100157 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100158 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200159 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100160 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200161get_function_args(
162 char_u **argp,
163 char_u endchar,
164 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100166 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200167 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200169 int skip,
170 exarg_T *eap,
171 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200172{
173 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100174 char_u *arg;
175 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200177 int any_default = FALSE;
178 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100179 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200180
181 if (newargs != NULL)
182 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183 if (argtypes != NULL)
184 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200185 if (default_args != NULL)
186 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200187
188 if (varargs != NULL)
189 *varargs = FALSE;
190
191 /*
192 * Isolate the arguments: "arg1, arg2, ...)"
193 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100194 arg = skipwhite(*argp);
195 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196 while (*p != endchar)
197 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200198 while (eap != NULL && eap->getline != NULL
199 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200200 {
201 char_u *theline;
202
203 // End of the line, get the next one.
204 theline = eap->getline(':', eap->cookie, 0, TRUE);
205 if (theline == NULL)
206 break;
207 vim_free(*line_to_free);
208 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200209 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 p = skipwhite(theline);
211 }
212
213 if (mustend && *p != endchar)
214 {
215 if (!skip)
216 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100217 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200218 }
219 if (*p == endchar)
220 break;
221
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
223 {
224 if (varargs != NULL)
225 *varargs = TRUE;
226 p += 3;
227 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228
229 if (argtypes != NULL)
230 {
231 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200232 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100233 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100234 if (!skip)
235 emsg(_(e_missing_name_after_dots));
236 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100237 }
238
239 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100240 p = one_function_arg(p, newargs, argtypes, types_optional,
241 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242 if (p == arg)
243 break;
244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200245 }
246 else
247 {
248 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100249 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100250 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200251 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200252
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200253 if (*skipwhite(p) == '=' && default_args != NULL)
254 {
255 typval_T rettv;
256
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100257 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200258 any_default = TRUE;
259 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200260 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200261 p = skipwhite(p);
262 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200263 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200264 {
265 if (ga_grow(default_args, 1) == FAIL)
266 goto err_ret;
267
268 // trim trailing whitespace
269 while (p > expr && VIM_ISWHITE(p[-1]))
270 p--;
271 c = *p;
272 *p = NUL;
273 expr = vim_strsave(expr);
274 if (expr == NULL)
275 {
276 *p = c;
277 goto err_ret;
278 }
279 ((char_u **)(default_args->ga_data))
280 [default_args->ga_len] = expr;
281 default_args->ga_len++;
282 *p = c;
283 }
284 else
285 mustend = TRUE;
286 }
287 else if (any_default)
288 {
289 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200290 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200292 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200293 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200295 // Don't give this error when skipping, it makes the "->" not
296 // found in "{k,v -> x}" and give a confusing error.
297 if (!skip && in_vim9script()
298 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
299 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200300 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200301 goto err_ret;
302 }
303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304 else
305 mustend = TRUE;
306 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200307 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200309 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200310
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200311 if (*p != endchar)
312 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100313 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314
315 *argp = p;
316 return OK;
317
318err_ret:
319 if (newargs != NULL)
320 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200321 if (default_args != NULL)
322 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 return FAIL;
324}
325
326/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100327 * Parse the argument types, filling "fp->uf_arg_types".
328 * Return OK or FAIL.
329 */
330 static int
331parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
332{
333 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
334 if (argtypes->ga_len > 0)
335 {
336 // When "varargs" is set the last name/type goes into uf_va_name
337 // and uf_va_type.
338 int len = argtypes->ga_len - (varargs ? 1 : 0);
339
340 if (len > 0)
341 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
342 if (fp->uf_arg_types != NULL)
343 {
344 int i;
345 type_T *type;
346
347 for (i = 0; i < len; ++ i)
348 {
349 char_u *p = ((char_u **)argtypes->ga_data)[i];
350
351 if (p == NULL)
352 // will get the type from the default value
353 type = &t_unknown;
354 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100355 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100356 if (type == NULL)
357 return FAIL;
358 fp->uf_arg_types[i] = type;
359 }
360 }
361 if (varargs)
362 {
363 char_u *p;
364
365 // Move the last argument "...name: type" to uf_va_name and
366 // uf_va_type.
367 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
368 [fp->uf_args.ga_len - 1];
369 --fp->uf_args.ga_len;
370 p = ((char_u **)argtypes->ga_data)[len];
371 if (p == NULL)
372 // todo: get type from default value
373 fp->uf_va_type = &t_any;
374 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100375 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100376 if (fp->uf_va_type == NULL)
377 return FAIL;
378 }
379 }
380 return OK;
381}
382
383/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200384 * Register function "fp" as using "current_funccal" as its scope.
385 */
386 static int
387register_closure(ufunc_T *fp)
388{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200389 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100390 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200391 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200392 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200393 fp->uf_scoped = current_funccal;
394 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200395
Bram Moolenaar58016442016-07-31 18:30:22 +0200396 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
397 return FAIL;
398 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
399 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200400 return OK;
401}
402
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100403 static void
404set_ufunc_name(ufunc_T *fp, char_u *name)
405{
406 STRCPY(fp->uf_name, name);
407
408 if (name[0] == K_SPECIAL)
409 {
410 fp->uf_name_exp = alloc(STRLEN(name) + 3);
411 if (fp->uf_name_exp != NULL)
412 {
413 STRCPY(fp->uf_name_exp, "<SNR>");
414 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
415 }
416 }
417}
418
Bram Moolenaar58016442016-07-31 18:30:22 +0200419/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200420 * Get a name for a lambda. Returned in static memory.
421 */
422 char_u *
423get_lambda_name(void)
424{
425 static char_u name[30];
426 static int lambda_no = 0;
427
428 sprintf((char*)name, "<lambda>%d", ++lambda_no);
429 return name;
430}
431
Bram Moolenaar801ab062020-06-25 19:27:56 +0200432#if defined(FEAT_LUA) || defined(PROTO)
433/*
434 * Registers a native C callback which can be called from Vim script.
435 * Returns the name of the Vim script function.
436 */
437 char_u *
438register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
439{
440 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200441 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200442
443 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
444 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200445 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200446
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200447 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200448 fp->uf_refcount = 1;
449 fp->uf_varargs = TRUE;
450 fp->uf_flags = FC_CFUNC;
451 fp->uf_calls = 0;
452 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200453 fp->uf_cb = cb;
454 fp->uf_cb_free = cb_free;
455 fp->uf_cb_state = state;
456
457 set_ufunc_name(fp, name);
458 hash_add(&func_hashtab, UF2HIKEY(fp));
459
460 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200461}
462#endif
463
Bram Moolenaar04b12692020-05-04 23:24:44 +0200464/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100465 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100466 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100467 * If "white_error" is not NULL check for correct use of white space and set
468 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100469 * Return NULL if no valid arrow found.
470 */
471 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100472skip_arrow(
473 char_u *start,
474 int equal_arrow,
475 char_u **ret_type,
476 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100477{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100478 char_u *s = start;
479 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100480
481 if (equal_arrow)
482 {
483 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100484 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100485 if (white_error != NULL && !VIM_ISWHITE(s[1]))
486 {
487 *white_error = TRUE;
488 semsg(_(e_white_space_required_after_str), ":");
489 return NULL;
490 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100491 s = skipwhite(s + 1);
492 *ret_type = s;
493 s = skip_type(s, TRUE);
494 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100495 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100496 s = skipwhite(s);
497 if (*s != '=')
498 return NULL;
499 ++s;
500 }
501 if (*s != '>')
502 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100503 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
504 || !IS_WHITE_OR_NUL(s[1])))
505 {
506 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100507 semsg(_(e_white_space_required_before_and_after_str_at_str),
508 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100509 return NULL;
510 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100511 return skipwhite(s + 1);
512}
513
514/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200515 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100516 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100517 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200518 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
519 */
520 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100521get_lambda_tv(
522 char_u **arg,
523 typval_T *rettv,
524 int types_optional,
525 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200526{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200527 int evaluate = evalarg != NULL
528 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200529 garray_T newargs;
530 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200531 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100532 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200533 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100534 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200535 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100536 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200538 char_u *s;
539 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200540 int *old_eval_lavars = eval_lavars_used;
541 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200542 char_u *tofree = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100543 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100544 int white_error = FALSE;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545
546 if (equal_arrow && !in_vim9script())
547 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200548
549 ga_init(&newargs);
550 ga_init(&newlines);
551
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100552 // First, check if this is really a lambda expression. "->" or "=>" must
553 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100554 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100555 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100556 types_optional ? &argtypes : NULL, types_optional,
557 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100558 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100559 {
560 if (types_optional)
561 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200562 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200564
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100565 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200566 if (evaluate)
567 pnewargs = &newargs;
568 else
569 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100570 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100571 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100572 types_optional ? &argtypes : NULL, types_optional,
573 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100574 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100575 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100576 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100577 {
578 if (types_optional)
579 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100580 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100581 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100582 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100583 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200584
Bram Moolenaare38eab22019-12-05 21:50:01 +0100585 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200586 if (evaluate)
587 eval_lavars_used = &eval_lavars;
588
Bram Moolenaar65c44152020-12-24 15:14:01 +0100589 *arg = skipwhite_and_linebreak(*arg, evalarg);
590
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100591 // Recognize "{" as the start of a function body.
592 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100593 {
594 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100595 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100596 emsg("Lambda function body not supported yet");
597 goto errret;
598 }
599
Bram Moolenaare38eab22019-12-05 21:50:01 +0100600 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200601 start = *arg;
602 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200603 if (ret == FAIL)
604 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200605 if (evalarg != NULL)
606 {
607 // avoid that the expression gets freed when another line break follows
608 tofree = evalarg->eval_tofree;
609 evalarg->eval_tofree = NULL;
610 }
611
Bram Moolenaar65c44152020-12-24 15:14:01 +0100612 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100613 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100614 *arg = skipwhite_and_linebreak(*arg, evalarg);
615 if (**arg != '}')
616 {
617 semsg(_("E451: Expected }: %s"), *arg);
618 goto errret;
619 }
620 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200622
623 if (evaluate)
624 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200625 int len;
626 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200627 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200628 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200629
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200630 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200631 if (fp == NULL)
632 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200633 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200634 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200635 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200636 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200637
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200638 ga_init2(&newlines, (int)sizeof(char_u *), 1);
639 if (ga_grow(&newlines, 1) == FAIL)
640 goto errret;
641
Bram Moolenaare38eab22019-12-05 21:50:01 +0100642 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200643 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200644 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645 if (p == NULL)
646 goto errret;
647 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
648 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200649 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200650 if (strstr((char *)p + 7, "a:") == NULL)
651 // No a: variables are used for sure.
652 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653
654 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100655 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200656 hash_add(&func_hashtab, UF2HIKEY(fp));
657 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200658 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100659 if (types_optional)
660 {
661 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
662 goto errret;
663 if (ret_type != NULL)
664 {
665 fp->uf_ret_type = parse_type(&ret_type,
666 &fp->uf_type_list, TRUE);
667 if (fp->uf_ret_type == NULL)
668 goto errret;
669 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100670 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100671 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100672 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100673
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200674 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200675 if (current_funccal != NULL && eval_lavars)
676 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200677 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200678 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200679 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200681
682#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200683 if (prof_def_func())
684 func_do_profile(fp);
685#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200686 if (sandbox)
687 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100688 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200689 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200690 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200692 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100693 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200694
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200695 pt->pt_func = fp;
696 pt->pt_refcount = 1;
697 rettv->vval.v_partial = pt;
698 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200699 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200700
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200701 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200702 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200703 evalarg->eval_tofree = tofree;
704 else
705 vim_free(tofree);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100706 if (types_optional)
707 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200708 return OK;
709
710errret:
711 ga_clear_strings(&newargs);
712 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100713 if (types_optional)
714 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200715 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100716 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200717 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200718 evalarg->eval_tofree = tofree;
719 else
720 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200721 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200722 return FAIL;
723}
724
725/*
726 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
727 * name it contains, otherwise return "name".
728 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
729 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100730 * If "type" is not NULL and a Vim9 script-local variable is found look up the
731 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200732 */
733 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100734deref_func_name(
735 char_u *name,
736 int *lenp,
737 partial_T **partialp,
738 type_T **type,
739 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200740{
741 dictitem_T *v;
742 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100743 char_u *s = NULL;
744 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200745
746 if (partialp != NULL)
747 *partialp = NULL;
748
749 cc = name[*lenp];
750 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100751 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200752 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100753 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200754 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100755 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200756 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100757 if (v->di_tv.vval.v_string == NULL)
758 {
759 *lenp = 0;
760 return (char_u *)""; // just in case
761 }
762 s = v->di_tv.vval.v_string;
763 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200764 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200765
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100766 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200767 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100768 partial_T *pt = v->di_tv.vval.v_partial;
769
770 if (pt == NULL)
771 {
772 *lenp = 0;
773 return (char_u *)""; // just in case
774 }
775 if (partialp != NULL)
776 *partialp = pt;
777 s = partial_name(pt);
778 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200779 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100780
781 if (s != NULL)
782 {
783 if (type != NULL && ht == get_script_local_ht())
784 {
785 svar_T *sv = find_typval_in_script(&v->di_tv);
786
787 if (sv != NULL)
788 *type = sv->sv_type;
789 }
790 return s;
791 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200792 }
793
794 return name;
795}
796
797/*
798 * Give an error message with a function name. Handle <SNR> things.
799 * "ermsg" is to be passed without translation, use N_() instead of _().
800 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100801 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200802emsg_funcname(char *ermsg, char_u *name)
803{
804 char_u *p;
805
806 if (*name == K_SPECIAL)
807 p = concat_str((char_u *)"<SNR>", name + 3);
808 else
809 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100810 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200811 if (p != name)
812 vim_free(p);
813}
814
815/*
816 * Allocate a variable for the result of a function.
817 * Return OK or FAIL.
818 */
819 int
820get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200821 char_u *name, // name of the function
822 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200823 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200824 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200825 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200826 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200827{
828 char_u *argp;
829 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100830 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
831 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200832 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200833
834 /*
835 * Get the arguments.
836 */
837 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200838 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
839 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200840 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200841 // skip the '(' or ',' and possibly line breaks
842 argp = skipwhite_and_linebreak(argp + 1, evalarg);
843
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200844 if (*argp == ')' || *argp == ',' || *argp == NUL)
845 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200846 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200847 {
848 ret = FAIL;
849 break;
850 }
851 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200852 // The comma should come right after the argument, but this wasn't
853 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200854 if (vim9script)
855 {
856 if (*argp != ',' && *skipwhite(argp) == ',')
857 {
858 semsg(_(e_no_white_space_allowed_before_str), ",");
859 ret = FAIL;
860 break;
861 }
862 }
863 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200864 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200865 if (*argp != ',')
866 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200867 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
868 {
869 semsg(_(e_white_space_required_after_str), ",");
870 ret = FAIL;
871 break;
872 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200873 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200874 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200875 if (*argp == ')')
876 ++argp;
877 else
878 ret = FAIL;
879
880 if (ret == OK)
881 {
882 int i = 0;
883
884 if (get_vim_var_nr(VV_TESTING))
885 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100886 // Prepare for calling test_garbagecollect_now(), need to know
887 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200888 if (funcargs.ga_itemsize == 0)
889 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
890 for (i = 0; i < argcount; ++i)
891 if (ga_grow(&funcargs, 1) == OK)
892 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
893 &argvars[i];
894 }
895
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200896 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200897
898 funcargs.ga_len -= i;
899 }
900 else if (!aborting())
901 {
902 if (argcount == MAX_FUNC_ARGS)
903 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
904 else
905 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
906 }
907
908 while (--argcount >= 0)
909 clear_tv(&argvars[argcount]);
910
Bram Moolenaar8294d492020-08-10 22:40:56 +0200911 if (in_vim9script())
912 *arg = argp;
913 else
914 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200915 return ret;
916}
917
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200918/*
919 * Return TRUE if "p" starts with "<SID>" or "s:".
920 * Only works if eval_fname_script() returned non-zero for "p"!
921 */
922 static int
923eval_fname_sid(char_u *p)
924{
925 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
926}
927
928/*
929 * In a script change <SID>name() and s:name() to K_SNR 123_name().
930 * Change <SNR>123_name() to K_SNR 123_name().
931 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
932 * (slow).
933 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100934 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200935fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
936{
937 int llen;
938 char_u *fname;
939 int i;
940
941 llen = eval_fname_script(name);
942 if (llen > 0)
943 {
944 fname_buf[0] = K_SPECIAL;
945 fname_buf[1] = KS_EXTRA;
946 fname_buf[2] = (int)KE_SNR;
947 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100948 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200949 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200950 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100951 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200952 else
953 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200954 sprintf((char *)fname_buf + 3, "%ld_",
955 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200956 i = (int)STRLEN(fname_buf);
957 }
958 }
959 if (i + STRLEN(name + llen) < FLEN_FIXED)
960 {
961 STRCPY(fname_buf + i, name + llen);
962 fname = fname_buf;
963 }
964 else
965 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200966 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200967 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100968 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200969 else
970 {
971 *tofree = fname;
972 mch_memmove(fname, fname_buf, (size_t)i);
973 STRCPY(fname + i, name + llen);
974 }
975 }
976 }
977 else
978 fname = name;
979 return fname;
980}
981
982/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100983 * Find a function "name" in script "sid".
984 */
985 static ufunc_T *
986find_func_with_sid(char_u *name, int sid)
987{
988 hashitem_T *hi;
989 char_u buffer[200];
990
991 buffer[0] = K_SPECIAL;
992 buffer[1] = KS_EXTRA;
993 buffer[2] = (int)KE_SNR;
994 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
995 (long)sid, name);
996 hi = hash_find(&func_hashtab, buffer);
997 if (!HASHITEM_EMPTY(hi))
998 return HI2UF(hi);
999
1000 return NULL;
1001}
1002
1003/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001004 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001005 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001006 * Return NULL for unknown function.
1007 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001008 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001009find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001010{
1011 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001012 ufunc_T *func;
1013 imported_T *imported;
1014
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001015 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001016 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001017 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001018 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001019 int find_script_local = in_vim9script()
1020 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001021
Bram Moolenaar95006e32020-08-29 17:47:08 +02001022 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001023 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001024 // Find script-local function before global one.
1025 func = find_func_with_sid(name, current_sctx.sc_sid);
1026 if (func != NULL)
1027 return func;
1028 }
1029
Bram Moolenaarefa94442020-08-08 22:16:00 +02001030 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001031 && name[1] == KS_EXTRA
1032 && name[2] == KE_SNR)
1033 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001034 // Caller changes s: to <SNR>99_name.
1035
1036 after_script = name + 3;
1037 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001038 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001039 ++after_script;
1040 else
1041 after_script = NULL;
1042 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001043 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001044 {
1045 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001046 if (after_script != NULL && sid != current_sctx.sc_sid)
1047 imported = find_imported_in_script(after_script, 0, sid);
1048 else
1049 imported = find_imported(after_script == NULL
1050 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001051 if (imported != NULL && imported->imp_funcname != NULL)
1052 {
1053 hi = hash_find(&func_hashtab, imported->imp_funcname);
1054 if (!HASHITEM_EMPTY(hi))
1055 return HI2UF(hi);
1056 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001057 }
1058 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001059
Bram Moolenaara26b9702020-04-18 19:53:28 +02001060 hi = hash_find(&func_hashtab,
1061 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001062 if (!HASHITEM_EMPTY(hi))
1063 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001064
1065 return NULL;
1066}
1067
1068/*
1069 * Find a function by name, return pointer to it in ufuncs.
1070 * "cctx" is passed in a :def function to find imported functions.
1071 * Return NULL for unknown or dead function.
1072 */
1073 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001074find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001075{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001076 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001077
1078 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1079 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080 return NULL;
1081}
1082
1083/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001084 * Return TRUE if "ufunc" is a global function.
1085 */
1086 int
1087func_is_global(ufunc_T *ufunc)
1088{
1089 return ufunc->uf_name[0] != K_SPECIAL;
1090}
1091
1092/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001093 * Copy the function name of "fp" to buffer "buf".
1094 * "buf" must be able to hold the function name plus three bytes.
1095 * Takes care of script-local function names.
1096 */
1097 static void
1098cat_func_name(char_u *buf, ufunc_T *fp)
1099{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001100 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001101 {
1102 STRCPY(buf, "<SNR>");
1103 STRCAT(buf, fp->uf_name + 3);
1104 }
1105 else
1106 STRCPY(buf, fp->uf_name);
1107}
1108
1109/*
1110 * Add a number variable "name" to dict "dp" with value "nr".
1111 */
1112 static void
1113add_nr_var(
1114 dict_T *dp,
1115 dictitem_T *v,
1116 char *name,
1117 varnumber_T nr)
1118{
1119 STRCPY(v->di_key, name);
1120 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1121 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1122 v->di_tv.v_type = VAR_NUMBER;
1123 v->di_tv.v_lock = VAR_FIXED;
1124 v->di_tv.vval.v_number = nr;
1125}
1126
1127/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001128 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001129 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001130 static void
1131free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001132{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001133 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001134
1135 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1136 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001137 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001138
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001139 // When garbage collecting a funccall_T may be freed before the
1140 // function that references it, clear its uf_scoped field.
1141 // The function may have been redefined and point to another
1142 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001143 if (fp != NULL && fp->uf_scoped == fc)
1144 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001145 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001146 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001147
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001148 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001149 vim_free(fc);
1150}
1151
1152/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001153 * Free "fc" and what it contains.
1154 * Can be called only when "fc" is kept beyond the period of it called,
1155 * i.e. after cleanup_function_call(fc).
1156 */
1157 static void
1158free_funccal_contents(funccall_T *fc)
1159{
1160 listitem_T *li;
1161
1162 // Free all l: variables.
1163 vars_clear(&fc->l_vars.dv_hashtab);
1164
1165 // Free all a: variables.
1166 vars_clear(&fc->l_avars.dv_hashtab);
1167
1168 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001169 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001170 clear_tv(&li->li_tv);
1171
1172 free_funccal(fc);
1173}
1174
1175/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001176 * Handle the last part of returning from a function: free the local hashtable.
1177 * Unless it is still in use by a closure.
1178 */
1179 static void
1180cleanup_function_call(funccall_T *fc)
1181{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001182 int may_free_fc = fc->fc_refcount <= 0;
1183 int free_fc = TRUE;
1184
Bram Moolenaar6914c642017-04-01 21:21:30 +02001185 current_funccal = fc->caller;
1186
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001187 // Free all l: variables if not referred.
1188 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1189 vars_clear(&fc->l_vars.dv_hashtab);
1190 else
1191 free_fc = FALSE;
1192
1193 // If the a:000 list and the l: and a: dicts are not referenced and
1194 // there is no closure using it, we can free the funccall_T and what's
1195 // in it.
1196 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1197 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001198 else
1199 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001200 int todo;
1201 hashitem_T *hi;
1202 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001203
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001204 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001205
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001206 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001207 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1208 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1209 {
1210 if (!HASHITEM_EMPTY(hi))
1211 {
1212 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001213 di = HI2DI(hi);
1214 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001215 }
1216 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001217 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001218
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001219 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1220 fc->l_varlist.lv_first = NULL;
1221 else
1222 {
1223 listitem_T *li;
1224
1225 free_fc = FALSE;
1226
1227 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001228 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001229 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001230 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001231
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001232 if (free_fc)
1233 free_funccal(fc);
1234 else
1235 {
1236 static int made_copy = 0;
1237
1238 // "fc" is still in use. This can happen when returning "a:000",
1239 // assigning "l:" to a global variable or defining a closure.
1240 // Link "fc" in the list for garbage collection later.
1241 fc->caller = previous_funccal;
1242 previous_funccal = fc;
1243
1244 if (want_garbage_collect)
1245 // If garbage collector is ready, clear count.
1246 made_copy = 0;
1247 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001248 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001249 // We have made a lot of copies, worth 4 Mbyte. This can happen
1250 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001251 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001252 // too much memory.
1253 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001254 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001255 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001256 }
1257}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001258
1259/*
1260 * There are two kinds of function names:
1261 * 1. ordinary names, function defined with :function or :def
1262 * 2. numbered functions and lambdas
1263 * For the first we only count the name stored in func_hashtab as a reference,
1264 * using function() does not count as a reference, because the function is
1265 * looked up by name.
1266 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001267 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001268func_name_refcount(char_u *name)
1269{
1270 return isdigit(*name) || *name == '<';
1271}
1272
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001273/*
1274 * Unreference "fc": decrement the reference count and free it when it
1275 * becomes zero. "fp" is detached from "fc".
1276 * When "force" is TRUE we are exiting.
1277 */
1278 static void
1279funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1280{
1281 funccall_T **pfc;
1282 int i;
1283
1284 if (fc == NULL)
1285 return;
1286
1287 if (--fc->fc_refcount <= 0 && (force || (
1288 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1289 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1290 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1291 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1292 {
1293 if (fc == *pfc)
1294 {
1295 *pfc = fc->caller;
1296 free_funccal_contents(fc);
1297 return;
1298 }
1299 }
1300 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1301 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1302 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1303}
1304
1305/*
1306 * Remove the function from the function hashtable. If the function was
1307 * deleted while it still has references this was already done.
1308 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1309 */
1310 static int
1311func_remove(ufunc_T *fp)
1312{
1313 hashitem_T *hi;
1314
1315 // Return if it was already virtually deleted.
1316 if (fp->uf_flags & FC_DEAD)
1317 return FALSE;
1318
1319 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1320 if (!HASHITEM_EMPTY(hi))
1321 {
1322 // When there is a def-function index do not actually remove the
1323 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001324 // Do remove it when it's a copy.
1325 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001326 fp->uf_flags |= FC_DEAD;
1327 else
1328 hash_remove(&func_hashtab, hi);
1329 return TRUE;
1330 }
1331 return FALSE;
1332}
1333
1334 static void
1335func_clear_items(ufunc_T *fp)
1336{
1337 ga_clear_strings(&(fp->uf_args));
1338 ga_clear_strings(&(fp->uf_def_args));
1339 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001340 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001341 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001342 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001343 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001344 clear_type_list(&fp->uf_type_list);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001345 partial_unref(fp->uf_partial);
1346 fp->uf_partial = NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001347
1348#ifdef FEAT_LUA
1349 if (fp->uf_cb_free != NULL)
1350 {
1351 fp->uf_cb_free(fp->uf_cb_state);
1352 fp->uf_cb_free = NULL;
1353 }
1354
1355 fp->uf_cb_state = NULL;
1356 fp->uf_cb = NULL;
1357#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001358#ifdef FEAT_PROFILE
1359 VIM_CLEAR(fp->uf_tml_count);
1360 VIM_CLEAR(fp->uf_tml_total);
1361 VIM_CLEAR(fp->uf_tml_self);
1362#endif
1363}
1364
1365/*
1366 * Free all things that a function contains. Does not free the function
1367 * itself, use func_free() for that.
1368 * When "force" is TRUE we are exiting.
1369 */
1370 static void
1371func_clear(ufunc_T *fp, int force)
1372{
1373 if (fp->uf_cleared)
1374 return;
1375 fp->uf_cleared = TRUE;
1376
1377 // clear this function
1378 func_clear_items(fp);
1379 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001380 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001381}
1382
1383/*
1384 * Free a function and remove it from the list of functions. Does not free
1385 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001386 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001387 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001388 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001389 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001390func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001391{
1392 // Only remove it when not done already, otherwise we would remove a newer
1393 // version of the function with the same name.
1394 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1395 func_remove(fp);
1396
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001397 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001398 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001399 if (fp->uf_dfunc_idx > 0)
1400 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001401 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001402 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001403 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001404 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001405 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001406}
1407
1408/*
1409 * Free all things that a function contains and free the function itself.
1410 * When "force" is TRUE we are exiting.
1411 */
1412 static void
1413func_clear_free(ufunc_T *fp, int force)
1414{
1415 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001416 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1417 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001418 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001419 else
1420 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001421}
1422
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001423/*
1424 * Copy already defined function "lambda" to a new function with name "global".
1425 * This is for when a compiled function defines a global function.
1426 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001427 int
1428copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001429{
1430 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001431 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001432
1433 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001434 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001435 semsg(_(e_lambda_function_not_found_str), lambda);
1436 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001437 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001438
1439 // TODO: handle ! to overwrite
1440 fp = find_func(global, TRUE, NULL);
1441 if (fp != NULL)
1442 {
1443 semsg(_(e_funcexts), global);
1444 return FAIL;
1445 }
1446
1447 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1448 if (fp == NULL)
1449 return FAIL;
1450
1451 fp->uf_varargs = ufunc->uf_varargs;
1452 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1453 fp->uf_def_status = ufunc->uf_def_status;
1454 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1455 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1456 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1457 == FAIL
1458 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1459 goto failed;
1460
1461 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1462 : vim_strsave(ufunc->uf_name_exp);
1463 if (ufunc->uf_arg_types != NULL)
1464 {
1465 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1466 if (fp->uf_arg_types == NULL)
1467 goto failed;
1468 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1469 sizeof(type_T *) * fp->uf_args.ga_len);
1470 }
1471 if (ufunc->uf_def_arg_idx != NULL)
1472 {
1473 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1474 if (fp->uf_def_arg_idx == NULL)
1475 goto failed;
1476 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1477 sizeof(int) * fp->uf_def_args.ga_len + 1);
1478 }
1479 if (ufunc->uf_va_name != NULL)
1480 {
1481 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1482 if (fp->uf_va_name == NULL)
1483 goto failed;
1484 }
1485 fp->uf_ret_type = ufunc->uf_ret_type;
1486
1487 fp->uf_refcount = 1;
1488 STRCPY(fp->uf_name, global);
1489 hash_add(&func_hashtab, UF2HIKEY(fp));
1490
1491 // the referenced dfunc_T is now used one more time
1492 link_def_function(fp);
1493
1494 // Create a partial to store the context of the function, if not done
1495 // already.
1496 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1497 {
1498 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1499
1500 if (pt == NULL)
1501 goto failed;
1502 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
1503 goto failed;
1504 ufunc->uf_partial = pt;
1505 --pt->pt_refcount; // not referenced here yet
1506 }
1507 if (ufunc->uf_partial != NULL)
1508 {
1509 fp->uf_partial = ufunc->uf_partial;
1510 ++fp->uf_partial->pt_refcount;
1511 }
1512
1513 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001514
1515failed:
1516 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001517 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001518}
1519
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001520static int funcdepth = 0;
1521
1522/*
1523 * Increment the function call depth count.
1524 * Return FAIL when going over 'maxfuncdepth'.
1525 * Otherwise return OK, must call funcdepth_decrement() later!
1526 */
1527 int
1528funcdepth_increment(void)
1529{
1530 if (funcdepth >= p_mfd)
1531 {
1532 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1533 return FAIL;
1534 }
1535 ++funcdepth;
1536 return OK;
1537}
1538
1539 void
1540funcdepth_decrement(void)
1541{
1542 --funcdepth;
1543}
1544
1545/*
1546 * Get the current function call depth.
1547 */
1548 int
1549funcdepth_get(void)
1550{
1551 return funcdepth;
1552}
1553
1554/*
1555 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001556 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001557 * times as funcdepth_increment().
1558 */
1559 void
1560funcdepth_restore(int depth)
1561{
1562 funcdepth = depth;
1563}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001564
1565/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 * Call a user function.
1567 */
1568 static void
1569call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001570 ufunc_T *fp, // pointer to function
1571 int argcount, // nr of args
1572 typval_T *argvars, // arguments
1573 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001574 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001575 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001577 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001578 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001579 funccall_T *fc;
1580 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001581 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001583 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 int i;
1585 int ai;
1586 int islambda = FALSE;
1587 char_u numbuf[NUMBUFLEN];
1588 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589#ifdef FEAT_PROFILE
1590 proftime_T wait_start;
1591 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001592 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001594 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001596 // If depth of calling is getting too high, don't execute the function.
1597 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 rettv->v_type = VAR_NUMBER;
1600 rettv->vval.v_number = -1;
1601 return;
1602 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603
Bram Moolenaare38eab22019-12-05 21:50:01 +01001604 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001605
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001606 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001607 if (fc == NULL)
1608 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 fc->caller = current_funccal;
1610 current_funccal = fc;
1611 fc->func = fp;
1612 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001614 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1616 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001617 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001618 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001619 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001621 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001622 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001623 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001624 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001625 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001626 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001627 free_funccal(fc);
1628 return;
1629 }
1630
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001631 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1632 islambda = TRUE;
1633
1634 /*
1635 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1636 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1637 * each argument variable and saves a lot of time.
1638 */
1639 /*
1640 * Init l: variables.
1641 */
1642 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1643 if (selfdict != NULL)
1644 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001645 // Set l:self to "selfdict". Use "name" to avoid a warning from
1646 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 v = &fc->fixvar[fixvar_idx++].var;
1648 name = v->di_key;
1649 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001650 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001651 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1652 v->di_tv.v_type = VAR_DICT;
1653 v->di_tv.v_lock = 0;
1654 v->di_tv.vval.v_dict = selfdict;
1655 ++selfdict->dv_refcount;
1656 }
1657
1658 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001659 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001660 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 * Set a:000 to a list with room for the "..." arguments.
1662 */
1663 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001664 if ((fp->uf_flags & FC_NOARGS) == 0)
1665 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001666 (varnumber_T)(argcount >= fp->uf_args.ga_len
1667 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001668 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001669 if ((fp->uf_flags & FC_NOARGS) == 0)
1670 {
1671 // Use "name" to avoid a warning from some compiler that checks the
1672 // destination size.
1673 v = &fc->fixvar[fixvar_idx++].var;
1674 name = v->di_key;
1675 STRCPY(name, "000");
1676 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1677 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1678 v->di_tv.v_type = VAR_LIST;
1679 v->di_tv.v_lock = VAR_FIXED;
1680 v->di_tv.vval.v_list = &fc->l_varlist;
1681 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001682 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1684 fc->l_varlist.lv_lock = VAR_FIXED;
1685
1686 /*
1687 * Set a:firstline to "firstline" and a:lastline to "lastline".
1688 * Set a:name to named arguments.
1689 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001690 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001692 if ((fp->uf_flags & FC_NOARGS) == 0)
1693 {
1694 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001695 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001696 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001697 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001698 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001699 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700 {
1701 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001702 typval_T def_rettv;
1703 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001704
1705 ai = i - fp->uf_args.ga_len;
1706 if (ai < 0)
1707 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001708 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001709 name = FUNCARG(fp, i);
1710 if (islambda)
1711 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001712
1713 // evaluate named argument default expression
1714 isdefault = ai + fp->uf_def_args.ga_len >= 0
1715 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1716 && argvars[i].vval.v_number == VVAL_NONE));
1717 if (isdefault)
1718 {
1719 char_u *default_expr = NULL;
1720 def_rettv.v_type = VAR_NUMBER;
1721 def_rettv.vval.v_number = -1;
1722
1723 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1724 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001725 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001726 {
1727 default_arg_err = 1;
1728 break;
1729 }
1730 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731 }
1732 else
1733 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001734 if ((fp->uf_flags & FC_NOARGS) != 0)
1735 // Bail out if no a: arguments used (in lambda).
1736 break;
1737
Bram Moolenaare38eab22019-12-05 21:50:01 +01001738 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001739 sprintf((char *)numbuf, "%d", ai + 1);
1740 name = numbuf;
1741 }
1742 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1743 {
1744 v = &fc->fixvar[fixvar_idx++].var;
1745 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001746 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747 }
1748 else
1749 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001750 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 if (v == NULL)
1752 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001753 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001755
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001756 // Note: the values are copied directly to avoid alloc/free.
1757 // "argvars" must have VAR_FIXED for v_lock.
1758 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 v->di_tv.v_lock = VAR_FIXED;
1760
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761 if (addlocal)
1762 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001763 // Named arguments should be accessed without the "a:" prefix in
1764 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001765 copy_tv(&v->di_tv, &v->di_tv);
1766 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001768 else
1769 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001770
1771 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1772 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001773 listitem_T *li = &fc->l_listitems[ai];
1774
1775 li->li_tv = argvars[i];
1776 li->li_tv.v_lock = VAR_FIXED;
1777 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 }
1779 }
1780
Bram Moolenaare38eab22019-12-05 21:50:01 +01001781 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001782 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001783
1784 if (fp->uf_flags & FC_SANDBOX)
1785 {
1786 using_sandbox = TRUE;
1787 ++sandbox;
1788 }
1789
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001790 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001791 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001792 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001794 ++no_wait_return;
1795 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001797 smsg(_("calling %s"), SOURCING_NAME);
1798 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001800 char_u buf[MSG_BUF_LEN];
1801 char_u numbuf2[NUMBUFLEN];
1802 char_u *tofree;
1803 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001805 msg_puts("(");
1806 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001808 if (i > 0)
1809 msg_puts(", ");
1810 if (argvars[i].v_type == VAR_NUMBER)
1811 msg_outnum((long)argvars[i].vval.v_number);
1812 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001814 // Do not want errors such as E724 here.
1815 ++emsg_off;
1816 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1817 --emsg_off;
1818 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001820 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001822 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1823 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001824 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001825 msg_puts((char *)s);
1826 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 }
1828 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001829 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001830 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001832 msg_puts("\n"); // don't overwrite this either
1833
1834 verbose_leave_scroll();
1835 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836 }
1837#ifdef FEAT_PROFILE
1838 if (do_profiling == PROF_YES)
1839 {
1840 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001841 {
1842 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001844 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 if (fp->uf_profiling
1846 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1847 {
1848 ++fp->uf_tm_count;
1849 profile_start(&call_start);
1850 profile_zero(&fp->uf_tm_children);
1851 }
1852 script_prof_save(&wait_start);
1853 }
1854#endif
1855
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001856 save_current_sctx = current_sctx;
1857 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 save_did_emsg = did_emsg;
1859 did_emsg = FALSE;
1860
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001861 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1862 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001863 else if (islambda)
1864 {
1865 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1866
1867 // A Lambda always has the command "return {expr}". It is much faster
1868 // to evaluate {expr} directly.
1869 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001870 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001871 --ex_nesting_level;
1872 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001873 else
1874 // call do_cmdline() to execute the lines
1875 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001876 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1877
1878 --RedrawingDisabled;
1879
Bram Moolenaare38eab22019-12-05 21:50:01 +01001880 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001881 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1882 {
1883 clear_tv(rettv);
1884 rettv->v_type = VAR_NUMBER;
1885 rettv->vval.v_number = -1;
1886 }
1887
1888#ifdef FEAT_PROFILE
1889 if (do_profiling == PROF_YES && (fp->uf_profiling
1890 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1891 {
1892 profile_end(&call_start);
1893 profile_sub_wait(&wait_start, &call_start);
1894 profile_add(&fp->uf_tm_total, &call_start);
1895 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1896 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1897 {
1898 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1899 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1900 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001901 if (started_profiling)
1902 // make a ":profdel func" stop profiling the function
1903 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001904 }
1905#endif
1906
Bram Moolenaare38eab22019-12-05 21:50:01 +01001907 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001908 if (p_verbose >= 12)
1909 {
1910 ++no_wait_return;
1911 verbose_enter_scroll();
1912
1913 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001914 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001915 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001916 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 (long)fc->rettv->vval.v_number);
1918 else
1919 {
1920 char_u buf[MSG_BUF_LEN];
1921 char_u numbuf2[NUMBUFLEN];
1922 char_u *tofree;
1923 char_u *s;
1924
Bram Moolenaare38eab22019-12-05 21:50:01 +01001925 // The value may be very long. Skip the middle part, so that we
1926 // have some idea how it starts and ends. smsg() would always
1927 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001928 ++emsg_off;
1929 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1930 --emsg_off;
1931 if (s != NULL)
1932 {
1933 if (vim_strsize(s) > MSG_BUF_CLEN)
1934 {
1935 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1936 s = buf;
1937 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001938 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001939 vim_free(tofree);
1940 }
1941 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001942 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943
1944 verbose_leave_scroll();
1945 --no_wait_return;
1946 }
1947
Bram Moolenaare31ee862020-01-07 20:59:34 +01001948 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001949 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001950 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951#ifdef FEAT_PROFILE
1952 if (do_profiling == PROF_YES)
1953 script_prof_restore(&wait_start);
1954#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001955 if (using_sandbox)
1956 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001957
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001958 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001959 {
1960 ++no_wait_return;
1961 verbose_enter_scroll();
1962
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001963 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001964 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965
1966 verbose_leave_scroll();
1967 --no_wait_return;
1968 }
1969
1970 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001971 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001972 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001973}
1974
1975/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001976 * Check the argument count for user function "fp".
1977 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1978 */
1979 int
1980check_user_func_argcount(ufunc_T *fp, int argcount)
1981{
1982 int regular_args = fp->uf_args.ga_len;
1983
1984 if (argcount < regular_args - fp->uf_def_args.ga_len)
1985 return FCERR_TOOFEW;
1986 else if (!has_varargs(fp) && argcount > regular_args)
1987 return FCERR_TOOMANY;
1988 return FCERR_UNKNOWN;
1989}
1990
1991/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001992 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001993 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001994 int
1995call_user_func_check(
1996 ufunc_T *fp,
1997 int argcount,
1998 typval_T *argvars,
1999 typval_T *rettv,
2000 funcexe_T *funcexe,
2001 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002002{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002003 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002004
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002005 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2006 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002007 error = check_user_func_argcount(fp, argcount);
2008 if (error != FCERR_UNKNOWN)
2009 return error;
2010 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002011 error = FCERR_DICT;
2012 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002013 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002014 int did_save_redo = FALSE;
2015 save_redo_T save_redo;
2016
2017 /*
2018 * Call the user function.
2019 * Save and restore search patterns, script variables and
2020 * redo buffer.
2021 */
2022 save_search_patterns();
2023 if (!ins_compl_active())
2024 {
2025 saveRedobuff(&save_redo);
2026 did_save_redo = TRUE;
2027 }
2028 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002029 call_user_func(fp, argcount, argvars, rettv, funcexe,
2030 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2032 // Function was unreferenced while being used, free it now.
2033 func_clear_free(fp, FALSE);
2034 if (did_save_redo)
2035 restoreRedobuff(&save_redo);
2036 restore_search_patterns();
2037 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002038 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002039 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002040}
2041
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002042static funccal_entry_T *funccal_stack = NULL;
2043
2044/*
2045 * Save the current function call pointer, and set it to NULL.
2046 * Used when executing autocommands and for ":source".
2047 */
2048 void
2049save_funccal(funccal_entry_T *entry)
2050{
2051 entry->top_funccal = current_funccal;
2052 entry->next = funccal_stack;
2053 funccal_stack = entry;
2054 current_funccal = NULL;
2055}
2056
2057 void
2058restore_funccal(void)
2059{
2060 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002061 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002062 else
2063 {
2064 current_funccal = funccal_stack->top_funccal;
2065 funccal_stack = funccal_stack->next;
2066 }
2067}
2068
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002069 funccall_T *
2070get_current_funccal(void)
2071{
2072 return current_funccal;
2073}
2074
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002075/*
2076 * Mark all functions of script "sid" as deleted.
2077 */
2078 void
2079delete_script_functions(int sid)
2080{
2081 hashitem_T *hi;
2082 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002083 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002084 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002085 size_t len;
2086
2087 buf[0] = K_SPECIAL;
2088 buf[1] = KS_EXTRA;
2089 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002090 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002091 len = STRLEN(buf);
2092
Bram Moolenaarce658352020-07-31 23:47:12 +02002093 while (todo > 0)
2094 {
2095 todo = func_hashtab.ht_used;
2096 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2097 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002098 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002099 fp = HI2UF(hi);
2100 if (STRNCMP(fp->uf_name, buf, len) == 0)
2101 {
2102 int changed = func_hashtab.ht_changed;
2103
2104 fp->uf_flags |= FC_DEAD;
2105 func_clear(fp, TRUE);
2106 // When clearing a function another function can be cleared
2107 // as a side effect. When that happens start over.
2108 if (changed != func_hashtab.ht_changed)
2109 break;
2110 }
2111 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002112 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002113 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002114}
2115
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116#if defined(EXITFREE) || defined(PROTO)
2117 void
2118free_all_functions(void)
2119{
2120 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002121 ufunc_T *fp;
2122 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002123 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002124 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125
Bram Moolenaare38eab22019-12-05 21:50:01 +01002126 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002127 while (current_funccal != NULL)
2128 {
2129 clear_tv(current_funccal->rettv);
2130 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002131 if (current_funccal == NULL && funccal_stack != NULL)
2132 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002133 }
2134
Bram Moolenaare38eab22019-12-05 21:50:01 +01002135 // First clear what the functions contain. Since this may lower the
2136 // reference count of a function, it may also free a function and change
2137 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002138 while (todo > 0)
2139 {
2140 todo = func_hashtab.ht_used;
2141 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2142 if (!HASHITEM_EMPTY(hi))
2143 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002144 // clear the def function index now
2145 fp = HI2UF(hi);
2146 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002147 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002148
Bram Moolenaare38eab22019-12-05 21:50:01 +01002149 // Only free functions that are not refcounted, those are
2150 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002151 if (func_name_refcount(fp->uf_name))
2152 ++skipped;
2153 else
2154 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002155 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002156 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002157 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002158 {
2159 skipped = 0;
2160 break;
2161 }
2162 }
2163 --todo;
2164 }
2165 }
2166
Bram Moolenaare38eab22019-12-05 21:50:01 +01002167 // Now actually free the functions. Need to start all over every time,
2168 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002169 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002170 while (func_hashtab.ht_used > skipped)
2171 {
2172 todo = func_hashtab.ht_used;
2173 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002174 if (!HASHITEM_EMPTY(hi))
2175 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002176 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002177 // Only free functions that are not refcounted, those are
2178 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002179 fp = HI2UF(hi);
2180 if (func_name_refcount(fp->uf_name))
2181 ++skipped;
2182 else
2183 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002184 if (func_free(fp, FALSE) == OK)
2185 {
2186 skipped = 0;
2187 break;
2188 }
2189 // did not actually free it
2190 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002191 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002192 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002193 }
2194 if (skipped == 0)
2195 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002196
2197 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198}
2199#endif
2200
2201/*
2202 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002203 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 * "len" is the length of "name", or -1 for NUL terminated.
2205 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002206 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002207builtin_function(char_u *name, int len)
2208{
2209 char_u *p;
2210
Bram Moolenaara26b9702020-04-18 19:53:28 +02002211 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212 return FALSE;
2213 p = vim_strchr(name, AUTOLOAD_CHAR);
2214 return p == NULL || (len > 0 && p > name + len);
2215}
2216
2217 int
2218func_call(
2219 char_u *name,
2220 typval_T *args,
2221 partial_T *partial,
2222 dict_T *selfdict,
2223 typval_T *rettv)
2224{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002225 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226 listitem_T *item;
2227 typval_T argv[MAX_FUNC_ARGS + 1];
2228 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229 int r = 0;
2230
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002231 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002232 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002233 {
2234 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2235 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002236 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002237 break;
2238 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002239 // Make a copy of each argument. This is needed to be able to set
2240 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 copy_tv(&item->li_tv, &argv[argc++]);
2242 }
2243
2244 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002245 {
2246 funcexe_T funcexe;
2247
Bram Moolenaara80faa82020-04-12 19:37:17 +02002248 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002249 funcexe.firstline = curwin->w_cursor.lnum;
2250 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002251 funcexe.evaluate = TRUE;
2252 funcexe.partial = partial;
2253 funcexe.selfdict = selfdict;
2254 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2255 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002256
Bram Moolenaare38eab22019-12-05 21:50:01 +01002257 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002258 while (argc > 0)
2259 clear_tv(&argv[--argc]);
2260
2261 return r;
2262}
2263
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002264static int callback_depth = 0;
2265
2266 int
2267get_callback_depth(void)
2268{
2269 return callback_depth;
2270}
2271
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002272/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002273 * Invoke call_func() with a callback.
2274 */
2275 int
2276call_callback(
2277 callback_T *callback,
2278 int len, // length of "name" or -1 to use strlen()
2279 typval_T *rettv, // return value goes here
2280 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002281 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002282 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002283{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002284 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002285 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002286
Bram Moolenaara80faa82020-04-12 19:37:17 +02002287 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002288 funcexe.evaluate = TRUE;
2289 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002290 ++callback_depth;
2291 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2292 --callback_depth;
2293 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002294}
2295
2296/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002297 * Give an error message for the result of a function.
2298 * Nothing if "error" is FCERR_NONE.
2299 */
2300 void
2301user_func_error(int error, char_u *name)
2302{
2303 switch (error)
2304 {
2305 case FCERR_UNKNOWN:
2306 emsg_funcname(e_unknownfunc, name);
2307 break;
2308 case FCERR_NOTMETHOD:
2309 emsg_funcname(
2310 N_("E276: Cannot use function as a method: %s"), name);
2311 break;
2312 case FCERR_DELETED:
2313 emsg_funcname(N_(e_func_deleted), name);
2314 break;
2315 case FCERR_TOOMANY:
2316 emsg_funcname((char *)e_toomanyarg, name);
2317 break;
2318 case FCERR_TOOFEW:
2319 emsg_funcname((char *)e_toofewarg, name);
2320 break;
2321 case FCERR_SCRIPT:
2322 emsg_funcname(
2323 N_("E120: Using <SID> not in a script context: %s"), name);
2324 break;
2325 case FCERR_DICT:
2326 emsg_funcname(
2327 N_("E725: Calling dict function without Dictionary: %s"),
2328 name);
2329 break;
2330 }
2331}
2332
2333/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002334 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002335 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 * Return FAIL when the function can't be called, OK otherwise.
2337 * Also returns OK when an error was encountered while executing the function.
2338 */
2339 int
2340call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002341 char_u *funcname, // name of the function
2342 int len, // length of "name" or -1 to use strlen()
2343 typval_T *rettv, // return value goes here
2344 int argcount_in, // number of "argvars"
2345 typval_T *argvars_in, // vars for arguments, must have "argcount"
2346 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002347 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348{
2349 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002350 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002352 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 char_u fname_buf[FLEN_FIXED + 1];
2354 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002355 char_u *fname = NULL;
2356 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002357 int argcount = argcount_in;
2358 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002359 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002360 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2361 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002363 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002364 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002365
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002366 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2367 // even when call_func() returns FAIL.
2368 rettv->v_type = VAR_UNKNOWN;
2369
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002370 if (partial != NULL)
2371 fp = partial->pt_func;
2372 if (fp == NULL)
2373 {
2374 // Make a copy of the name, if it comes from a funcref variable it
2375 // could be changed or deleted in the called function.
2376 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2377 if (name == NULL)
2378 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002380 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2381 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002383 if (funcexe->doesrange != NULL)
2384 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385
2386 if (partial != NULL)
2387 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002388 // When the function has a partial with a dict and there is a dict
2389 // argument, use the dict argument. That is backwards compatible.
2390 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002391 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002393 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394 {
2395 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002396 {
2397 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2398 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002399 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002400 goto theend;
2401 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002402 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 for (i = 0; i < argcount_in; ++i)
2405 argv[i + argv_clear] = argvars_in[i];
2406 argvars = argv;
2407 argcount = partial->pt_argc + argcount_in;
2408 }
2409 }
2410
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002411 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2412 {
2413 // Check that the argument types are OK for the types of the funcref.
2414 if (check_argument_types(funcexe->check_type, argvars, argcount,
2415 name) == FAIL)
2416 error = FCERR_OTHER;
2417 }
2418
Bram Moolenaaref140542019-12-31 21:27:13 +01002419 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420 {
2421 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002422 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423
Bram Moolenaar333894b2020-08-01 18:53:07 +02002424 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002425 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002426 {
2427 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002428 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430
Bram Moolenaare38eab22019-12-05 21:50:01 +01002431 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002433 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002435 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436 {
2437 /*
2438 * User defined function.
2439 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002440 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002441 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442
Bram Moolenaare38eab22019-12-05 21:50:01 +01002443 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444 if (fp == NULL
2445 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002446 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 && !aborting())
2448 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002449 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002450 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002452 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2454 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002455 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002456 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002458 if (fp == NULL)
2459 {
2460 char_u *p = untrans_function_name(rfname);
2461
2462 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002463 // Don't do this if the name starts with "s:".
2464 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002465 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002468 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002469 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002470#ifdef FEAT_LUA
2471 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2472 {
2473 cfunc_T cb = fp->uf_cb;
2474
2475 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2476 }
2477#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002478 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002480 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002481 // postponed filling in the arguments, do it now
2482 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002483 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002484
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002485 if (funcexe->basetv != NULL)
2486 {
2487 // Method call: base->Method()
2488 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2489 argv[0] = *funcexe->basetv;
2490 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002491 argvars = argv;
2492 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002493 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002494
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002495 error = call_user_func_check(fp, argcount, argvars, rettv,
2496 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 }
2498 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002499 else if (funcexe->basetv != NULL)
2500 {
2501 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002502 * expr->method(): Find the method name in the table, call its
2503 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002504 */
2505 error = call_internal_method(fname, argcount, argvars, rettv,
2506 funcexe->basetv);
2507 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002508 else
2509 {
2510 /*
2511 * Find the function name in the table, call its implementation.
2512 */
2513 error = call_internal_func(fname, argcount, argvars, rettv);
2514 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002515
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 /*
2517 * The function call (or "FuncUndefined" autocommand sequence) might
2518 * have been aborted by an error, an interrupt, or an explicitly thrown
2519 * exception that has not been caught so far. This situation can be
2520 * tested for by calling aborting(). For an error in an internal
2521 * function or for the "E132" error in call_user_func(), however, the
2522 * throw point at which the "force_abort" flag (temporarily reset by
2523 * emsg()) is normally updated has not been reached yet. We need to
2524 * update that flag first to make aborting() reliable.
2525 */
2526 update_force_abort();
2527 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002528 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 ret = OK;
2530
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002531theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532 /*
2533 * Report an error unless the argument evaluation or function call has been
2534 * cancelled due to an aborting error, an interrupt, or an exception.
2535 */
2536 if (!aborting())
2537 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002538 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 }
2540
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002541 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002543 clear_tv(&argv[--argv_clear + argv_base]);
2544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002545 vim_free(tofree);
2546 vim_free(name);
2547
2548 return ret;
2549}
2550
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002551 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002552printable_func_name(ufunc_T *fp)
2553{
2554 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2555}
2556
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002558 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 */
2560 static void
2561list_func_head(ufunc_T *fp, int indent)
2562{
2563 int j;
2564
2565 msg_start();
2566 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002567 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002568 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002569 msg_puts("def ");
2570 else
2571 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002572 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 msg_putchar('(');
2574 for (j = 0; j < fp->uf_args.ga_len; ++j)
2575 {
2576 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002577 msg_puts(", ");
2578 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002579 if (fp->uf_arg_types != NULL)
2580 {
2581 char *tofree;
2582
2583 msg_puts(": ");
2584 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2585 vim_free(tofree);
2586 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002587 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2588 {
2589 msg_puts(" = ");
2590 msg_puts(((char **)(fp->uf_def_args.ga_data))
2591 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2592 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002593 }
2594 if (fp->uf_varargs)
2595 {
2596 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002597 msg_puts(", ");
2598 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002599 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002600 if (fp->uf_va_name != NULL)
2601 {
2602 if (j)
2603 msg_puts(", ");
2604 msg_puts("...");
2605 msg_puts((char *)fp->uf_va_name);
2606 if (fp->uf_va_type)
2607 {
2608 char *tofree;
2609
2610 msg_puts(": ");
2611 msg_puts(type_name(fp->uf_va_type, &tofree));
2612 vim_free(tofree);
2613 }
2614 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002616
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002617 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002618 {
2619 if (fp->uf_ret_type != &t_void)
2620 {
2621 char *tofree;
2622
2623 msg_puts(": ");
2624 msg_puts(type_name(fp->uf_ret_type, &tofree));
2625 vim_free(tofree);
2626 }
2627 }
2628 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002629 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002631 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002633 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002634 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002635 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 msg_clr_eos();
2637 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002638 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639}
2640
2641/*
2642 * Get a function name, translating "<SID>" and "<SNR>".
2643 * Also handles a Funcref in a List or Dictionary.
2644 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002645 * Set "*is_global" to TRUE when the function must be global, unless
2646 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 * flags:
2648 * TFN_INT: internal function name OK
2649 * TFN_QUIET: be quiet
2650 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002651 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 * Advances "pp" to just after the function name (if no error).
2653 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002654 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655trans_function_name(
2656 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002657 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002658 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002661 partial_T **partial, // return: partial of a FuncRef
2662 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663{
2664 char_u *name = NULL;
2665 char_u *start;
2666 char_u *end;
2667 int lead;
2668 char_u sid_buf[20];
2669 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002670 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002671 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002672 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002673 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674
2675 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002676 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 start = *pp;
2678
Bram Moolenaare38eab22019-12-05 21:50:01 +01002679 // Check for hard coded <SNR>: already translated function ID (from a user
2680 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2682 && (*pp)[2] == (int)KE_SNR)
2683 {
2684 *pp += 3;
2685 len = get_id_len(pp) + 3;
2686 return vim_strnsave(start, len);
2687 }
2688
Bram Moolenaare38eab22019-12-05 21:50:01 +01002689 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2690 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 lead = eval_fname_script(start);
2692 if (lead > 2)
2693 start += lead;
2694
Bram Moolenaare38eab22019-12-05 21:50:01 +01002695 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002696 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 lead > 2 ? 0 : FNE_CHECK_START);
2698 if (end == start)
2699 {
2700 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002701 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 goto theend;
2703 }
2704 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2705 {
2706 /*
2707 * Report an invalid expression in braces, unless the expression
2708 * evaluation has been cancelled due to an aborting error, an
2709 * interrupt, or an exception.
2710 */
2711 if (!aborting())
2712 {
2713 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002714 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 }
2716 else
2717 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2718 goto theend;
2719 }
2720
2721 if (lv.ll_tv != NULL)
2722 {
2723 if (fdp != NULL)
2724 {
2725 fdp->fd_dict = lv.ll_dict;
2726 fdp->fd_newkey = lv.ll_newkey;
2727 lv.ll_newkey = NULL;
2728 fdp->fd_di = lv.ll_di;
2729 }
2730 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2731 {
2732 name = vim_strsave(lv.ll_tv->vval.v_string);
2733 *pp = end;
2734 }
2735 else if (lv.ll_tv->v_type == VAR_PARTIAL
2736 && lv.ll_tv->vval.v_partial != NULL)
2737 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002738 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 *pp = end;
2740 if (partial != NULL)
2741 *partial = lv.ll_tv->vval.v_partial;
2742 }
2743 else
2744 {
2745 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2746 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002747 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 else
2749 *pp = end;
2750 name = NULL;
2751 }
2752 goto theend;
2753 }
2754
2755 if (lv.ll_name == NULL)
2756 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002757 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 *pp = end;
2759 goto theend;
2760 }
2761
Bram Moolenaare38eab22019-12-05 21:50:01 +01002762 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 if (lv.ll_exp_name != NULL)
2764 {
2765 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002766 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 flags & TFN_NO_AUTOLOAD);
2768 if (name == lv.ll_exp_name)
2769 name = NULL;
2770 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002771 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 {
2773 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002774 name = deref_func_name(*pp, &len, partial, type,
2775 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 if (name == *pp)
2777 name = NULL;
2778 }
2779 if (name != NULL)
2780 {
2781 name = vim_strsave(name);
2782 *pp = end;
2783 if (STRNCMP(name, "<SNR>", 5) == 0)
2784 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002785 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 name[0] = K_SPECIAL;
2787 name[1] = KS_EXTRA;
2788 name[2] = (int)KE_SNR;
2789 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2790 }
2791 goto theend;
2792 }
2793
2794 if (lv.ll_exp_name != NULL)
2795 {
2796 len = (int)STRLEN(lv.ll_exp_name);
2797 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2798 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2799 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002800 // When there was "s:" already or the name expanded to get a
2801 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 lv.ll_name += 2;
2803 len -= 2;
2804 lead = 2;
2805 }
2806 }
2807 else
2808 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002809 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002811 {
2812 if (is_global != NULL && lv.ll_name[0] == 'g')
2813 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002815 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 len = (int)(end - lv.ll_name);
2817 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002818 if (len <= 0)
2819 {
2820 if (!skip)
2821 emsg(_(e_function_name));
2822 goto theend;
2823 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002825 // In Vim9 script a user function is script-local by default, unless it
2826 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002827 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002828 if (vim9script)
2829 {
2830 char_u *p;
2831
2832 // SomeScript#func() is a global function.
2833 for (p = start; *p != NUL && *p != '('; ++p)
2834 if (*p == AUTOLOAD_CHAR)
2835 vim9script = FALSE;
2836 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002837
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 /*
2839 * Copy the function name to allocated memory.
2840 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2841 * Accept <SNR>123_name() outside a script.
2842 */
2843 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002844 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002845 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002846 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002847 if (!vim9script)
2848 lead = 3;
2849 if (vim9script || (lv.ll_exp_name != NULL
2850 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002851 || eval_fname_sid(*pp))
2852 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002853 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002854 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002856 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 goto theend;
2858 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002859 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002860 if (vim9script)
2861 extra = 3 + (int)STRLEN(sid_buf);
2862 else
2863 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 }
2865 }
2866 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2867 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002868 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 start);
2870 goto theend;
2871 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002872 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 {
2874 char_u *cp = vim_strchr(lv.ll_name, ':');
2875
2876 if (cp != NULL && cp < end)
2877 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002878 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002879 goto theend;
2880 }
2881 }
2882
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002883 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884 if (name != NULL)
2885 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002886 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 {
2888 name[0] = K_SPECIAL;
2889 name[1] = KS_EXTRA;
2890 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002891 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892 STRCPY(name + 3, sid_buf);
2893 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002894 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2895 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 }
2897 *pp = end;
2898
2899theend:
2900 clear_lval(&lv);
2901 return name;
2902}
2903
2904/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002905 * Assuming "name" is the result of trans_function_name() and it was prefixed
2906 * to use the script-local name, return the unmodified name (points into
2907 * "name"). Otherwise return NULL.
2908 * This can be used to first search for a script-local function and fall back
2909 * to the global function if not found.
2910 */
2911 char_u *
2912untrans_function_name(char_u *name)
2913{
2914 char_u *p;
2915
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002916 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002917 {
2918 p = vim_strchr(name, '_');
2919 if (p != NULL)
2920 return p + 1;
2921 }
2922 return NULL;
2923}
2924
2925/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002926 * List functions. When "regmatch" is NULL all of then.
2927 * Otherwise functions matching "regmatch".
2928 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002929 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002930list_functions(regmatch_T *regmatch)
2931{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002932 int changed = func_hashtab.ht_changed;
2933 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002934 hashitem_T *hi;
2935
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002936 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002937 {
2938 if (!HASHITEM_EMPTY(hi))
2939 {
2940 ufunc_T *fp = HI2UF(hi);
2941
2942 --todo;
2943 if ((fp->uf_flags & FC_DEAD) == 0
2944 && (regmatch == NULL
2945 ? !message_filtered(fp->uf_name)
2946 && !func_name_refcount(fp->uf_name)
2947 : !isdigit(*fp->uf_name)
2948 && vim_regexec(regmatch, fp->uf_name, 0)))
2949 {
2950 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002951 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002952 {
2953 emsg(_("E454: function list was modified"));
2954 return;
2955 }
2956 }
2957 }
2958 }
2959}
2960
2961/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002962 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2963 * return TRUE.
2964 * Otherwise return FALSE;
2965 * Do not consider "function(" to be a command.
2966 */
2967 static int
2968is_function_cmd(char_u **cmd)
2969{
2970 char_u *p = *cmd;
2971
2972 if (checkforcmd(&p, "function", 2))
2973 {
2974 if (*p == '(')
2975 return FALSE;
2976 *cmd = p;
2977 return TRUE;
2978 }
2979 return FALSE;
2980}
2981
2982/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002983 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002984 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2985 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002986 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002987 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002988 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002989define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002990{
2991 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002992 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993 int j;
2994 int c;
2995 int saved_did_emsg;
2996 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002997 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002998 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002999 char_u *p;
3000 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003001 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 char_u *line_arg = NULL;
3003 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003004 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003005 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 garray_T newlines;
3007 int varargs = FALSE;
3008 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003009 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003010 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003011 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 int indent;
3013 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003014#define MAX_FUNC_NESTING 50
3015 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 dictitem_T *v;
3017 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003018 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003021 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003022 linenr_T sourcing_lnum_off;
3023 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003024 int is_heredoc = FALSE;
3025 char_u *skip_until = NULL;
3026 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003027 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003028 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029
3030 /*
3031 * ":function" without argument: list functions.
3032 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003033 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 {
3035 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003036 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003037 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003038 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 }
3040
3041 /*
3042 * ":function /pat": list functions matching pattern.
3043 */
3044 if (*eap->arg == '/')
3045 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003046 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 if (!eap->skip)
3048 {
3049 regmatch_T regmatch;
3050
3051 c = *p;
3052 *p = NUL;
3053 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3054 *p = c;
3055 if (regmatch.regprog != NULL)
3056 {
3057 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003058 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 vim_regfree(regmatch.regprog);
3060 }
3061 }
3062 if (*p == '/')
3063 ++p;
3064 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003065 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 }
3067
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003068 ga_init(&newargs);
3069 ga_init(&argtypes);
3070 ga_init(&default_args);
3071
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003072 /*
3073 * Get the function name. There are these situations:
3074 * func normal function name
3075 * "name" == func, "fudi.fd_dict" == NULL
3076 * dict.func new dictionary entry
3077 * "name" == NULL, "fudi.fd_dict" set,
3078 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3079 * dict.func existing dict entry with a Funcref
3080 * "name" == func, "fudi.fd_dict" set,
3081 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3082 * dict.func existing dict entry that's not a Funcref
3083 * "name" == NULL, "fudi.fd_dict" set,
3084 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3085 * s:func script-local function name
3086 * g:func global function name, same as "func"
3087 */
3088 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003089 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003090 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003091 // nested function, argument is (args).
3092 paren = TRUE;
3093 CLEAR_FIELD(fudi);
3094 }
3095 else
3096 {
3097 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003098 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003099 paren = (vim_strchr(p, '(') != NULL);
3100 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003102 /*
3103 * Return on an invalid expression in braces, unless the expression
3104 * evaluation has been cancelled due to an aborting error, an
3105 * interrupt, or an exception.
3106 */
3107 if (!aborting())
3108 {
3109 if (!eap->skip && fudi.fd_newkey != NULL)
3110 semsg(_(e_dictkey), fudi.fd_newkey);
3111 vim_free(fudi.fd_newkey);
3112 return NULL;
3113 }
3114 else
3115 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117 }
3118
Bram Moolenaare38eab22019-12-05 21:50:01 +01003119 // An error in a function call during evaluation of an expression in magic
3120 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121 saved_did_emsg = did_emsg;
3122 did_emsg = FALSE;
3123
3124 /*
3125 * ":function func" with only function name: list function.
3126 */
3127 if (!paren)
3128 {
3129 if (!ends_excmd(*skipwhite(p)))
3130 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003131 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132 goto ret_free;
3133 }
3134 eap->nextcmd = check_nextcmd(p);
3135 if (eap->nextcmd != NULL)
3136 *p = NUL;
3137 if (!eap->skip && !got_int)
3138 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003139 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003140 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3141 {
3142 char_u *up = untrans_function_name(name);
3143
3144 // With Vim9 script the name was made script-local, if not
3145 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003146 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003147 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003148 }
3149
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003150 if (fp != NULL)
3151 {
3152 list_func_head(fp, TRUE);
3153 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3154 {
3155 if (FUNCLINE(fp, j) == NULL)
3156 continue;
3157 msg_putchar('\n');
3158 msg_outnum((long)(j + 1));
3159 if (j < 9)
3160 msg_putchar(' ');
3161 if (j < 99)
3162 msg_putchar(' ');
3163 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003164 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 ui_breakcheck();
3166 }
3167 if (!got_int)
3168 {
3169 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003170 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003171 msg_puts(" enddef");
3172 else
3173 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 }
3175 }
3176 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003177 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 }
3179 goto ret_free;
3180 }
3181
3182 /*
3183 * ":function name(arg1, arg2)" Define function.
3184 */
3185 p = skipwhite(p);
3186 if (*p != '(')
3187 {
3188 if (!eap->skip)
3189 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003190 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191 goto ret_free;
3192 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003193 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 if (vim_strchr(p, '(') != NULL)
3195 p = vim_strchr(p, '(');
3196 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003197
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003198 // In Vim9 script only global functions can be redefined.
3199 if (vim9script && eap->forceit && !is_global)
3200 {
3201 emsg(_(e_nobang));
3202 goto ret_free;
3203 }
3204
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003205 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3206
Bram Moolenaar04b12692020-05-04 23:24:44 +02003207 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003209 // Check the name of the function. Unless it's a dictionary function
3210 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 if (name != NULL)
3212 arg = name;
3213 else
3214 arg = fudi.fd_newkey;
3215 if (arg != NULL && (fudi.fd_di == NULL
3216 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3217 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3218 {
3219 if (*arg == K_SPECIAL)
3220 j = 3;
3221 else
3222 j = 0;
3223 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3224 : eval_isnamec(arg[j])))
3225 ++j;
3226 if (arg[j] != NUL)
3227 emsg_funcname((char *)e_invarg2, arg);
3228 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003231 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 }
3233
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003234 // This may get more lines and make the pointers into the first line
3235 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003236 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003237 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003238 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003239 &varargs, &default_args, eap->skip,
3240 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003242 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003244 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003246 // find the return type: :def Func(): type
3247 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003249 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003250 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003252 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003253 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003254 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003256 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003257 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003258 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003259 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003260 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003261 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003262 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003263 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003265 else
3266 // find extra arguments "range", "dict", "abort" and "closure"
3267 for (;;)
3268 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003269 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 p = skipwhite(p);
3271 if (STRNCMP(p, "range", 5) == 0)
3272 {
3273 flags |= FC_RANGE;
3274 p += 5;
3275 }
3276 else if (STRNCMP(p, "dict", 4) == 0)
3277 {
3278 flags |= FC_DICT;
3279 p += 4;
3280 }
3281 else if (STRNCMP(p, "abort", 5) == 0)
3282 {
3283 flags |= FC_ABORT;
3284 p += 5;
3285 }
3286 else if (STRNCMP(p, "closure", 7) == 0)
3287 {
3288 flags |= FC_CLOSURE;
3289 p += 7;
3290 if (current_funccal == NULL)
3291 {
3292 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3293 name == NULL ? (char_u *)"" : name);
3294 goto erret;
3295 }
3296 }
3297 else
3298 break;
3299 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003300
Bram Moolenaare38eab22019-12-05 21:50:01 +01003301 // When there is a line break use what follows for the function body.
3302 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 if (*p == '\n')
3304 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003305 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003306 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3307 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003308 && !(VIM_ISWHITE(*whitep) && *p == '#'
3309 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003310 && !eap->skip
3311 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003312 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313
3314 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003315 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3316 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317 */
3318 if (KeyTyped)
3319 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003320 // Check if the function already exists, don't let the user type the
3321 // whole function before telling him it doesn't work! For a script we
3322 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323 if (!eap->skip && !eap->forceit)
3324 {
3325 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003326 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003327 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328 emsg_funcname(e_funcexts, name);
3329 }
3330
3331 if (!eap->skip && did_emsg)
3332 goto erret;
3333
Bram Moolenaare38eab22019-12-05 21:50:01 +01003334 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 cmdline_row = msg_row;
3336 }
3337
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003338 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003339 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003340
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003341 // Detect having skipped over comment lines to find the return
3342 // type. Add NULL lines to keep the line count correct.
3343 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3344 if (SOURCING_LNUM < sourcing_lnum_off)
3345 {
3346 sourcing_lnum_off -= SOURCING_LNUM;
3347 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3348 goto erret;
3349 while (sourcing_lnum_off-- > 0)
3350 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3351 }
3352
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 indent = 2;
3354 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003355 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003356 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003357 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 for (;;)
3359 {
3360 if (KeyTyped)
3361 {
3362 msg_scroll = TRUE;
3363 saved_wait_return = FALSE;
3364 }
3365 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366
3367 if (line_arg != NULL)
3368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 theline = line_arg;
3371 p = vim_strchr(theline, '\n');
3372 if (p == NULL)
3373 line_arg += STRLEN(line_arg);
3374 else
3375 {
3376 *p = NUL;
3377 line_arg = p + 1;
3378 }
3379 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003381 {
3382 vim_free(line_to_free);
3383 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003384 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003385 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003386 theline = eap->getline(':', eap->cookie, indent,
3387 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003388 line_to_free = theline;
3389 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 if (KeyTyped)
3391 lines_left = Rows - 1;
3392 if (theline == NULL)
3393 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003394 // Use the start of the function for the line number.
3395 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003396 if (skip_until != NULL)
3397 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3398 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003399 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003400 else
3401 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402 goto erret;
3403 }
3404
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003405 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003406 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003407 if (SOURCING_LNUM < sourcing_lnum_off)
3408 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 else
3410 sourcing_lnum_off = 0;
3411
3412 if (skip_until != NULL)
3413 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003414 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003415 // * ":append" and "."
3416 // * ":python <<EOF" and "EOF"
3417 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3418 if (heredoc_trimmed == NULL
3419 || (is_heredoc && skipwhite(theline) == theline)
3420 || STRNCMP(theline, heredoc_trimmed,
3421 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003422 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003423 if (heredoc_trimmed == NULL)
3424 p = theline;
3425 else if (is_heredoc)
3426 p = skipwhite(theline) == theline
3427 ? theline : theline + STRLEN(heredoc_trimmed);
3428 else
3429 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003430 if (STRCMP(p, skip_until) == 0)
3431 {
3432 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003433 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003434 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003435 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003436 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003437 }
3438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 }
3440 else
3441 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003443 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 ;
3445
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003446 // Check for "endfunction" or "enddef".
3447 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003448 ? "enddef" : "endfunction", 4))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003450 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003451 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003452 char_u *nextcmd = NULL;
3453
3454 if (*p == '|')
3455 nextcmd = p + 1;
3456 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3457 nextcmd = line_arg;
3458 else if (*p != NUL && *p != '"' && p_verbose > 0)
3459 give_warning2(eap->cmdidx == CMD_def
3460 ? (char_u *)_("W1001: Text found after :enddef: %s")
3461 : (char_u *)_("W22: Text found after :endfunction: %s"),
3462 p, TRUE);
3463 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003464 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003465 // Another command follows. If the line came from "eap"
3466 // we can simply point into it, otherwise we need to
3467 // change "eap->cmdlinep".
3468 eap->nextcmd = nextcmd;
3469 if (line_to_free != NULL)
3470 {
3471 vim_free(*eap->cmdlinep);
3472 *eap->cmdlinep = line_to_free;
3473 line_to_free = NULL;
3474 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003475 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003476 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003477 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 }
3479
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003480 // Check for mismatched "endfunc" or "enddef".
3481 // We don't check for "def" inside "func" thus we also can't check
3482 // for "enddef".
3483 // We continue to find the end of the function, although we might
3484 // not find it.
3485 else if (nesting_def[nesting])
3486 {
3487 if (checkforcmd(&p, "endfunction", 4))
3488 emsg(_(e_mismatched_endfunction));
3489 }
3490 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3491 emsg(_(e_mismatched_enddef));
3492
Bram Moolenaare38eab22019-12-05 21:50:01 +01003493 // Increase indent inside "if", "while", "for" and "try", decrease
3494 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003495 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 indent -= 2;
3497 else if (STRNCMP(p, "if", 2) == 0
3498 || STRNCMP(p, "wh", 2) == 0
3499 || STRNCMP(p, "for", 3) == 0
3500 || STRNCMP(p, "try", 3) == 0)
3501 indent += 2;
3502
Bram Moolenaare38eab22019-12-05 21:50:01 +01003503 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003504 // Only recognize "def" inside "def", not inside "function",
3505 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003506 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003507 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003508 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 {
3510 if (*p == '!')
3511 p = skipwhite(p + 1);
3512 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003513 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3514 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 if (*skipwhite(p) == '(')
3516 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003517 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003518 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003519 else
3520 {
3521 ++nesting;
3522 nesting_def[nesting] = (c == 'd');
3523 indent += 2;
3524 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003525 }
3526 }
3527
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003528 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003529 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003530 if (eap->cmdidx != CMD_def
3531 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003532 || (p[0] == 'c'
3533 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3534 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3535 && (STRNCMP(&p[3], "nge", 3) != 0
3536 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537 || (p[0] == 'i'
3538 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003539 && (!ASCII_ISALPHA(p[2])
3540 || (p[2] == 's'
3541 && (!ASCII_ISALPHA(p[3])
3542 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 skip_until = vim_strsave((char_u *)".");
3544
Bram Moolenaare38eab22019-12-05 21:50:01 +01003545 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 arg = skipwhite(skiptowhite(p));
3547 if (arg[0] == '<' && arg[1] =='<'
3548 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003549 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3550 || ((p[2] == '3' || p[2] == 'x')
3551 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 || (p[0] == 'p' && p[1] == 'e'
3553 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3554 || (p[0] == 't' && p[1] == 'c'
3555 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3556 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3557 && !ASCII_ISALPHA(p[3]))
3558 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3559 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3560 || (p[0] == 'm' && p[1] == 'z'
3561 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3562 ))
3563 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003564 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003566 if (STRNCMP(p, "trim", 4) == 0)
3567 {
3568 // Ignore leading white space.
3569 p = skipwhite(p + 4);
3570 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003571 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003572 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 if (*p == NUL)
3574 skip_until = vim_strsave((char_u *)".");
3575 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003576 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003577 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003578 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003580
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003581 // Check for ":cmd v =<< [trim] EOF"
3582 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003583 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003584 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003585 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003586 if (*arg == '[')
3587 arg = vim_strchr(arg, ']');
3588 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003589 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003590 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3591 && arg[1] == '<' && arg[2] =='<');
3592
3593 if (!found)
3594 // skip over the argument after "cmd"
3595 arg = skipwhite(skiptowhite(arg));
3596 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003597 && (checkforcmd(&p, "let", 2)
3598 || checkforcmd(&p, "var", 3)
3599 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003600 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003601 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003602 p = skipwhite(arg + 3);
3603 if (STRNCMP(p, "trim", 4) == 0)
3604 {
3605 // Ignore leading white space.
3606 p = skipwhite(p + 4);
3607 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003608 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003609 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003610 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003611 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003612 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003613 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003614 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003615 }
3616
Bram Moolenaare38eab22019-12-05 21:50:01 +01003617 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620
Bram Moolenaare38eab22019-12-05 21:50:01 +01003621 // Copy the line to newly allocated memory. get_one_sourceline()
3622 // allocates 250 bytes per line, this saves 80% on average. The cost
3623 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003625 if (p == NULL)
3626 goto erret;
3627 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628
Bram Moolenaare38eab22019-12-05 21:50:01 +01003629 // Add NULL lines for continuation lines, so that the line count is
3630 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 while (sourcing_lnum_off-- > 0)
3632 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3633
Bram Moolenaare38eab22019-12-05 21:50:01 +01003634 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 if (line_arg != NULL && *line_arg == NUL)
3636 line_arg = NULL;
3637 }
3638
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // Don't define the function when skipping commands or when an error was
3640 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 if (eap->skip || did_emsg)
3642 goto erret;
3643
3644 /*
3645 * If there are no errors, add the function
3646 */
3647 if (fudi.fd_dict == NULL)
3648 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003649 hashtab_T *ht;
3650
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003651 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3653 {
3654 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3655 name);
3656 goto erret;
3657 }
3658
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003659 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003660 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003662 char_u *uname = untrans_function_name(name);
3663
3664 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3665 }
3666
3667 if (fp != NULL || import != NULL)
3668 {
3669 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003670
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003671 // Function can be replaced with "function!" and when sourcing the
3672 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003673 // A name that is used by an import can not be overruled.
3674 if (import != NULL
3675 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003676 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003677 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003679 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003680 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003681 else
3682 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 goto erret;
3684 }
3685 if (fp->uf_calls > 0)
3686 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003687 emsg_funcname(
3688 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 name);
3690 goto erret;
3691 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003692 if (fp->uf_refcount > 1)
3693 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003694 // This function is referenced somewhere, don't redefine it but
3695 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003696 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003697 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003698 fp = NULL;
3699 overwrite = TRUE;
3700 }
3701 else
3702 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003703 char_u *exp_name = fp->uf_name_exp;
3704
3705 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003706 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003707 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003708 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003709 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003710 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003711#ifdef FEAT_PROFILE
3712 fp->uf_profiling = FALSE;
3713 fp->uf_prof_initialized = FALSE;
3714#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003715 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003716 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 }
3718 }
3719 else
3720 {
3721 char numbuf[20];
3722
3723 fp = NULL;
3724 if (fudi.fd_newkey == NULL && !eap->forceit)
3725 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003726 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 goto erret;
3728 }
3729 if (fudi.fd_di == NULL)
3730 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003731 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003732 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 goto erret;
3734 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003735 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003736 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 goto erret;
3738
Bram Moolenaare38eab22019-12-05 21:50:01 +01003739 // Give the function a sequential number. Can only be used with a
3740 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 vim_free(name);
3742 sprintf(numbuf, "%d", ++func_nr);
3743 name = vim_strsave((char_u *)numbuf);
3744 if (name == NULL)
3745 goto erret;
3746 }
3747
3748 if (fp == NULL)
3749 {
3750 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3751 {
3752 int slen, plen;
3753 char_u *scriptname;
3754
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003757 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 {
3759 scriptname = autoload_name(name);
3760 if (scriptname != NULL)
3761 {
3762 p = vim_strchr(scriptname, '/');
3763 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003764 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003766 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 j = OK;
3768 vim_free(scriptname);
3769 }
3770 }
3771 if (j == FAIL)
3772 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003773 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 goto erret;
3775 }
3776 }
3777
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003778 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779 if (fp == NULL)
3780 goto erret;
3781
3782 if (fudi.fd_dict != NULL)
3783 {
3784 if (fudi.fd_di == NULL)
3785 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003786 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3788 if (fudi.fd_di == NULL)
3789 {
3790 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003791 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 goto erret;
3793 }
3794 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3795 {
3796 vim_free(fudi.fd_di);
3797 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003798 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 goto erret;
3800 }
3801 }
3802 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003803 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 clear_tv(&fudi.fd_di->di_tv);
3805 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807
Bram Moolenaare38eab22019-12-05 21:50:01 +01003808 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 flags |= FC_DICT;
3810 }
3811
Bram Moolenaare38eab22019-12-05 21:50:01 +01003812 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003813 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003814 if (overwrite)
3815 {
3816 hi = hash_find(&func_hashtab, name);
3817 hi->hi_key = UF2HIKEY(fp);
3818 }
3819 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 {
3821 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003822 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 goto erret;
3824 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003825 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 }
3827 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003828 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003829 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003830 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003831
3832 if (eap->cmdidx == CMD_def)
3833 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003834 int lnum_save = SOURCING_LNUM;
3835 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003836
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003837 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003838
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003839 // error messages are for the first function line
3840 SOURCING_LNUM = sourcing_lnum_top;
3841
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003842 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003843 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003844 int count = cstack->cs_idx + 1;
3845 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003846
3847 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003848 // a block that is visible now but not when the function is called
3849 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003850 fp->uf_block_ids = ALLOC_MULT(int, count);
3851 if (fp->uf_block_ids != NULL)
3852 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003853 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003854 sizeof(int) * count);
3855 fp->uf_block_depth = count;
3856 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003857
3858 // Set flag in each block to indicate a function was defined. This
3859 // is used to keep the variable when leaving the block, see
3860 // hide_script_var().
3861 for (i = 0; i <= cstack->cs_idx; ++i)
3862 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003863 }
3864
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003865 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003866 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003867 SOURCING_LNUM = lnum_save;
3868 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003869 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003870 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003871
3872 // parse the return type, if any
3873 if (ret_type == NULL)
3874 fp->uf_ret_type = &t_void;
3875 else
3876 {
3877 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003878 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003879 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003880 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003881 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003882 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003883 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003884
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003886 if ((flags & FC_CLOSURE) != 0)
3887 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003888 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003889 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003890 }
3891 else
3892 fp->uf_scoped = NULL;
3893
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 if (prof_def_func())
3896 func_do_profile(fp);
3897#endif
3898 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003899 if (sandbox)
3900 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003901 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003902 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003903 fp->uf_flags = flags;
3904 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003905 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003906 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003907 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003908 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003909 if (is_export)
3910 {
3911 fp->uf_flags |= FC_EXPORT;
3912 // let ex_export() know the export worked.
3913 is_export = FALSE;
3914 }
3915
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003916 if (eap->cmdidx == CMD_def)
3917 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003918 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3919 // :func does not use Vim9 script syntax, even in a Vim9 script file
3920 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003921
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 goto ret_free;
3923
3924erret:
3925 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003926 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927errret_2:
3928 ga_clear_strings(&newlines);
3929ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003930 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003932 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003933 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003935 if (name != name_arg)
3936 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003937 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 did_emsg |= saved_did_emsg;
3939 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003940
3941 return fp;
3942}
3943
3944/*
3945 * ":function"
3946 */
3947 void
3948ex_function(exarg_T *eap)
3949{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003950 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003951}
3952
3953/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003954 * :defcompile - compile all :def functions in the current script that need to
3955 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003956 */
3957 void
3958ex_defcompile(exarg_T *eap UNUSED)
3959{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003960 long todo = (long)func_hashtab.ht_used;
3961 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003962 hashitem_T *hi;
3963 ufunc_T *ufunc;
3964
3965 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3966 {
3967 if (!HASHITEM_EMPTY(hi))
3968 {
3969 --todo;
3970 ufunc = HI2UF(hi);
3971 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003972 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3973 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003974 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003975 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003976
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003977 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003978 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003979 // a function has been added or removed, need to start over
3980 todo = (long)func_hashtab.ht_used;
3981 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003982 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003983 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003984 }
3985 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003986 }
3987 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988}
3989
3990/*
3991 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3992 * Return 2 if "p" starts with "s:".
3993 * Return 0 otherwise.
3994 */
3995 int
3996eval_fname_script(char_u *p)
3997{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003998 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3999 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4001 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4002 return 5;
4003 if (p[0] == 's' && p[1] == ':')
4004 return 2;
4005 return 0;
4006}
4007
4008 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004009translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010{
4011 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004012 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004013 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004014}
4015
4016/*
4017 * Return TRUE when "ufunc" has old-style "..." varargs
4018 * or named varargs "...name: type".
4019 */
4020 int
4021has_varargs(ufunc_T *ufunc)
4022{
4023 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024}
4025
4026/*
4027 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004028 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 */
4030 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004031function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032{
4033 char_u *nm = name;
4034 char_u *p;
4035 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004036 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004037 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004039 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4040 if (no_deref)
4041 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004042 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 nm = skipwhite(nm);
4044
Bram Moolenaare38eab22019-12-05 21:50:01 +01004045 // Only accept "funcname", "funcname ", "funcname (..." and
4046 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004048 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049 vim_free(p);
4050 return n;
4051}
4052
Bram Moolenaar113e1072019-01-20 15:30:40 +01004053#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 char_u *
4055get_expanded_name(char_u *name, int check)
4056{
4057 char_u *nm = name;
4058 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004059 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004061 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004062 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004064 if (p != NULL && *nm == NUL
4065 && (!check || translated_function_exists(p, is_global)))
4066 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067
4068 vim_free(p);
4069 return NULL;
4070}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004071#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073/*
4074 * Function given to ExpandGeneric() to obtain the list of user defined
4075 * function names.
4076 */
4077 char_u *
4078get_user_func_name(expand_T *xp, int idx)
4079{
4080 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004081 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 static hashitem_T *hi;
4083 ufunc_T *fp;
4084
4085 if (idx == 0)
4086 {
4087 done = 0;
4088 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004089 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004091 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 {
4093 if (done++ > 0)
4094 ++hi;
4095 while (HASHITEM_EMPTY(hi))
4096 ++hi;
4097 fp = HI2UF(hi);
4098
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004099 // don't show dead, dict and lambda functions
4100 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004101 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004102 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103
4104 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004105 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106
4107 cat_func_name(IObuff, fp);
4108 if (xp->xp_context != EXPAND_USER_FUNC)
4109 {
4110 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004111 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 STRCAT(IObuff, ")");
4113 }
4114 return IObuff;
4115 }
4116 return NULL;
4117}
4118
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004119/*
4120 * ":delfunction {name}"
4121 */
4122 void
4123ex_delfunction(exarg_T *eap)
4124{
4125 ufunc_T *fp = NULL;
4126 char_u *p;
4127 char_u *name;
4128 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004129 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130
4131 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004132 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4133 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 vim_free(fudi.fd_newkey);
4135 if (name == NULL)
4136 {
4137 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004138 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 return;
4140 }
4141 if (!ends_excmd(*skipwhite(p)))
4142 {
4143 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004144 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 return;
4146 }
4147 eap->nextcmd = check_nextcmd(p);
4148 if (eap->nextcmd != NULL)
4149 *p = NUL;
4150
4151 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004152 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004153 vim_free(name);
4154
4155 if (!eap->skip)
4156 {
4157 if (fp == NULL)
4158 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004159 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004160 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161 return;
4162 }
4163 if (fp->uf_calls > 0)
4164 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004165 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166 return;
4167 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004168 if (fp->uf_flags & FC_VIM9)
4169 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004170 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004171 return;
4172 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173
4174 if (fudi.fd_dict != NULL)
4175 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004176 // Delete the dict item that refers to the function, it will
4177 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4179 }
4180 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004181 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004182 // A normal function (not a numbered function or lambda) has a
4183 // refcount of 1 for the entry in the hashtable. When deleting
4184 // it and the refcount is more than one, it should be kept.
4185 // A numbered function and lambda should be kept if the refcount is
4186 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004187 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004188 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004189 // Function is still referenced somewhere. Don't free it but
4190 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004191 if (func_remove(fp))
4192 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004193 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004194 }
4195 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004196 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004197 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004198 }
4199}
4200
4201/*
4202 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004203 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 */
4205 void
4206func_unref(char_u *name)
4207{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004208 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004210 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004212 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004213 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004216 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004218 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004220 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004222 // Only delete it when it's not being used. Otherwise it's done
4223 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004224 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004225 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004226 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004227}
4228
4229/*
4230 * Unreference a Function: decrement the reference count and free it when it
4231 * becomes zero.
4232 */
4233 void
4234func_ptr_unref(ufunc_T *fp)
4235{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004236 if (fp != NULL && --fp->uf_refcount <= 0)
4237 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004238 // Only delete it when it's not being used. Otherwise it's done
4239 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004240 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004241 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242 }
4243}
4244
4245/*
4246 * Count a reference to a Function.
4247 */
4248 void
4249func_ref(char_u *name)
4250{
4251 ufunc_T *fp;
4252
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004253 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004255 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004256 if (fp != NULL)
4257 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004259 // Only give an error for a numbered function.
4260 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004261 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004262}
4263
4264/*
4265 * Count a reference to a Function.
4266 */
4267 void
4268func_ptr_ref(ufunc_T *fp)
4269{
4270 if (fp != NULL)
4271 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272}
4273
4274/*
4275 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4276 * referenced from anywhere that is in use.
4277 */
4278 static int
4279can_free_funccal(funccall_T *fc, int copyID)
4280{
4281 return (fc->l_varlist.lv_copyID != copyID
4282 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004283 && fc->l_avars.dv_copyID != copyID
4284 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285}
4286
4287/*
4288 * ":return [expr]"
4289 */
4290 void
4291ex_return(exarg_T *eap)
4292{
4293 char_u *arg = eap->arg;
4294 typval_T rettv;
4295 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004296 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297
4298 if (current_funccal == NULL)
4299 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004300 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 return;
4302 }
4303
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004304 CLEAR_FIELD(evalarg);
4305 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4306
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 if (eap->skip)
4308 ++emsg_skip;
4309
4310 eap->nextcmd = NULL;
4311 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004312 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 {
4314 if (!eap->skip)
4315 returning = do_return(eap, FALSE, TRUE, &rettv);
4316 else
4317 clear_tv(&rettv);
4318 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004319 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320 else if (!eap->skip)
4321 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004322 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004323 update_force_abort();
4324
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 /*
4326 * Return unless the expression evaluation has been cancelled due to an
4327 * aborting error, an interrupt, or an exception.
4328 */
4329 if (!aborting())
4330 returning = do_return(eap, FALSE, TRUE, NULL);
4331 }
4332
Bram Moolenaare38eab22019-12-05 21:50:01 +01004333 // When skipping or the return gets pending, advance to the next command
4334 // in this line (!returning). Otherwise, ignore the rest of the line.
4335 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336 if (returning)
4337 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004338 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004339 eap->nextcmd = check_nextcmd(arg);
4340
4341 if (eap->skip)
4342 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004343 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344}
4345
4346/*
4347 * ":1,25call func(arg1, arg2)" function call.
4348 */
4349 void
4350ex_call(exarg_T *eap)
4351{
4352 char_u *arg = eap->arg;
4353 char_u *startarg;
4354 char_u *name;
4355 char_u *tofree;
4356 int len;
4357 typval_T rettv;
4358 linenr_T lnum;
4359 int doesrange;
4360 int failed = FALSE;
4361 funcdict_T fudi;
4362 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004363 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004364 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004365
Bram Moolenaare6b53242020-07-01 17:28:33 +02004366 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 if (eap->skip)
4368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004369 // trans_function_name() doesn't work well when skipping, use eval0()
4370 // instead to skip to any following command, e.g. for:
4371 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004373 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374 clear_tv(&rettv);
4375 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004376 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 return;
4378 }
4379
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004380 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4381 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 if (fudi.fd_newkey != NULL)
4383 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004384 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004385 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 vim_free(fudi.fd_newkey);
4387 }
4388 if (tofree == NULL)
4389 return;
4390
Bram Moolenaare38eab22019-12-05 21:50:01 +01004391 // Increase refcount on dictionary, it could get deleted when evaluating
4392 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 if (fudi.fd_dict != NULL)
4394 ++fudi.fd_dict->dv_refcount;
4395
Bram Moolenaare38eab22019-12-05 21:50:01 +01004396 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4397 // contents. For VAR_PARTIAL get its partial, unless we already have one
4398 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004400 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4401 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402
Bram Moolenaare38eab22019-12-05 21:50:01 +01004403 // Skip white space to allow ":call func ()". Not good, but required for
4404 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004406 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407
4408 if (*startarg != '(')
4409 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004410 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 goto end;
4412 }
4413
4414 /*
4415 * When skipping, evaluate the function once, to find the end of the
4416 * arguments.
4417 * When the function takes a range, this is discovered after the first
4418 * call, and the loop is broken.
4419 */
4420 if (eap->skip)
4421 {
4422 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004423 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 }
4425 else
4426 lnum = eap->line1;
4427 for ( ; lnum <= eap->line2; ++lnum)
4428 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004429 funcexe_T funcexe;
4430
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 if (!eap->skip && eap->addr_count > 0)
4432 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004433 if (lnum > curbuf->b_ml.ml_line_count)
4434 {
4435 // If the function deleted lines or switched to another buffer
4436 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004437 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004438 break;
4439 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 curwin->w_cursor.lnum = lnum;
4441 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 }
4444 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004445
Bram Moolenaara80faa82020-04-12 19:37:17 +02004446 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004447 funcexe.firstline = eap->line1;
4448 funcexe.lastline = eap->line2;
4449 funcexe.doesrange = &doesrange;
4450 funcexe.evaluate = !eap->skip;
4451 funcexe.partial = partial;
4452 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004453 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004454 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 {
4456 failed = TRUE;
4457 break;
4458 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004459 if (has_watchexpr())
4460 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004462 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004463 if (handle_subscript(&arg, &rettv,
4464 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 {
4466 failed = TRUE;
4467 break;
4468 }
4469
4470 clear_tv(&rettv);
4471 if (doesrange || eap->skip)
4472 break;
4473
Bram Moolenaare38eab22019-12-05 21:50:01 +01004474 // Stop when immediately aborting on error, or when an interrupt
4475 // occurred or an exception was thrown but not caught.
4476 // get_func_tv() returned OK, so that the check for trailing
4477 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 if (aborting())
4479 break;
4480 }
4481 if (eap->skip)
4482 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004483 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484
Bram Moolenaare51bb172020-02-16 19:42:23 +01004485 // When inside :try we need to check for following "| catch".
4486 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004488 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004489 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004490 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004492 if (!failed)
4493 {
4494 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004495 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004496 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 }
4498 else
4499 eap->nextcmd = check_nextcmd(arg);
4500 }
4501
4502end:
4503 dict_unref(fudi.fd_dict);
4504 vim_free(tofree);
4505}
4506
4507/*
4508 * Return from a function. Possibly makes the return pending. Also called
4509 * for a pending return at the ":endtry" or after returning from an extra
4510 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4511 * when called due to a ":return" command. "rettv" may point to a typval_T
4512 * with the return rettv. Returns TRUE when the return can be carried out,
4513 * FALSE when the return gets pending.
4514 */
4515 int
4516do_return(
4517 exarg_T *eap,
4518 int reanimate,
4519 int is_cmd,
4520 void *rettv)
4521{
4522 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004523 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524
4525 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004526 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004527 current_funccal->returned = FALSE;
4528
4529 /*
4530 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4531 * not in its finally clause (which then is to be executed next) is found.
4532 * In this case, make the ":return" pending for execution at the ":endtry".
4533 * Otherwise, return normally.
4534 */
4535 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4536 if (idx >= 0)
4537 {
4538 cstack->cs_pending[idx] = CSTP_RETURN;
4539
4540 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004541 // A pending return again gets pending. "rettv" points to an
4542 // allocated variable with the rettv of the original ":return"'s
4543 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004544 cstack->cs_rettv[idx] = rettv;
4545 else
4546 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004547 // When undoing a return in order to make it pending, get the stored
4548 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 if (reanimate)
4550 rettv = current_funccal->rettv;
4551
4552 if (rettv != NULL)
4553 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004554 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4556 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4557 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004558 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 }
4560 else
4561 cstack->cs_rettv[idx] = NULL;
4562
4563 if (reanimate)
4564 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004565 // The pending return value could be overwritten by a ":return"
4566 // without argument in a finally clause; reset the default
4567 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 current_funccal->rettv->v_type = VAR_NUMBER;
4569 current_funccal->rettv->vval.v_number = 0;
4570 }
4571 }
4572 report_make_pending(CSTP_RETURN, rettv);
4573 }
4574 else
4575 {
4576 current_funccal->returned = TRUE;
4577
Bram Moolenaare38eab22019-12-05 21:50:01 +01004578 // If the return is carried out now, store the return value. For
4579 // a return immediately after reanimation, the value is already
4580 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 if (!reanimate && rettv != NULL)
4582 {
4583 clear_tv(current_funccal->rettv);
4584 *current_funccal->rettv = *(typval_T *)rettv;
4585 if (!is_cmd)
4586 vim_free(rettv);
4587 }
4588 }
4589
4590 return idx < 0;
4591}
4592
4593/*
4594 * Free the variable with a pending return value.
4595 */
4596 void
4597discard_pending_return(void *rettv)
4598{
4599 free_tv((typval_T *)rettv);
4600}
4601
4602/*
4603 * Generate a return command for producing the value of "rettv". The result
4604 * is an allocated string. Used by report_pending() for verbose messages.
4605 */
4606 char_u *
4607get_return_cmd(void *rettv)
4608{
4609 char_u *s = NULL;
4610 char_u *tofree = NULL;
4611 char_u numbuf[NUMBUFLEN];
4612
4613 if (rettv != NULL)
4614 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4615 if (s == NULL)
4616 s = (char_u *)"";
4617
4618 STRCPY(IObuff, ":return ");
4619 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4620 if (STRLEN(s) + 8 >= IOSIZE)
4621 STRCPY(IObuff + IOSIZE - 4, "...");
4622 vim_free(tofree);
4623 return vim_strsave(IObuff);
4624}
4625
4626/*
4627 * Get next function line.
4628 * Called by do_cmdline() to get the next line.
4629 * Returns allocated string, or NULL for end of function.
4630 */
4631 char_u *
4632get_func_line(
4633 int c UNUSED,
4634 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004635 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004636 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637{
4638 funccall_T *fcp = (funccall_T *)cookie;
4639 ufunc_T *fp = fcp->func;
4640 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004641 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642
Bram Moolenaare38eab22019-12-05 21:50:01 +01004643 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004644 if (fcp->dbg_tick != debug_tick)
4645 {
4646 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004647 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004648 fcp->dbg_tick = debug_tick;
4649 }
4650#ifdef FEAT_PROFILE
4651 if (do_profiling == PROF_YES)
4652 func_line_end(cookie);
4653#endif
4654
4655 gap = &fp->uf_lines;
4656 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4657 || fcp->returned)
4658 retval = NULL;
4659 else
4660 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004661 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 while (fcp->linenr < gap->ga_len
4663 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4664 ++fcp->linenr;
4665 if (fcp->linenr >= gap->ga_len)
4666 retval = NULL;
4667 else
4668 {
4669 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004670 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671#ifdef FEAT_PROFILE
4672 if (do_profiling == PROF_YES)
4673 func_line_start(cookie);
4674#endif
4675 }
4676 }
4677
Bram Moolenaare38eab22019-12-05 21:50:01 +01004678 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004679 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004681 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004682 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004683 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004684 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004685 fcp->dbg_tick = debug_tick;
4686 }
4687
4688 return retval;
4689}
4690
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691/*
4692 * Return TRUE if the currently active function should be ended, because a
4693 * return was encountered or an error occurred. Used inside a ":while".
4694 */
4695 int
4696func_has_ended(void *cookie)
4697{
4698 funccall_T *fcp = (funccall_T *)cookie;
4699
Bram Moolenaare38eab22019-12-05 21:50:01 +01004700 // Ignore the "abort" flag if the abortion behavior has been changed due to
4701 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4703 || fcp->returned);
4704}
4705
4706/*
4707 * return TRUE if cookie indicates a function which "abort"s on errors.
4708 */
4709 int
4710func_has_abort(
4711 void *cookie)
4712{
4713 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4714}
4715
4716
4717/*
4718 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4719 * Don't do this when "Func" is already a partial that was bound
4720 * explicitly (pt_auto is FALSE).
4721 * Changes "rettv" in-place.
4722 * Returns the updated "selfdict_in".
4723 */
4724 dict_T *
4725make_partial(dict_T *selfdict_in, typval_T *rettv)
4726{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004727 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728 char_u *tofree = NULL;
4729 ufunc_T *fp;
4730 char_u fname_buf[FLEN_FIXED + 1];
4731 int error;
4732 dict_T *selfdict = selfdict_in;
4733
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004734 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4735 fp = rettv->vval.v_partial->pt_func;
4736 else
4737 {
4738 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4739 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004740 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004741 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004742 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004743 vim_free(tofree);
4744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745
4746 if (fp != NULL && (fp->uf_flags & FC_DICT))
4747 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004748 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749
4750 if (pt != NULL)
4751 {
4752 pt->pt_refcount = 1;
4753 pt->pt_dict = selfdict;
4754 pt->pt_auto = TRUE;
4755 selfdict = NULL;
4756 if (rettv->v_type == VAR_FUNC)
4757 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004758 // Just a function: Take over the function name and use
4759 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004760 pt->pt_name = rettv->vval.v_string;
4761 }
4762 else
4763 {
4764 partial_T *ret_pt = rettv->vval.v_partial;
4765 int i;
4766
Bram Moolenaare38eab22019-12-05 21:50:01 +01004767 // Partial: copy the function name, use selfdict and copy
4768 // args. Can't take over name or args, the partial might
4769 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004770 if (ret_pt->pt_name != NULL)
4771 {
4772 pt->pt_name = vim_strsave(ret_pt->pt_name);
4773 func_ref(pt->pt_name);
4774 }
4775 else
4776 {
4777 pt->pt_func = ret_pt->pt_func;
4778 func_ptr_ref(pt->pt_func);
4779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 if (ret_pt->pt_argc > 0)
4781 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004782 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004784 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785 pt->pt_argc = 0;
4786 else
4787 {
4788 pt->pt_argc = ret_pt->pt_argc;
4789 for (i = 0; i < pt->pt_argc; i++)
4790 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4791 }
4792 }
4793 partial_unref(ret_pt);
4794 }
4795 rettv->v_type = VAR_PARTIAL;
4796 rettv->vval.v_partial = pt;
4797 }
4798 }
4799 return selfdict;
4800}
4801
4802/*
4803 * Return the name of the executed function.
4804 */
4805 char_u *
4806func_name(void *cookie)
4807{
4808 return ((funccall_T *)cookie)->func->uf_name;
4809}
4810
4811/*
4812 * Return the address holding the next breakpoint line for a funccall cookie.
4813 */
4814 linenr_T *
4815func_breakpoint(void *cookie)
4816{
4817 return &((funccall_T *)cookie)->breakpoint;
4818}
4819
4820/*
4821 * Return the address holding the debug tick for a funccall cookie.
4822 */
4823 int *
4824func_dbg_tick(void *cookie)
4825{
4826 return &((funccall_T *)cookie)->dbg_tick;
4827}
4828
4829/*
4830 * Return the nesting level for a funccall cookie.
4831 */
4832 int
4833func_level(void *cookie)
4834{
4835 return ((funccall_T *)cookie)->level;
4836}
4837
4838/*
4839 * Return TRUE when a function was ended by a ":return" command.
4840 */
4841 int
4842current_func_returned(void)
4843{
4844 return current_funccal->returned;
4845}
4846
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 int
4848free_unref_funccal(int copyID, int testing)
4849{
4850 int did_free = FALSE;
4851 int did_free_funccal = FALSE;
4852 funccall_T *fc, **pfc;
4853
4854 for (pfc = &previous_funccal; *pfc != NULL; )
4855 {
4856 if (can_free_funccal(*pfc, copyID))
4857 {
4858 fc = *pfc;
4859 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004860 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004861 did_free = TRUE;
4862 did_free_funccal = TRUE;
4863 }
4864 else
4865 pfc = &(*pfc)->caller;
4866 }
4867 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004868 // When a funccal was freed some more items might be garbage
4869 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 (void)garbage_collect(testing);
4871
4872 return did_free;
4873}
4874
4875/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004876 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004877 */
4878 static funccall_T *
4879get_funccal(void)
4880{
4881 int i;
4882 funccall_T *funccal;
4883 funccall_T *temp_funccal;
4884
4885 funccal = current_funccal;
4886 if (debug_backtrace_level > 0)
4887 {
4888 for (i = 0; i < debug_backtrace_level; i++)
4889 {
4890 temp_funccal = funccal->caller;
4891 if (temp_funccal)
4892 funccal = temp_funccal;
4893 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004894 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895 debug_backtrace_level = i;
4896 }
4897 }
4898 return funccal;
4899}
4900
4901/*
4902 * Return the hashtable used for local variables in the current funccal.
4903 * Return NULL if there is no current funccal.
4904 */
4905 hashtab_T *
4906get_funccal_local_ht()
4907{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004908 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004909 return NULL;
4910 return &get_funccal()->l_vars.dv_hashtab;
4911}
4912
4913/*
4914 * Return the l: scope variable.
4915 * Return NULL if there is no current funccal.
4916 */
4917 dictitem_T *
4918get_funccal_local_var()
4919{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004920 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004921 return NULL;
4922 return &get_funccal()->l_vars_var;
4923}
4924
4925/*
4926 * Return the hashtable used for argument in the current funccal.
4927 * Return NULL if there is no current funccal.
4928 */
4929 hashtab_T *
4930get_funccal_args_ht()
4931{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004932 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004933 return NULL;
4934 return &get_funccal()->l_avars.dv_hashtab;
4935}
4936
4937/*
4938 * Return the a: scope variable.
4939 * Return NULL if there is no current funccal.
4940 */
4941 dictitem_T *
4942get_funccal_args_var()
4943{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004944 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004946 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004947}
4948
4949/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950 * List function variables, if there is a function.
4951 */
4952 void
4953list_func_vars(int *first)
4954{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004955 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004957 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004958}
4959
4960/*
4961 * If "ht" is the hashtable for local variables in the current funccal, return
4962 * the dict that contains it.
4963 * Otherwise return NULL.
4964 */
4965 dict_T *
4966get_current_funccal_dict(hashtab_T *ht)
4967{
4968 if (current_funccal != NULL
4969 && ht == &current_funccal->l_vars.dv_hashtab)
4970 return &current_funccal->l_vars;
4971 return NULL;
4972}
4973
4974/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004975 * Search hashitem in parent scope.
4976 */
4977 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004978find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004979{
4980 funccall_T *old_current_funccal = current_funccal;
4981 hashtab_T *ht;
4982 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004983 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004984
4985 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4986 return NULL;
4987
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004988 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004989 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004990 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004991 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004992 ht = find_var_ht(name, &varname);
4993 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004994 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004995 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004996 if (!HASHITEM_EMPTY(hi))
4997 {
4998 *pht = ht;
4999 break;
5000 }
5001 }
5002 if (current_funccal == current_funccal->func->uf_scoped)
5003 break;
5004 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005005 }
5006 current_funccal = old_current_funccal;
5007
5008 return hi;
5009}
5010
5011/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005012 * Search variable in parent scope.
5013 */
5014 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005015find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005016{
5017 dictitem_T *v = NULL;
5018 funccall_T *old_current_funccal = current_funccal;
5019 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005020 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005021
5022 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5023 return NULL;
5024
Bram Moolenaare38eab22019-12-05 21:50:01 +01005025 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005026 current_funccal = current_funccal->func->uf_scoped;
5027 while (current_funccal)
5028 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005029 ht = find_var_ht(name, &varname);
5030 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005031 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005032 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005033 if (v != NULL)
5034 break;
5035 }
5036 if (current_funccal == current_funccal->func->uf_scoped)
5037 break;
5038 current_funccal = current_funccal->func->uf_scoped;
5039 }
5040 current_funccal = old_current_funccal;
5041
5042 return v;
5043}
5044
5045/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005046 * Set "copyID + 1" in previous_funccal and callers.
5047 */
5048 int
5049set_ref_in_previous_funccal(int copyID)
5050{
5051 int abort = FALSE;
5052 funccall_T *fc;
5053
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005054 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005055 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005056 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005057 abort = abort
5058 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5059 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005060 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005061 }
5062 return abort;
5063}
5064
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005065 static int
5066set_ref_in_funccal(funccall_T *fc, int copyID)
5067{
5068 int abort = FALSE;
5069
5070 if (fc->fc_copyID != copyID)
5071 {
5072 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005073 abort = abort
5074 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5075 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005076 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005077 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005078 }
5079 return abort;
5080}
5081
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005082/*
5083 * Set "copyID" in all local vars and arguments in the call stack.
5084 */
5085 int
5086set_ref_in_call_stack(int copyID)
5087{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005088 int abort = FALSE;
5089 funccall_T *fc;
5090 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005092 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005093 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005094
5095 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005096 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5097 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005098 abort = abort || set_ref_in_funccal(fc, copyID);
5099
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005100 return abort;
5101}
5102
5103/*
5104 * Set "copyID" in all functions available by name.
5105 */
5106 int
5107set_ref_in_functions(int copyID)
5108{
5109 int todo;
5110 hashitem_T *hi = NULL;
5111 int abort = FALSE;
5112 ufunc_T *fp;
5113
5114 todo = (int)func_hashtab.ht_used;
5115 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005116 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005117 if (!HASHITEM_EMPTY(hi))
5118 {
5119 --todo;
5120 fp = HI2UF(hi);
5121 if (!func_name_refcount(fp->uf_name))
5122 abort = abort || set_ref_in_func(NULL, fp, copyID);
5123 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124 }
5125 return abort;
5126}
5127
5128/*
5129 * Set "copyID" in all function arguments.
5130 */
5131 int
5132set_ref_in_func_args(int copyID)
5133{
5134 int i;
5135 int abort = FALSE;
5136
5137 for (i = 0; i < funcargs.ga_len; ++i)
5138 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5139 copyID, NULL, NULL);
5140 return abort;
5141}
5142
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005143/*
5144 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005145 * Returns TRUE if setting references failed somehow.
5146 */
5147 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005148set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005149{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005150 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005151 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005152 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005153 char_u fname_buf[FLEN_FIXED + 1];
5154 char_u *tofree = NULL;
5155 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005156 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005157
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005158 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005159 return FALSE;
5160
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005161 if (fp_in == NULL)
5162 {
5163 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005164 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005165 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005166 if (fp != NULL)
5167 {
5168 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005169 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005170 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005171
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005172 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005173 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005174}
5175
Bram Moolenaare38eab22019-12-05 21:50:01 +01005176#endif // FEAT_EVAL