blob: 5ba90ae830881db02d03210e4ba503caf2cc65d6 [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 Moolenaar65c44152020-12-24 15:14:01 +0100157 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200158 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100159 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200160get_function_args(
161 char_u **argp,
162 char_u endchar,
163 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100164 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100165 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200166 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200167 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200168 int skip,
169 exarg_T *eap,
170 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200171{
172 int mustend = FALSE;
173 char_u *arg = *argp;
174 char_u *p = arg;
175 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200176 int any_default = FALSE;
177 char_u *expr;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200178 char_u *whitep = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200179
180 if (newargs != NULL)
181 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100182 if (argtypes != NULL)
183 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 if (default_args != NULL)
185 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200186
187 if (varargs != NULL)
188 *varargs = FALSE;
189
190 /*
191 * Isolate the arguments: "arg1, arg2, ...)"
192 */
193 while (*p != endchar)
194 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200195 while (eap != NULL && eap->getline != NULL
196 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200197 {
198 char_u *theline;
199
200 // End of the line, get the next one.
201 theline = eap->getline(':', eap->cookie, 0, TRUE);
202 if (theline == NULL)
203 break;
204 vim_free(*line_to_free);
205 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200206 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200207 p = skipwhite(theline);
208 }
209
210 if (mustend && *p != endchar)
211 {
212 if (!skip)
213 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100214 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 }
216 if (*p == endchar)
217 break;
218
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200219 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
220 {
221 if (varargs != NULL)
222 *varargs = TRUE;
223 p += 3;
224 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100225
226 if (argtypes != NULL)
227 {
228 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200229 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100230 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100231 if (!skip)
232 emsg(_(e_missing_name_after_dots));
233 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100234 }
235
236 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100237 p = one_function_arg(p, newargs, argtypes, types_optional,
238 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100239 if (p == arg)
240 break;
241 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 }
243 else
244 {
245 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100246 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100247 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200248 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200249
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200250 if (*skipwhite(p) == '=' && default_args != NULL)
251 {
252 typval_T rettv;
253
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100254 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200255 any_default = TRUE;
256 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200257 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200258 p = skipwhite(p);
259 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200260 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200261 {
262 if (ga_grow(default_args, 1) == FAIL)
263 goto err_ret;
264
265 // trim trailing whitespace
266 while (p > expr && VIM_ISWHITE(p[-1]))
267 p--;
268 c = *p;
269 *p = NUL;
270 expr = vim_strsave(expr);
271 if (expr == NULL)
272 {
273 *p = c;
274 goto err_ret;
275 }
276 ((char_u **)(default_args->ga_data))
277 [default_args->ga_len] = expr;
278 default_args->ga_len++;
279 *p = c;
280 }
281 else
282 mustend = TRUE;
283 }
284 else if (any_default)
285 {
286 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200287 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200288 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200289 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200290 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200291 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200292 // Don't give this error when skipping, it makes the "->" not
293 // found in "{k,v -> x}" and give a confusing error.
294 if (!skip && in_vim9script()
295 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
296 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200297 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200298 goto err_ret;
299 }
300 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301 else
302 mustend = TRUE;
303 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200304 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200305 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200306 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200307
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200308 if (*p != endchar)
309 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100310 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200311
312 *argp = p;
313 return OK;
314
315err_ret:
316 if (newargs != NULL)
317 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200318 if (default_args != NULL)
319 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200320 return FAIL;
321}
322
323/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100324 * Parse the argument types, filling "fp->uf_arg_types".
325 * Return OK or FAIL.
326 */
327 static int
328parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
329{
330 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
331 if (argtypes->ga_len > 0)
332 {
333 // When "varargs" is set the last name/type goes into uf_va_name
334 // and uf_va_type.
335 int len = argtypes->ga_len - (varargs ? 1 : 0);
336
337 if (len > 0)
338 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
339 if (fp->uf_arg_types != NULL)
340 {
341 int i;
342 type_T *type;
343
344 for (i = 0; i < len; ++ i)
345 {
346 char_u *p = ((char_u **)argtypes->ga_data)[i];
347
348 if (p == NULL)
349 // will get the type from the default value
350 type = &t_unknown;
351 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100352 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100353 if (type == NULL)
354 return FAIL;
355 fp->uf_arg_types[i] = type;
356 }
357 }
358 if (varargs)
359 {
360 char_u *p;
361
362 // Move the last argument "...name: type" to uf_va_name and
363 // uf_va_type.
364 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
365 [fp->uf_args.ga_len - 1];
366 --fp->uf_args.ga_len;
367 p = ((char_u **)argtypes->ga_data)[len];
368 if (p == NULL)
369 // todo: get type from default value
370 fp->uf_va_type = &t_any;
371 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100372 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100373 if (fp->uf_va_type == NULL)
374 return FAIL;
375 }
376 }
377 return OK;
378}
379
380/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200381 * Register function "fp" as using "current_funccal" as its scope.
382 */
383 static int
384register_closure(ufunc_T *fp)
385{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200386 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100387 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200388 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200389 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200390 fp->uf_scoped = current_funccal;
391 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200392
Bram Moolenaar58016442016-07-31 18:30:22 +0200393 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
394 return FAIL;
395 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
396 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200397 return OK;
398}
399
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100400 static void
401set_ufunc_name(ufunc_T *fp, char_u *name)
402{
403 STRCPY(fp->uf_name, name);
404
405 if (name[0] == K_SPECIAL)
406 {
407 fp->uf_name_exp = alloc(STRLEN(name) + 3);
408 if (fp->uf_name_exp != NULL)
409 {
410 STRCPY(fp->uf_name_exp, "<SNR>");
411 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
412 }
413 }
414}
415
Bram Moolenaar58016442016-07-31 18:30:22 +0200416/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200417 * Get a name for a lambda. Returned in static memory.
418 */
419 char_u *
420get_lambda_name(void)
421{
422 static char_u name[30];
423 static int lambda_no = 0;
424
425 sprintf((char*)name, "<lambda>%d", ++lambda_no);
426 return name;
427}
428
Bram Moolenaar801ab062020-06-25 19:27:56 +0200429#if defined(FEAT_LUA) || defined(PROTO)
430/*
431 * Registers a native C callback which can be called from Vim script.
432 * Returns the name of the Vim script function.
433 */
434 char_u *
435register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
436{
437 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200438 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200439
440 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
441 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200442 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200443
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200444 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200445 fp->uf_refcount = 1;
446 fp->uf_varargs = TRUE;
447 fp->uf_flags = FC_CFUNC;
448 fp->uf_calls = 0;
449 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200450 fp->uf_cb = cb;
451 fp->uf_cb_free = cb_free;
452 fp->uf_cb_state = state;
453
454 set_ufunc_name(fp, name);
455 hash_add(&func_hashtab, UF2HIKEY(fp));
456
457 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200458}
459#endif
460
Bram Moolenaar04b12692020-05-04 23:24:44 +0200461/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100462 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100463 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100464 * Return NULL if no valid arrow found.
465 */
466 static char_u *
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100467skip_arrow(char_u *start, int equal_arrow, char_u **ret_type)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100468{
469 char_u *s = start;
470
471 if (equal_arrow)
472 {
473 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100474 {
475 s = skipwhite(s + 1);
476 *ret_type = s;
477 s = skip_type(s, TRUE);
478 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100479 s = skipwhite(s);
480 if (*s != '=')
481 return NULL;
482 ++s;
483 }
484 if (*s != '>')
485 return NULL;
486 return skipwhite(s + 1);
487}
488
489/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200490 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100491 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100492 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200493 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
494 */
495 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100496get_lambda_tv(
497 char_u **arg,
498 typval_T *rettv,
499 int types_optional,
500 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200501{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200502 int evaluate = evalarg != NULL
503 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200504 garray_T newargs;
505 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200506 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100507 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200508 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100509 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200510 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100511 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200512 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200513 char_u *s;
514 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200515 int *old_eval_lavars = eval_lavars_used;
516 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200517 char_u *tofree = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100518 int equal_arrow = **arg == '(';
519
520 if (equal_arrow && !in_vim9script())
521 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200522
523 ga_init(&newargs);
524 ga_init(&newlines);
525
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100526 // First, check if this is really a lambda expression. "->" or "=>" must
527 // be found after the arguments.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200528 s = skipwhite(*arg + 1);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100529 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100530 types_optional ? &argtypes : NULL, types_optional,
531 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100532 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100533 {
534 if (types_optional)
535 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200536 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100537 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200538
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100539 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200540 if (evaluate)
541 pnewargs = &newargs;
542 else
543 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200544 *arg = skipwhite(*arg + 1);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100546 types_optional ? &argtypes : NULL, types_optional,
547 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100548 if (ret == FAIL
549 || (*arg = skip_arrow(*arg, equal_arrow, &ret_type)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100550 {
551 if (types_optional)
552 ga_clear_strings(&argtypes);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200555
Bram Moolenaare38eab22019-12-05 21:50:01 +0100556 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200557 if (evaluate)
558 eval_lavars_used = &eval_lavars;
559
Bram Moolenaar65c44152020-12-24 15:14:01 +0100560 *arg = skipwhite_and_linebreak(*arg, evalarg);
561
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100562 // Recognize "{" as the start of a function body.
563 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100564 {
565 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100567 emsg("Lambda function body not supported yet");
568 goto errret;
569 }
570
Bram Moolenaare38eab22019-12-05 21:50:01 +0100571 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200572 start = *arg;
573 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200574 if (ret == FAIL)
575 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200576 if (evalarg != NULL)
577 {
578 // avoid that the expression gets freed when another line break follows
579 tofree = evalarg->eval_tofree;
580 evalarg->eval_tofree = NULL;
581 }
582
Bram Moolenaar65c44152020-12-24 15:14:01 +0100583 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100584 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100585 *arg = skipwhite_and_linebreak(*arg, evalarg);
586 if (**arg != '}')
587 {
588 semsg(_("E451: Expected }: %s"), *arg);
589 goto errret;
590 }
591 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100592 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200593
594 if (evaluate)
595 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200596 int len;
597 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200598 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200599 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200600
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200601 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200602 if (fp == NULL)
603 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200604 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200605 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200606 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200607 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200608
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200609 ga_init2(&newlines, (int)sizeof(char_u *), 1);
610 if (ga_grow(&newlines, 1) == FAIL)
611 goto errret;
612
Bram Moolenaare38eab22019-12-05 21:50:01 +0100613 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200614 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200615 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200616 if (p == NULL)
617 goto errret;
618 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
619 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200620 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200621 if (strstr((char *)p + 7, "a:") == NULL)
622 // No a: variables are used for sure.
623 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200624
625 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100626 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200627 hash_add(&func_hashtab, UF2HIKEY(fp));
628 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200629 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100630 if (types_optional)
631 {
632 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
633 goto errret;
634 if (ret_type != NULL)
635 {
636 fp->uf_ret_type = parse_type(&ret_type,
637 &fp->uf_type_list, TRUE);
638 if (fp->uf_ret_type == NULL)
639 goto errret;
640 }
641 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100642
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200643 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200644 if (current_funccal != NULL && eval_lavars)
645 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200646 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200647 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200648 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200649 }
650 else
651 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200652
653#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200654 if (prof_def_func())
655 func_do_profile(fp);
656#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200657 if (sandbox)
658 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100659 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200660 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200661 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200662 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200663 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100664 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200665
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200666 pt->pt_func = fp;
667 pt->pt_refcount = 1;
668 rettv->vval.v_partial = pt;
669 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200670 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200671
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200672 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200673 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200674 evalarg->eval_tofree = tofree;
675 else
676 vim_free(tofree);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100677 if (types_optional)
678 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200679 return OK;
680
681errret:
682 ga_clear_strings(&newargs);
683 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100684 if (types_optional)
685 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200686 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100687 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200688 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200689 evalarg->eval_tofree = tofree;
690 else
691 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200692 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200693 return FAIL;
694}
695
696/*
697 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
698 * name it contains, otherwise return "name".
699 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
700 * "partialp".
701 */
702 char_u *
703deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
704{
705 dictitem_T *v;
706 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200707 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200708
709 if (partialp != NULL)
710 *partialp = NULL;
711
712 cc = name[*lenp];
713 name[*lenp] = NUL;
714 v = find_var(name, NULL, no_autoload);
715 name[*lenp] = cc;
716 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
717 {
718 if (v->di_tv.vval.v_string == NULL)
719 {
720 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100721 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200722 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200723 s = v->di_tv.vval.v_string;
724 *lenp = (int)STRLEN(s);
725 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200726 }
727
728 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
729 {
730 partial_T *pt = v->di_tv.vval.v_partial;
731
732 if (pt == NULL)
733 {
734 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100735 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200736 }
737 if (partialp != NULL)
738 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200739 s = partial_name(pt);
740 *lenp = (int)STRLEN(s);
741 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200742 }
743
744 return name;
745}
746
747/*
748 * Give an error message with a function name. Handle <SNR> things.
749 * "ermsg" is to be passed without translation, use N_() instead of _().
750 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100751 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200752emsg_funcname(char *ermsg, char_u *name)
753{
754 char_u *p;
755
756 if (*name == K_SPECIAL)
757 p = concat_str((char_u *)"<SNR>", name + 3);
758 else
759 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100760 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200761 if (p != name)
762 vim_free(p);
763}
764
765/*
766 * Allocate a variable for the result of a function.
767 * Return OK or FAIL.
768 */
769 int
770get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200771 char_u *name, // name of the function
772 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200773 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200774 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200775 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200776 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200777{
778 char_u *argp;
779 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100780 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
781 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200782 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200783
784 /*
785 * Get the arguments.
786 */
787 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200788 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
789 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200790 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200791 // skip the '(' or ',' and possibly line breaks
792 argp = skipwhite_and_linebreak(argp + 1, evalarg);
793
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200794 if (*argp == ')' || *argp == ',' || *argp == NUL)
795 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200796 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200797 {
798 ret = FAIL;
799 break;
800 }
801 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200802 // The comma should come right after the argument, but this wasn't
803 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200804 if (vim9script)
805 {
806 if (*argp != ',' && *skipwhite(argp) == ',')
807 {
808 semsg(_(e_no_white_space_allowed_before_str), ",");
809 ret = FAIL;
810 break;
811 }
812 }
813 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200814 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200815 if (*argp != ',')
816 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200817 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
818 {
819 semsg(_(e_white_space_required_after_str), ",");
820 ret = FAIL;
821 break;
822 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200823 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200824 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200825 if (*argp == ')')
826 ++argp;
827 else
828 ret = FAIL;
829
830 if (ret == OK)
831 {
832 int i = 0;
833
834 if (get_vim_var_nr(VV_TESTING))
835 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100836 // Prepare for calling test_garbagecollect_now(), need to know
837 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200838 if (funcargs.ga_itemsize == 0)
839 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
840 for (i = 0; i < argcount; ++i)
841 if (ga_grow(&funcargs, 1) == OK)
842 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
843 &argvars[i];
844 }
845
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200846 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200847
848 funcargs.ga_len -= i;
849 }
850 else if (!aborting())
851 {
852 if (argcount == MAX_FUNC_ARGS)
853 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
854 else
855 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
856 }
857
858 while (--argcount >= 0)
859 clear_tv(&argvars[argcount]);
860
Bram Moolenaar8294d492020-08-10 22:40:56 +0200861 if (in_vim9script())
862 *arg = argp;
863 else
864 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200865 return ret;
866}
867
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200868/*
869 * Return TRUE if "p" starts with "<SID>" or "s:".
870 * Only works if eval_fname_script() returned non-zero for "p"!
871 */
872 static int
873eval_fname_sid(char_u *p)
874{
875 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
876}
877
878/*
879 * In a script change <SID>name() and s:name() to K_SNR 123_name().
880 * Change <SNR>123_name() to K_SNR 123_name().
881 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
882 * (slow).
883 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100884 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200885fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
886{
887 int llen;
888 char_u *fname;
889 int i;
890
891 llen = eval_fname_script(name);
892 if (llen > 0)
893 {
894 fname_buf[0] = K_SPECIAL;
895 fname_buf[1] = KS_EXTRA;
896 fname_buf[2] = (int)KE_SNR;
897 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100898 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200899 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200900 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100901 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200902 else
903 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200904 sprintf((char *)fname_buf + 3, "%ld_",
905 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200906 i = (int)STRLEN(fname_buf);
907 }
908 }
909 if (i + STRLEN(name + llen) < FLEN_FIXED)
910 {
911 STRCPY(fname_buf + i, name + llen);
912 fname = fname_buf;
913 }
914 else
915 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200916 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200917 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100918 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200919 else
920 {
921 *tofree = fname;
922 mch_memmove(fname, fname_buf, (size_t)i);
923 STRCPY(fname + i, name + llen);
924 }
925 }
926 }
927 else
928 fname = name;
929 return fname;
930}
931
932/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100933 * Find a function "name" in script "sid".
934 */
935 static ufunc_T *
936find_func_with_sid(char_u *name, int sid)
937{
938 hashitem_T *hi;
939 char_u buffer[200];
940
941 buffer[0] = K_SPECIAL;
942 buffer[1] = KS_EXTRA;
943 buffer[2] = (int)KE_SNR;
944 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
945 (long)sid, name);
946 hi = hash_find(&func_hashtab, buffer);
947 if (!HASHITEM_EMPTY(hi))
948 return HI2UF(hi);
949
950 return NULL;
951}
952
953/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200954 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200955 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200956 * Return NULL for unknown function.
957 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200958 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200959find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200960{
961 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100962 ufunc_T *func;
963 imported_T *imported;
964
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200965 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100966 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200967 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200968 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +0200969 int find_script_local = in_vim9script()
970 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100971
Bram Moolenaar95006e32020-08-29 17:47:08 +0200972 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100973 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200974 // Find script-local function before global one.
975 func = find_func_with_sid(name, current_sctx.sc_sid);
976 if (func != NULL)
977 return func;
978 }
979
Bram Moolenaarefa94442020-08-08 22:16:00 +0200980 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200981 && name[1] == KS_EXTRA
982 && name[2] == KE_SNR)
983 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200984 // Caller changes s: to <SNR>99_name.
985
986 after_script = name + 3;
987 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200988 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200989 ++after_script;
990 else
991 after_script = NULL;
992 }
Bram Moolenaar95006e32020-08-29 17:47:08 +0200993 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200994 {
995 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200996 if (after_script != NULL && sid != current_sctx.sc_sid)
997 imported = find_imported_in_script(after_script, 0, sid);
998 else
999 imported = find_imported(after_script == NULL
1000 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001001 if (imported != NULL && imported->imp_funcname != NULL)
1002 {
1003 hi = hash_find(&func_hashtab, imported->imp_funcname);
1004 if (!HASHITEM_EMPTY(hi))
1005 return HI2UF(hi);
1006 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001007 }
1008 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001009
Bram Moolenaara26b9702020-04-18 19:53:28 +02001010 hi = hash_find(&func_hashtab,
1011 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001012 if (!HASHITEM_EMPTY(hi))
1013 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001014
1015 return NULL;
1016}
1017
1018/*
1019 * Find a function by name, return pointer to it in ufuncs.
1020 * "cctx" is passed in a :def function to find imported functions.
1021 * Return NULL for unknown or dead function.
1022 */
1023 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001024find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001025{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001026 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001027
1028 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1029 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001030 return NULL;
1031}
1032
1033/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001034 * Return TRUE if "ufunc" is a global function.
1035 */
1036 int
1037func_is_global(ufunc_T *ufunc)
1038{
1039 return ufunc->uf_name[0] != K_SPECIAL;
1040}
1041
1042/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001043 * Copy the function name of "fp" to buffer "buf".
1044 * "buf" must be able to hold the function name plus three bytes.
1045 * Takes care of script-local function names.
1046 */
1047 static void
1048cat_func_name(char_u *buf, ufunc_T *fp)
1049{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001050 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001051 {
1052 STRCPY(buf, "<SNR>");
1053 STRCAT(buf, fp->uf_name + 3);
1054 }
1055 else
1056 STRCPY(buf, fp->uf_name);
1057}
1058
1059/*
1060 * Add a number variable "name" to dict "dp" with value "nr".
1061 */
1062 static void
1063add_nr_var(
1064 dict_T *dp,
1065 dictitem_T *v,
1066 char *name,
1067 varnumber_T nr)
1068{
1069 STRCPY(v->di_key, name);
1070 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1071 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1072 v->di_tv.v_type = VAR_NUMBER;
1073 v->di_tv.v_lock = VAR_FIXED;
1074 v->di_tv.vval.v_number = nr;
1075}
1076
1077/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001078 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001079 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001080 static void
1081free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001082{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001083 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001084
1085 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1086 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001087 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001088
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001089 // When garbage collecting a funccall_T may be freed before the
1090 // function that references it, clear its uf_scoped field.
1091 // The function may have been redefined and point to another
1092 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001093 if (fp != NULL && fp->uf_scoped == fc)
1094 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001095 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001096 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001097
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001098 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001099 vim_free(fc);
1100}
1101
1102/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001103 * Free "fc" and what it contains.
1104 * Can be called only when "fc" is kept beyond the period of it called,
1105 * i.e. after cleanup_function_call(fc).
1106 */
1107 static void
1108free_funccal_contents(funccall_T *fc)
1109{
1110 listitem_T *li;
1111
1112 // Free all l: variables.
1113 vars_clear(&fc->l_vars.dv_hashtab);
1114
1115 // Free all a: variables.
1116 vars_clear(&fc->l_avars.dv_hashtab);
1117
1118 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001119 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001120 clear_tv(&li->li_tv);
1121
1122 free_funccal(fc);
1123}
1124
1125/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001126 * Handle the last part of returning from a function: free the local hashtable.
1127 * Unless it is still in use by a closure.
1128 */
1129 static void
1130cleanup_function_call(funccall_T *fc)
1131{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001132 int may_free_fc = fc->fc_refcount <= 0;
1133 int free_fc = TRUE;
1134
Bram Moolenaar6914c642017-04-01 21:21:30 +02001135 current_funccal = fc->caller;
1136
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001137 // Free all l: variables if not referred.
1138 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1139 vars_clear(&fc->l_vars.dv_hashtab);
1140 else
1141 free_fc = FALSE;
1142
1143 // If the a:000 list and the l: and a: dicts are not referenced and
1144 // there is no closure using it, we can free the funccall_T and what's
1145 // in it.
1146 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1147 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001148 else
1149 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001150 int todo;
1151 hashitem_T *hi;
1152 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001153
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001154 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001155
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001156 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001157 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1158 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1159 {
1160 if (!HASHITEM_EMPTY(hi))
1161 {
1162 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001163 di = HI2DI(hi);
1164 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001165 }
1166 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001167 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001168
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001169 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1170 fc->l_varlist.lv_first = NULL;
1171 else
1172 {
1173 listitem_T *li;
1174
1175 free_fc = FALSE;
1176
1177 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001178 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001179 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001180 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001181
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001182 if (free_fc)
1183 free_funccal(fc);
1184 else
1185 {
1186 static int made_copy = 0;
1187
1188 // "fc" is still in use. This can happen when returning "a:000",
1189 // assigning "l:" to a global variable or defining a closure.
1190 // Link "fc" in the list for garbage collection later.
1191 fc->caller = previous_funccal;
1192 previous_funccal = fc;
1193
1194 if (want_garbage_collect)
1195 // If garbage collector is ready, clear count.
1196 made_copy = 0;
1197 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001198 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001199 // We have made a lot of copies, worth 4 Mbyte. This can happen
1200 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001201 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001202 // too much memory.
1203 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001204 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001205 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001206 }
1207}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001208
1209/*
1210 * There are two kinds of function names:
1211 * 1. ordinary names, function defined with :function or :def
1212 * 2. numbered functions and lambdas
1213 * For the first we only count the name stored in func_hashtab as a reference,
1214 * using function() does not count as a reference, because the function is
1215 * looked up by name.
1216 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001217 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001218func_name_refcount(char_u *name)
1219{
1220 return isdigit(*name) || *name == '<';
1221}
1222
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001223/*
1224 * Unreference "fc": decrement the reference count and free it when it
1225 * becomes zero. "fp" is detached from "fc".
1226 * When "force" is TRUE we are exiting.
1227 */
1228 static void
1229funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1230{
1231 funccall_T **pfc;
1232 int i;
1233
1234 if (fc == NULL)
1235 return;
1236
1237 if (--fc->fc_refcount <= 0 && (force || (
1238 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1239 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1240 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1241 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1242 {
1243 if (fc == *pfc)
1244 {
1245 *pfc = fc->caller;
1246 free_funccal_contents(fc);
1247 return;
1248 }
1249 }
1250 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1251 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1252 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1253}
1254
1255/*
1256 * Remove the function from the function hashtable. If the function was
1257 * deleted while it still has references this was already done.
1258 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1259 */
1260 static int
1261func_remove(ufunc_T *fp)
1262{
1263 hashitem_T *hi;
1264
1265 // Return if it was already virtually deleted.
1266 if (fp->uf_flags & FC_DEAD)
1267 return FALSE;
1268
1269 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1270 if (!HASHITEM_EMPTY(hi))
1271 {
1272 // When there is a def-function index do not actually remove the
1273 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001274 // Do remove it when it's a copy.
1275 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001276 fp->uf_flags |= FC_DEAD;
1277 else
1278 hash_remove(&func_hashtab, hi);
1279 return TRUE;
1280 }
1281 return FALSE;
1282}
1283
1284 static void
1285func_clear_items(ufunc_T *fp)
1286{
1287 ga_clear_strings(&(fp->uf_args));
1288 ga_clear_strings(&(fp->uf_def_args));
1289 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001290 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001291 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001292 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001293 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001294 clear_type_list(&fp->uf_type_list);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001295 partial_unref(fp->uf_partial);
1296 fp->uf_partial = NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001297
1298#ifdef FEAT_LUA
1299 if (fp->uf_cb_free != NULL)
1300 {
1301 fp->uf_cb_free(fp->uf_cb_state);
1302 fp->uf_cb_free = NULL;
1303 }
1304
1305 fp->uf_cb_state = NULL;
1306 fp->uf_cb = NULL;
1307#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001308#ifdef FEAT_PROFILE
1309 VIM_CLEAR(fp->uf_tml_count);
1310 VIM_CLEAR(fp->uf_tml_total);
1311 VIM_CLEAR(fp->uf_tml_self);
1312#endif
1313}
1314
1315/*
1316 * Free all things that a function contains. Does not free the function
1317 * itself, use func_free() for that.
1318 * When "force" is TRUE we are exiting.
1319 */
1320 static void
1321func_clear(ufunc_T *fp, int force)
1322{
1323 if (fp->uf_cleared)
1324 return;
1325 fp->uf_cleared = TRUE;
1326
1327 // clear this function
1328 func_clear_items(fp);
1329 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001330 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001331}
1332
1333/*
1334 * Free a function and remove it from the list of functions. Does not free
1335 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001336 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001337 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001338 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001339 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001340func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001341{
1342 // Only remove it when not done already, otherwise we would remove a newer
1343 // version of the function with the same name.
1344 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1345 func_remove(fp);
1346
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001347 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001348 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001349 if (fp->uf_dfunc_idx > 0)
1350 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001351 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001352 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001353 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001354 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001355 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001356}
1357
1358/*
1359 * Free all things that a function contains and free the function itself.
1360 * When "force" is TRUE we are exiting.
1361 */
1362 static void
1363func_clear_free(ufunc_T *fp, int force)
1364{
1365 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001366 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1367 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001368 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001369 else
1370 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001371}
1372
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001373/*
1374 * Copy already defined function "lambda" to a new function with name "global".
1375 * This is for when a compiled function defines a global function.
1376 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001377 int
1378copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001379{
1380 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001381 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001382
1383 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001384 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001385 semsg(_(e_lambda_function_not_found_str), lambda);
1386 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001387 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001388
1389 // TODO: handle ! to overwrite
1390 fp = find_func(global, TRUE, NULL);
1391 if (fp != NULL)
1392 {
1393 semsg(_(e_funcexts), global);
1394 return FAIL;
1395 }
1396
1397 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1398 if (fp == NULL)
1399 return FAIL;
1400
1401 fp->uf_varargs = ufunc->uf_varargs;
1402 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1403 fp->uf_def_status = ufunc->uf_def_status;
1404 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1405 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1406 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1407 == FAIL
1408 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1409 goto failed;
1410
1411 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1412 : vim_strsave(ufunc->uf_name_exp);
1413 if (ufunc->uf_arg_types != NULL)
1414 {
1415 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1416 if (fp->uf_arg_types == NULL)
1417 goto failed;
1418 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1419 sizeof(type_T *) * fp->uf_args.ga_len);
1420 }
1421 if (ufunc->uf_def_arg_idx != NULL)
1422 {
1423 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1424 if (fp->uf_def_arg_idx == NULL)
1425 goto failed;
1426 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1427 sizeof(int) * fp->uf_def_args.ga_len + 1);
1428 }
1429 if (ufunc->uf_va_name != NULL)
1430 {
1431 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1432 if (fp->uf_va_name == NULL)
1433 goto failed;
1434 }
1435 fp->uf_ret_type = ufunc->uf_ret_type;
1436
1437 fp->uf_refcount = 1;
1438 STRCPY(fp->uf_name, global);
1439 hash_add(&func_hashtab, UF2HIKEY(fp));
1440
1441 // the referenced dfunc_T is now used one more time
1442 link_def_function(fp);
1443
1444 // Create a partial to store the context of the function, if not done
1445 // already.
1446 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1447 {
1448 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1449
1450 if (pt == NULL)
1451 goto failed;
1452 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
1453 goto failed;
1454 ufunc->uf_partial = pt;
1455 --pt->pt_refcount; // not referenced here yet
1456 }
1457 if (ufunc->uf_partial != NULL)
1458 {
1459 fp->uf_partial = ufunc->uf_partial;
1460 ++fp->uf_partial->pt_refcount;
1461 }
1462
1463 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001464
1465failed:
1466 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001467 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001468}
1469
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001470static int funcdepth = 0;
1471
1472/*
1473 * Increment the function call depth count.
1474 * Return FAIL when going over 'maxfuncdepth'.
1475 * Otherwise return OK, must call funcdepth_decrement() later!
1476 */
1477 int
1478funcdepth_increment(void)
1479{
1480 if (funcdepth >= p_mfd)
1481 {
1482 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1483 return FAIL;
1484 }
1485 ++funcdepth;
1486 return OK;
1487}
1488
1489 void
1490funcdepth_decrement(void)
1491{
1492 --funcdepth;
1493}
1494
1495/*
1496 * Get the current function call depth.
1497 */
1498 int
1499funcdepth_get(void)
1500{
1501 return funcdepth;
1502}
1503
1504/*
1505 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001506 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001507 * times as funcdepth_increment().
1508 */
1509 void
1510funcdepth_restore(int depth)
1511{
1512 funcdepth = depth;
1513}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001514
1515/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 * Call a user function.
1517 */
1518 static void
1519call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001520 ufunc_T *fp, // pointer to function
1521 int argcount, // nr of args
1522 typval_T *argvars, // arguments
1523 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001524 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001525 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001527 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001528 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 funccall_T *fc;
1530 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001531 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001533 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534 int i;
1535 int ai;
1536 int islambda = FALSE;
1537 char_u numbuf[NUMBUFLEN];
1538 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001539#ifdef FEAT_PROFILE
1540 proftime_T wait_start;
1541 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001542 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001544 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001545
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001546 // If depth of calling is getting too high, don't execute the function.
1547 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 rettv->v_type = VAR_NUMBER;
1550 rettv->vval.v_number = -1;
1551 return;
1552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553
Bram Moolenaare38eab22019-12-05 21:50:01 +01001554 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001556 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001557 if (fc == NULL)
1558 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001559 fc->caller = current_funccal;
1560 current_funccal = fc;
1561 fc->func = fp;
1562 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001564 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1566 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001567 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001568 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001569 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001571 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001572 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001573 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001574 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001575 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001576 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001577 free_funccal(fc);
1578 return;
1579 }
1580
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001581 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1582 islambda = TRUE;
1583
1584 /*
1585 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1586 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1587 * each argument variable and saves a lot of time.
1588 */
1589 /*
1590 * Init l: variables.
1591 */
1592 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1593 if (selfdict != NULL)
1594 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001595 // Set l:self to "selfdict". Use "name" to avoid a warning from
1596 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 v = &fc->fixvar[fixvar_idx++].var;
1598 name = v->di_key;
1599 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001600 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1602 v->di_tv.v_type = VAR_DICT;
1603 v->di_tv.v_lock = 0;
1604 v->di_tv.vval.v_dict = selfdict;
1605 ++selfdict->dv_refcount;
1606 }
1607
1608 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001609 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001610 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611 * Set a:000 to a list with room for the "..." arguments.
1612 */
1613 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001614 if ((fp->uf_flags & FC_NOARGS) == 0)
1615 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001616 (varnumber_T)(argcount >= fp->uf_args.ga_len
1617 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001618 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001619 if ((fp->uf_flags & FC_NOARGS) == 0)
1620 {
1621 // Use "name" to avoid a warning from some compiler that checks the
1622 // destination size.
1623 v = &fc->fixvar[fixvar_idx++].var;
1624 name = v->di_key;
1625 STRCPY(name, "000");
1626 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1627 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1628 v->di_tv.v_type = VAR_LIST;
1629 v->di_tv.v_lock = VAR_FIXED;
1630 v->di_tv.vval.v_list = &fc->l_varlist;
1631 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001632 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1634 fc->l_varlist.lv_lock = VAR_FIXED;
1635
1636 /*
1637 * Set a:firstline to "firstline" and a:lastline to "lastline".
1638 * Set a:name to named arguments.
1639 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001640 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001641 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001642 if ((fp->uf_flags & FC_NOARGS) == 0)
1643 {
1644 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001645 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001646 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001647 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001648 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001649 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 {
1651 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001652 typval_T def_rettv;
1653 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654
1655 ai = i - fp->uf_args.ga_len;
1656 if (ai < 0)
1657 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001658 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001659 name = FUNCARG(fp, i);
1660 if (islambda)
1661 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001662
1663 // evaluate named argument default expression
1664 isdefault = ai + fp->uf_def_args.ga_len >= 0
1665 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1666 && argvars[i].vval.v_number == VVAL_NONE));
1667 if (isdefault)
1668 {
1669 char_u *default_expr = NULL;
1670 def_rettv.v_type = VAR_NUMBER;
1671 def_rettv.vval.v_number = -1;
1672
1673 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1674 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001675 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001676 {
1677 default_arg_err = 1;
1678 break;
1679 }
1680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 }
1682 else
1683 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001684 if ((fp->uf_flags & FC_NOARGS) != 0)
1685 // Bail out if no a: arguments used (in lambda).
1686 break;
1687
Bram Moolenaare38eab22019-12-05 21:50:01 +01001688 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689 sprintf((char *)numbuf, "%d", ai + 1);
1690 name = numbuf;
1691 }
1692 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1693 {
1694 v = &fc->fixvar[fixvar_idx++].var;
1695 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001696 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 }
1698 else
1699 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001700 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 if (v == NULL)
1702 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001703 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001704 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001706 // Note: the values are copied directly to avoid alloc/free.
1707 // "argvars" must have VAR_FIXED for v_lock.
1708 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001709 v->di_tv.v_lock = VAR_FIXED;
1710
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001711 if (addlocal)
1712 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001713 // Named arguments should be accessed without the "a:" prefix in
1714 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001715 copy_tv(&v->di_tv, &v->di_tv);
1716 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001718 else
1719 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720
1721 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1722 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001723 listitem_T *li = &fc->l_listitems[ai];
1724
1725 li->li_tv = argvars[i];
1726 li->li_tv.v_lock = VAR_FIXED;
1727 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728 }
1729 }
1730
Bram Moolenaare38eab22019-12-05 21:50:01 +01001731 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001733
1734 if (fp->uf_flags & FC_SANDBOX)
1735 {
1736 using_sandbox = TRUE;
1737 ++sandbox;
1738 }
1739
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001740 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001741 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001742 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001744 ++no_wait_return;
1745 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001746
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001747 smsg(_("calling %s"), SOURCING_NAME);
1748 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001750 char_u buf[MSG_BUF_LEN];
1751 char_u numbuf2[NUMBUFLEN];
1752 char_u *tofree;
1753 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001755 msg_puts("(");
1756 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001758 if (i > 0)
1759 msg_puts(", ");
1760 if (argvars[i].v_type == VAR_NUMBER)
1761 msg_outnum((long)argvars[i].vval.v_number);
1762 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001763 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001764 // Do not want errors such as E724 here.
1765 ++emsg_off;
1766 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1767 --emsg_off;
1768 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001770 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001772 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1773 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001775 msg_puts((char *)s);
1776 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 }
1778 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001779 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001780 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001782 msg_puts("\n"); // don't overwrite this either
1783
1784 verbose_leave_scroll();
1785 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001786 }
1787#ifdef FEAT_PROFILE
1788 if (do_profiling == PROF_YES)
1789 {
1790 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001791 {
1792 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001794 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795 if (fp->uf_profiling
1796 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1797 {
1798 ++fp->uf_tm_count;
1799 profile_start(&call_start);
1800 profile_zero(&fp->uf_tm_children);
1801 }
1802 script_prof_save(&wait_start);
1803 }
1804#endif
1805
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001806 save_current_sctx = current_sctx;
1807 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 save_did_emsg = did_emsg;
1809 did_emsg = FALSE;
1810
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001811 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1812 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001813 else if (islambda)
1814 {
1815 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1816
1817 // A Lambda always has the command "return {expr}". It is much faster
1818 // to evaluate {expr} directly.
1819 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001820 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001821 --ex_nesting_level;
1822 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001823 else
1824 // call do_cmdline() to execute the lines
1825 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1827
1828 --RedrawingDisabled;
1829
Bram Moolenaare38eab22019-12-05 21:50:01 +01001830 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1832 {
1833 clear_tv(rettv);
1834 rettv->v_type = VAR_NUMBER;
1835 rettv->vval.v_number = -1;
1836 }
1837
1838#ifdef FEAT_PROFILE
1839 if (do_profiling == PROF_YES && (fp->uf_profiling
1840 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1841 {
1842 profile_end(&call_start);
1843 profile_sub_wait(&wait_start, &call_start);
1844 profile_add(&fp->uf_tm_total, &call_start);
1845 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1846 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1847 {
1848 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1849 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1850 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001851 if (started_profiling)
1852 // make a ":profdel func" stop profiling the function
1853 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 }
1855#endif
1856
Bram Moolenaare38eab22019-12-05 21:50:01 +01001857 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 if (p_verbose >= 12)
1859 {
1860 ++no_wait_return;
1861 verbose_enter_scroll();
1862
1863 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001864 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001866 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001867 (long)fc->rettv->vval.v_number);
1868 else
1869 {
1870 char_u buf[MSG_BUF_LEN];
1871 char_u numbuf2[NUMBUFLEN];
1872 char_u *tofree;
1873 char_u *s;
1874
Bram Moolenaare38eab22019-12-05 21:50:01 +01001875 // The value may be very long. Skip the middle part, so that we
1876 // have some idea how it starts and ends. smsg() would always
1877 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001878 ++emsg_off;
1879 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1880 --emsg_off;
1881 if (s != NULL)
1882 {
1883 if (vim_strsize(s) > MSG_BUF_CLEN)
1884 {
1885 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1886 s = buf;
1887 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001888 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001889 vim_free(tofree);
1890 }
1891 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001892 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893
1894 verbose_leave_scroll();
1895 --no_wait_return;
1896 }
1897
Bram Moolenaare31ee862020-01-07 20:59:34 +01001898 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001899 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001900 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001901#ifdef FEAT_PROFILE
1902 if (do_profiling == PROF_YES)
1903 script_prof_restore(&wait_start);
1904#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001905 if (using_sandbox)
1906 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001907
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001908 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 {
1910 ++no_wait_return;
1911 verbose_enter_scroll();
1912
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001913 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001914 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001915
1916 verbose_leave_scroll();
1917 --no_wait_return;
1918 }
1919
1920 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001921 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001922 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001923}
1924
1925/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001926 * Check the argument count for user function "fp".
1927 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1928 */
1929 int
1930check_user_func_argcount(ufunc_T *fp, int argcount)
1931{
1932 int regular_args = fp->uf_args.ga_len;
1933
1934 if (argcount < regular_args - fp->uf_def_args.ga_len)
1935 return FCERR_TOOFEW;
1936 else if (!has_varargs(fp) && argcount > regular_args)
1937 return FCERR_TOOMANY;
1938 return FCERR_UNKNOWN;
1939}
1940
1941/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001943 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001944 int
1945call_user_func_check(
1946 ufunc_T *fp,
1947 int argcount,
1948 typval_T *argvars,
1949 typval_T *rettv,
1950 funcexe_T *funcexe,
1951 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001952{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001953 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001954
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1956 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01001957 error = check_user_func_argcount(fp, argcount);
1958 if (error != FCERR_UNKNOWN)
1959 return error;
1960 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961 error = FCERR_DICT;
1962 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001963 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001964 int did_save_redo = FALSE;
1965 save_redo_T save_redo;
1966
1967 /*
1968 * Call the user function.
1969 * Save and restore search patterns, script variables and
1970 * redo buffer.
1971 */
1972 save_search_patterns();
1973 if (!ins_compl_active())
1974 {
1975 saveRedobuff(&save_redo);
1976 did_save_redo = TRUE;
1977 }
1978 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001979 call_user_func(fp, argcount, argvars, rettv, funcexe,
1980 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001981 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1982 // Function was unreferenced while being used, free it now.
1983 func_clear_free(fp, FALSE);
1984 if (did_save_redo)
1985 restoreRedobuff(&save_redo);
1986 restore_search_patterns();
1987 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001988 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001989 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001990}
1991
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001992static funccal_entry_T *funccal_stack = NULL;
1993
1994/*
1995 * Save the current function call pointer, and set it to NULL.
1996 * Used when executing autocommands and for ":source".
1997 */
1998 void
1999save_funccal(funccal_entry_T *entry)
2000{
2001 entry->top_funccal = current_funccal;
2002 entry->next = funccal_stack;
2003 funccal_stack = entry;
2004 current_funccal = NULL;
2005}
2006
2007 void
2008restore_funccal(void)
2009{
2010 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002011 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002012 else
2013 {
2014 current_funccal = funccal_stack->top_funccal;
2015 funccal_stack = funccal_stack->next;
2016 }
2017}
2018
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002019 funccall_T *
2020get_current_funccal(void)
2021{
2022 return current_funccal;
2023}
2024
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002025/*
2026 * Mark all functions of script "sid" as deleted.
2027 */
2028 void
2029delete_script_functions(int sid)
2030{
2031 hashitem_T *hi;
2032 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002033 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002034 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002035 size_t len;
2036
2037 buf[0] = K_SPECIAL;
2038 buf[1] = KS_EXTRA;
2039 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002040 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002041 len = STRLEN(buf);
2042
Bram Moolenaarce658352020-07-31 23:47:12 +02002043 while (todo > 0)
2044 {
2045 todo = func_hashtab.ht_used;
2046 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2047 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002048 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002049 fp = HI2UF(hi);
2050 if (STRNCMP(fp->uf_name, buf, len) == 0)
2051 {
2052 int changed = func_hashtab.ht_changed;
2053
2054 fp->uf_flags |= FC_DEAD;
2055 func_clear(fp, TRUE);
2056 // When clearing a function another function can be cleared
2057 // as a side effect. When that happens start over.
2058 if (changed != func_hashtab.ht_changed)
2059 break;
2060 }
2061 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002062 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002063 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002064}
2065
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002066#if defined(EXITFREE) || defined(PROTO)
2067 void
2068free_all_functions(void)
2069{
2070 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002071 ufunc_T *fp;
2072 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002073 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002074 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002075
Bram Moolenaare38eab22019-12-05 21:50:01 +01002076 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002077 while (current_funccal != NULL)
2078 {
2079 clear_tv(current_funccal->rettv);
2080 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002081 if (current_funccal == NULL && funccal_stack != NULL)
2082 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002083 }
2084
Bram Moolenaare38eab22019-12-05 21:50:01 +01002085 // First clear what the functions contain. Since this may lower the
2086 // reference count of a function, it may also free a function and change
2087 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002088 while (todo > 0)
2089 {
2090 todo = func_hashtab.ht_used;
2091 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2092 if (!HASHITEM_EMPTY(hi))
2093 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002094 // clear the def function index now
2095 fp = HI2UF(hi);
2096 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002097 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002098
Bram Moolenaare38eab22019-12-05 21:50:01 +01002099 // Only free functions that are not refcounted, those are
2100 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002101 if (func_name_refcount(fp->uf_name))
2102 ++skipped;
2103 else
2104 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002105 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002106 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002107 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002108 {
2109 skipped = 0;
2110 break;
2111 }
2112 }
2113 --todo;
2114 }
2115 }
2116
Bram Moolenaare38eab22019-12-05 21:50:01 +01002117 // Now actually free the functions. Need to start all over every time,
2118 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002119 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002120 while (func_hashtab.ht_used > skipped)
2121 {
2122 todo = func_hashtab.ht_used;
2123 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002124 if (!HASHITEM_EMPTY(hi))
2125 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002126 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002127 // Only free functions that are not refcounted, those are
2128 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002129 fp = HI2UF(hi);
2130 if (func_name_refcount(fp->uf_name))
2131 ++skipped;
2132 else
2133 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002134 if (func_free(fp, FALSE) == OK)
2135 {
2136 skipped = 0;
2137 break;
2138 }
2139 // did not actually free it
2140 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002141 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002142 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002143 }
2144 if (skipped == 0)
2145 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002146
2147 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002148}
2149#endif
2150
2151/*
2152 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002153 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002154 * "len" is the length of "name", or -1 for NUL terminated.
2155 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002156 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002157builtin_function(char_u *name, int len)
2158{
2159 char_u *p;
2160
Bram Moolenaara26b9702020-04-18 19:53:28 +02002161 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002162 return FALSE;
2163 p = vim_strchr(name, AUTOLOAD_CHAR);
2164 return p == NULL || (len > 0 && p > name + len);
2165}
2166
2167 int
2168func_call(
2169 char_u *name,
2170 typval_T *args,
2171 partial_T *partial,
2172 dict_T *selfdict,
2173 typval_T *rettv)
2174{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002175 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 listitem_T *item;
2177 typval_T argv[MAX_FUNC_ARGS + 1];
2178 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002179 int r = 0;
2180
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002181 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002182 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 {
2184 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2185 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002186 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002187 break;
2188 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002189 // Make a copy of each argument. This is needed to be able to set
2190 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002191 copy_tv(&item->li_tv, &argv[argc++]);
2192 }
2193
2194 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002195 {
2196 funcexe_T funcexe;
2197
Bram Moolenaara80faa82020-04-12 19:37:17 +02002198 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002199 funcexe.firstline = curwin->w_cursor.lnum;
2200 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002201 funcexe.evaluate = TRUE;
2202 funcexe.partial = partial;
2203 funcexe.selfdict = selfdict;
2204 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2205 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206
Bram Moolenaare38eab22019-12-05 21:50:01 +01002207 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002208 while (argc > 0)
2209 clear_tv(&argv[--argc]);
2210
2211 return r;
2212}
2213
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002214static int callback_depth = 0;
2215
2216 int
2217get_callback_depth(void)
2218{
2219 return callback_depth;
2220}
2221
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002222/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002223 * Invoke call_func() with a callback.
2224 */
2225 int
2226call_callback(
2227 callback_T *callback,
2228 int len, // length of "name" or -1 to use strlen()
2229 typval_T *rettv, // return value goes here
2230 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002231 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002232 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002233{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002234 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002235 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002236
Bram Moolenaara80faa82020-04-12 19:37:17 +02002237 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002238 funcexe.evaluate = TRUE;
2239 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002240 ++callback_depth;
2241 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2242 --callback_depth;
2243 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002244}
2245
2246/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002247 * Give an error message for the result of a function.
2248 * Nothing if "error" is FCERR_NONE.
2249 */
2250 void
2251user_func_error(int error, char_u *name)
2252{
2253 switch (error)
2254 {
2255 case FCERR_UNKNOWN:
2256 emsg_funcname(e_unknownfunc, name);
2257 break;
2258 case FCERR_NOTMETHOD:
2259 emsg_funcname(
2260 N_("E276: Cannot use function as a method: %s"), name);
2261 break;
2262 case FCERR_DELETED:
2263 emsg_funcname(N_(e_func_deleted), name);
2264 break;
2265 case FCERR_TOOMANY:
2266 emsg_funcname((char *)e_toomanyarg, name);
2267 break;
2268 case FCERR_TOOFEW:
2269 emsg_funcname((char *)e_toofewarg, name);
2270 break;
2271 case FCERR_SCRIPT:
2272 emsg_funcname(
2273 N_("E120: Using <SID> not in a script context: %s"), name);
2274 break;
2275 case FCERR_DICT:
2276 emsg_funcname(
2277 N_("E725: Calling dict function without Dictionary: %s"),
2278 name);
2279 break;
2280 }
2281}
2282
2283/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002285 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 * Return FAIL when the function can't be called, OK otherwise.
2287 * Also returns OK when an error was encountered while executing the function.
2288 */
2289 int
2290call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002291 char_u *funcname, // name of the function
2292 int len, // length of "name" or -1 to use strlen()
2293 typval_T *rettv, // return value goes here
2294 int argcount_in, // number of "argvars"
2295 typval_T *argvars_in, // vars for arguments, must have "argcount"
2296 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002297 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298{
2299 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002300 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002302 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 char_u fname_buf[FLEN_FIXED + 1];
2304 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002305 char_u *fname = NULL;
2306 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002307 int argcount = argcount_in;
2308 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002309 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002310 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2311 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002312 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002313 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002314 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002315
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002316 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2317 // even when call_func() returns FAIL.
2318 rettv->v_type = VAR_UNKNOWN;
2319
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002320 if (partial != NULL)
2321 fp = partial->pt_func;
2322 if (fp == NULL)
2323 {
2324 // Make a copy of the name, if it comes from a funcref variable it
2325 // could be changed or deleted in the called function.
2326 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2327 if (name == NULL)
2328 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002329
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002330 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2331 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002333 if (funcexe->doesrange != NULL)
2334 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002335
2336 if (partial != NULL)
2337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002338 // When the function has a partial with a dict and there is a dict
2339 // argument, use the dict argument. That is backwards compatible.
2340 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002341 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002342 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002343 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 {
2345 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002346 {
2347 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2348 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002349 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002350 goto theend;
2351 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002353 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002354 for (i = 0; i < argcount_in; ++i)
2355 argv[i + argv_clear] = argvars_in[i];
2356 argvars = argv;
2357 argcount = partial->pt_argc + argcount_in;
2358 }
2359 }
2360
Bram Moolenaaref140542019-12-31 21:27:13 +01002361 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362 {
2363 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002364 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002365
Bram Moolenaar333894b2020-08-01 18:53:07 +02002366 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002367 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002368 {
2369 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002370 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372
Bram Moolenaare38eab22019-12-05 21:50:01 +01002373 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002374 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002375 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002377 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378 {
2379 /*
2380 * User defined function.
2381 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002382 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002383 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384
Bram Moolenaare38eab22019-12-05 21:50:01 +01002385 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002386 if (fp == NULL
2387 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002388 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002389 && !aborting())
2390 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002391 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002392 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002394 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002395 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2396 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002397 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002398 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002400 if (fp == NULL)
2401 {
2402 char_u *p = untrans_function_name(rfname);
2403
2404 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002405 // Don't do this if the name starts with "s:".
2406 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002407 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002408 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002410 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002411 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002412#ifdef FEAT_LUA
2413 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2414 {
2415 cfunc_T cb = fp->uf_cb;
2416
2417 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2418 }
2419#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002420 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002422 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002423 // postponed filling in the arguments, do it now
2424 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002425 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002426
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002427 if (funcexe->basetv != NULL)
2428 {
2429 // Method call: base->Method()
2430 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2431 argv[0] = *funcexe->basetv;
2432 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002433 argvars = argv;
2434 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002435 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002436
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002437 error = call_user_func_check(fp, argcount, argvars, rettv,
2438 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439 }
2440 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002441 else if (funcexe->basetv != NULL)
2442 {
2443 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002444 * expr->method(): Find the method name in the table, call its
2445 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002446 */
2447 error = call_internal_method(fname, argcount, argvars, rettv,
2448 funcexe->basetv);
2449 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 else
2451 {
2452 /*
2453 * Find the function name in the table, call its implementation.
2454 */
2455 error = call_internal_func(fname, argcount, argvars, rettv);
2456 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002457
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458 /*
2459 * The function call (or "FuncUndefined" autocommand sequence) might
2460 * have been aborted by an error, an interrupt, or an explicitly thrown
2461 * exception that has not been caught so far. This situation can be
2462 * tested for by calling aborting(). For an error in an internal
2463 * function or for the "E132" error in call_user_func(), however, the
2464 * throw point at which the "force_abort" flag (temporarily reset by
2465 * emsg()) is normally updated has not been reached yet. We need to
2466 * update that flag first to make aborting() reliable.
2467 */
2468 update_force_abort();
2469 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002470 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 ret = OK;
2472
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002473theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 /*
2475 * Report an error unless the argument evaluation or function call has been
2476 * cancelled due to an aborting error, an interrupt, or an exception.
2477 */
2478 if (!aborting())
2479 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002480 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 }
2482
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002483 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002485 clear_tv(&argv[--argv_clear + argv_base]);
2486
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 vim_free(tofree);
2488 vim_free(name);
2489
2490 return ret;
2491}
2492
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002493 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002494printable_func_name(ufunc_T *fp)
2495{
2496 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2497}
2498
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002500 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 */
2502 static void
2503list_func_head(ufunc_T *fp, int indent)
2504{
2505 int j;
2506
2507 msg_start();
2508 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002509 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002510 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002511 msg_puts("def ");
2512 else
2513 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002514 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515 msg_putchar('(');
2516 for (j = 0; j < fp->uf_args.ga_len; ++j)
2517 {
2518 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002519 msg_puts(", ");
2520 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002521 if (fp->uf_arg_types != NULL)
2522 {
2523 char *tofree;
2524
2525 msg_puts(": ");
2526 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2527 vim_free(tofree);
2528 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002529 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2530 {
2531 msg_puts(" = ");
2532 msg_puts(((char **)(fp->uf_def_args.ga_data))
2533 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2534 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 }
2536 if (fp->uf_varargs)
2537 {
2538 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002539 msg_puts(", ");
2540 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002542 if (fp->uf_va_name != NULL)
2543 {
2544 if (j)
2545 msg_puts(", ");
2546 msg_puts("...");
2547 msg_puts((char *)fp->uf_va_name);
2548 if (fp->uf_va_type)
2549 {
2550 char *tofree;
2551
2552 msg_puts(": ");
2553 msg_puts(type_name(fp->uf_va_type, &tofree));
2554 vim_free(tofree);
2555 }
2556 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002558
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002559 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002560 {
2561 if (fp->uf_ret_type != &t_void)
2562 {
2563 char *tofree;
2564
2565 msg_puts(": ");
2566 msg_puts(type_name(fp->uf_ret_type, &tofree));
2567 vim_free(tofree);
2568 }
2569 }
2570 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002571 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002573 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002575 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002576 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002577 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 msg_clr_eos();
2579 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002580 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581}
2582
2583/*
2584 * Get a function name, translating "<SID>" and "<SNR>".
2585 * Also handles a Funcref in a List or Dictionary.
2586 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002587 * Set "*is_global" to TRUE when the function must be global, unless
2588 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002589 * flags:
2590 * TFN_INT: internal function name OK
2591 * TFN_QUIET: be quiet
2592 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002593 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002594 * Advances "pp" to just after the function name (if no error).
2595 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002596 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002597trans_function_name(
2598 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002599 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002600 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002602 funcdict_T *fdp, // return: info about dictionary used
2603 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002604{
2605 char_u *name = NULL;
2606 char_u *start;
2607 char_u *end;
2608 int lead;
2609 char_u sid_buf[20];
2610 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002611 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002612 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002613 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002614 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615
2616 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002617 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 start = *pp;
2619
Bram Moolenaare38eab22019-12-05 21:50:01 +01002620 // Check for hard coded <SNR>: already translated function ID (from a user
2621 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2623 && (*pp)[2] == (int)KE_SNR)
2624 {
2625 *pp += 3;
2626 len = get_id_len(pp) + 3;
2627 return vim_strnsave(start, len);
2628 }
2629
Bram Moolenaare38eab22019-12-05 21:50:01 +01002630 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2631 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 lead = eval_fname_script(start);
2633 if (lead > 2)
2634 start += lead;
2635
Bram Moolenaare38eab22019-12-05 21:50:01 +01002636 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002637 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 lead > 2 ? 0 : FNE_CHECK_START);
2639 if (end == start)
2640 {
2641 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002642 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 goto theend;
2644 }
2645 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2646 {
2647 /*
2648 * Report an invalid expression in braces, unless the expression
2649 * evaluation has been cancelled due to an aborting error, an
2650 * interrupt, or an exception.
2651 */
2652 if (!aborting())
2653 {
2654 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002655 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 }
2657 else
2658 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2659 goto theend;
2660 }
2661
2662 if (lv.ll_tv != NULL)
2663 {
2664 if (fdp != NULL)
2665 {
2666 fdp->fd_dict = lv.ll_dict;
2667 fdp->fd_newkey = lv.ll_newkey;
2668 lv.ll_newkey = NULL;
2669 fdp->fd_di = lv.ll_di;
2670 }
2671 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2672 {
2673 name = vim_strsave(lv.ll_tv->vval.v_string);
2674 *pp = end;
2675 }
2676 else if (lv.ll_tv->v_type == VAR_PARTIAL
2677 && lv.ll_tv->vval.v_partial != NULL)
2678 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002679 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680 *pp = end;
2681 if (partial != NULL)
2682 *partial = lv.ll_tv->vval.v_partial;
2683 }
2684 else
2685 {
2686 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2687 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002688 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 else
2690 *pp = end;
2691 name = NULL;
2692 }
2693 goto theend;
2694 }
2695
2696 if (lv.ll_name == NULL)
2697 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002698 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 *pp = end;
2700 goto theend;
2701 }
2702
Bram Moolenaare38eab22019-12-05 21:50:01 +01002703 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 if (lv.ll_exp_name != NULL)
2705 {
2706 len = (int)STRLEN(lv.ll_exp_name);
2707 name = deref_func_name(lv.ll_exp_name, &len, partial,
2708 flags & TFN_NO_AUTOLOAD);
2709 if (name == lv.ll_exp_name)
2710 name = NULL;
2711 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002712 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002713 {
2714 len = (int)(end - *pp);
2715 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2716 if (name == *pp)
2717 name = NULL;
2718 }
2719 if (name != NULL)
2720 {
2721 name = vim_strsave(name);
2722 *pp = end;
2723 if (STRNCMP(name, "<SNR>", 5) == 0)
2724 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002725 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002726 name[0] = K_SPECIAL;
2727 name[1] = KS_EXTRA;
2728 name[2] = (int)KE_SNR;
2729 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2730 }
2731 goto theend;
2732 }
2733
2734 if (lv.ll_exp_name != NULL)
2735 {
2736 len = (int)STRLEN(lv.ll_exp_name);
2737 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2738 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2739 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002740 // When there was "s:" already or the name expanded to get a
2741 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 lv.ll_name += 2;
2743 len -= 2;
2744 lead = 2;
2745 }
2746 }
2747 else
2748 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002749 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002751 {
2752 if (is_global != NULL && lv.ll_name[0] == 'g')
2753 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002755 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 len = (int)(end - lv.ll_name);
2757 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002758 if (len <= 0)
2759 {
2760 if (!skip)
2761 emsg(_(e_function_name));
2762 goto theend;
2763 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002765 // In Vim9 script a user function is script-local by default, unless it
2766 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002767 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002768 if (vim9script)
2769 {
2770 char_u *p;
2771
2772 // SomeScript#func() is a global function.
2773 for (p = start; *p != NUL && *p != '('; ++p)
2774 if (*p == AUTOLOAD_CHAR)
2775 vim9script = FALSE;
2776 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002777
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 /*
2779 * Copy the function name to allocated memory.
2780 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2781 * Accept <SNR>123_name() outside a script.
2782 */
2783 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002784 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002785 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002787 if (!vim9script)
2788 lead = 3;
2789 if (vim9script || (lv.ll_exp_name != NULL
2790 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791 || eval_fname_sid(*pp))
2792 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002793 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002794 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002796 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 goto theend;
2798 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002799 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002800 if (vim9script)
2801 extra = 3 + (int)STRLEN(sid_buf);
2802 else
2803 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 }
2805 }
2806 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2807 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002808 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 start);
2810 goto theend;
2811 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002812 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 {
2814 char_u *cp = vim_strchr(lv.ll_name, ':');
2815
2816 if (cp != NULL && cp < end)
2817 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002818 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 goto theend;
2820 }
2821 }
2822
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002823 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 if (name != NULL)
2825 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002826 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 {
2828 name[0] = K_SPECIAL;
2829 name[1] = KS_EXTRA;
2830 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002831 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 STRCPY(name + 3, sid_buf);
2833 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002834 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2835 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836 }
2837 *pp = end;
2838
2839theend:
2840 clear_lval(&lv);
2841 return name;
2842}
2843
2844/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002845 * Assuming "name" is the result of trans_function_name() and it was prefixed
2846 * to use the script-local name, return the unmodified name (points into
2847 * "name"). Otherwise return NULL.
2848 * This can be used to first search for a script-local function and fall back
2849 * to the global function if not found.
2850 */
2851 char_u *
2852untrans_function_name(char_u *name)
2853{
2854 char_u *p;
2855
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002856 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002857 {
2858 p = vim_strchr(name, '_');
2859 if (p != NULL)
2860 return p + 1;
2861 }
2862 return NULL;
2863}
2864
2865/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002866 * List functions. When "regmatch" is NULL all of then.
2867 * Otherwise functions matching "regmatch".
2868 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002869 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002870list_functions(regmatch_T *regmatch)
2871{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002872 int changed = func_hashtab.ht_changed;
2873 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002874 hashitem_T *hi;
2875
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002876 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002877 {
2878 if (!HASHITEM_EMPTY(hi))
2879 {
2880 ufunc_T *fp = HI2UF(hi);
2881
2882 --todo;
2883 if ((fp->uf_flags & FC_DEAD) == 0
2884 && (regmatch == NULL
2885 ? !message_filtered(fp->uf_name)
2886 && !func_name_refcount(fp->uf_name)
2887 : !isdigit(*fp->uf_name)
2888 && vim_regexec(regmatch, fp->uf_name, 0)))
2889 {
2890 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002891 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002892 {
2893 emsg(_("E454: function list was modified"));
2894 return;
2895 }
2896 }
2897 }
2898 }
2899}
2900
2901/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002902 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002903 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2904 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002905 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002907 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002908define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002909{
2910 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002911 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912 int j;
2913 int c;
2914 int saved_did_emsg;
2915 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002916 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002917 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918 char_u *p;
2919 char_u *arg;
2920 char_u *line_arg = NULL;
2921 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002922 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002923 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 garray_T newlines;
2925 int varargs = FALSE;
2926 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002927 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002928 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002929 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930 int indent;
2931 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002932#define MAX_FUNC_NESTING 50
2933 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002934 dictitem_T *v;
2935 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002936 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002937 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002939 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002940 linenr_T sourcing_lnum_off;
2941 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002942 int is_heredoc = FALSE;
2943 char_u *skip_until = NULL;
2944 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002945 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002946 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002947
2948 /*
2949 * ":function" without argument: list functions.
2950 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002951 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 {
2953 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002954 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002956 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002957 }
2958
2959 /*
2960 * ":function /pat": list functions matching pattern.
2961 */
2962 if (*eap->arg == '/')
2963 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002964 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 if (!eap->skip)
2966 {
2967 regmatch_T regmatch;
2968
2969 c = *p;
2970 *p = NUL;
2971 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2972 *p = c;
2973 if (regmatch.regprog != NULL)
2974 {
2975 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002976 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002977 vim_regfree(regmatch.regprog);
2978 }
2979 }
2980 if (*p == '/')
2981 ++p;
2982 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002983 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984 }
2985
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002986 ga_init(&newargs);
2987 ga_init(&argtypes);
2988 ga_init(&default_args);
2989
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002990 /*
2991 * Get the function name. There are these situations:
2992 * func normal function name
2993 * "name" == func, "fudi.fd_dict" == NULL
2994 * dict.func new dictionary entry
2995 * "name" == NULL, "fudi.fd_dict" set,
2996 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2997 * dict.func existing dict entry with a Funcref
2998 * "name" == func, "fudi.fd_dict" set,
2999 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3000 * dict.func existing dict entry that's not a Funcref
3001 * "name" == NULL, "fudi.fd_dict" set,
3002 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3003 * s:func script-local function name
3004 * g:func global function name, same as "func"
3005 */
3006 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003007 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003009 // nested function, argument is (args).
3010 paren = TRUE;
3011 CLEAR_FIELD(fudi);
3012 }
3013 else
3014 {
3015 name = trans_function_name(&p, &is_global, eap->skip,
3016 TFN_NO_AUTOLOAD, &fudi, NULL);
3017 paren = (vim_strchr(p, '(') != NULL);
3018 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003020 /*
3021 * Return on an invalid expression in braces, unless the expression
3022 * evaluation has been cancelled due to an aborting error, an
3023 * interrupt, or an exception.
3024 */
3025 if (!aborting())
3026 {
3027 if (!eap->skip && fudi.fd_newkey != NULL)
3028 semsg(_(e_dictkey), fudi.fd_newkey);
3029 vim_free(fudi.fd_newkey);
3030 return NULL;
3031 }
3032 else
3033 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 }
3036
Bram Moolenaare38eab22019-12-05 21:50:01 +01003037 // An error in a function call during evaluation of an expression in magic
3038 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 saved_did_emsg = did_emsg;
3040 did_emsg = FALSE;
3041
3042 /*
3043 * ":function func" with only function name: list function.
3044 */
3045 if (!paren)
3046 {
3047 if (!ends_excmd(*skipwhite(p)))
3048 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003049 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 goto ret_free;
3051 }
3052 eap->nextcmd = check_nextcmd(p);
3053 if (eap->nextcmd != NULL)
3054 *p = NUL;
3055 if (!eap->skip && !got_int)
3056 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003057 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003058 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3059 {
3060 char_u *up = untrans_function_name(name);
3061
3062 // With Vim9 script the name was made script-local, if not
3063 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003064 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003065 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003066 }
3067
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 if (fp != NULL)
3069 {
3070 list_func_head(fp, TRUE);
3071 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3072 {
3073 if (FUNCLINE(fp, j) == NULL)
3074 continue;
3075 msg_putchar('\n');
3076 msg_outnum((long)(j + 1));
3077 if (j < 9)
3078 msg_putchar(' ');
3079 if (j < 99)
3080 msg_putchar(' ');
3081 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003082 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003083 ui_breakcheck();
3084 }
3085 if (!got_int)
3086 {
3087 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003088 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003089 msg_puts(" enddef");
3090 else
3091 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 }
3093 }
3094 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003095 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 }
3097 goto ret_free;
3098 }
3099
3100 /*
3101 * ":function name(arg1, arg2)" Define function.
3102 */
3103 p = skipwhite(p);
3104 if (*p != '(')
3105 {
3106 if (!eap->skip)
3107 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003108 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 goto ret_free;
3110 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003111 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 if (vim_strchr(p, '(') != NULL)
3113 p = vim_strchr(p, '(');
3114 }
3115 p = skipwhite(p + 1);
3116
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003117 // In Vim9 script only global functions can be redefined.
3118 if (vim9script && eap->forceit && !is_global)
3119 {
3120 emsg(_(e_nobang));
3121 goto ret_free;
3122 }
3123
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3125
Bram Moolenaar04b12692020-05-04 23:24:44 +02003126 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003128 // Check the name of the function. Unless it's a dictionary function
3129 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 if (name != NULL)
3131 arg = name;
3132 else
3133 arg = fudi.fd_newkey;
3134 if (arg != NULL && (fudi.fd_di == NULL
3135 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3136 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3137 {
3138 if (*arg == K_SPECIAL)
3139 j = 3;
3140 else
3141 j = 0;
3142 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3143 : eval_isnamec(arg[j])))
3144 ++j;
3145 if (arg[j] != NUL)
3146 emsg_funcname((char *)e_invarg2, arg);
3147 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003148 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003149 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003150 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 }
3152
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003153 // This may get more lines and make the pointers into the first line
3154 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003155 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003156 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003157 &varargs, &default_args, eap->skip,
3158 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159 goto errret_2;
3160
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003161 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003163 // find the return type: :def Func(): type
3164 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003166 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003167 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003168 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003169 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003170 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003171 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003172 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003173 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003174 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003175 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003176 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003177 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003179 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003181 else
3182 // find extra arguments "range", "dict", "abort" and "closure"
3183 for (;;)
3184 {
3185 p = skipwhite(p);
3186 if (STRNCMP(p, "range", 5) == 0)
3187 {
3188 flags |= FC_RANGE;
3189 p += 5;
3190 }
3191 else if (STRNCMP(p, "dict", 4) == 0)
3192 {
3193 flags |= FC_DICT;
3194 p += 4;
3195 }
3196 else if (STRNCMP(p, "abort", 5) == 0)
3197 {
3198 flags |= FC_ABORT;
3199 p += 5;
3200 }
3201 else if (STRNCMP(p, "closure", 7) == 0)
3202 {
3203 flags |= FC_CLOSURE;
3204 p += 7;
3205 if (current_funccal == NULL)
3206 {
3207 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3208 name == NULL ? (char_u *)"" : name);
3209 goto erret;
3210 }
3211 }
3212 else
3213 break;
3214 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215
Bram Moolenaare38eab22019-12-05 21:50:01 +01003216 // When there is a line break use what follows for the function body.
3217 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218 if (*p == '\n')
3219 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003220 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003221 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3222 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003223 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3224 && !eap->skip
3225 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003226 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227
3228 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003229 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3230 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 */
3232 if (KeyTyped)
3233 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003234 // Check if the function already exists, don't let the user type the
3235 // whole function before telling him it doesn't work! For a script we
3236 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237 if (!eap->skip && !eap->forceit)
3238 {
3239 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003240 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003241 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242 emsg_funcname(e_funcexts, name);
3243 }
3244
3245 if (!eap->skip && did_emsg)
3246 goto erret;
3247
Bram Moolenaare38eab22019-12-05 21:50:01 +01003248 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 cmdline_row = msg_row;
3250 }
3251
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003252 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003253 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003254
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003255 // Detect having skipped over comment lines to find the return
3256 // type. Add NULL lines to keep the line count correct.
3257 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3258 if (SOURCING_LNUM < sourcing_lnum_off)
3259 {
3260 sourcing_lnum_off -= SOURCING_LNUM;
3261 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3262 goto erret;
3263 while (sourcing_lnum_off-- > 0)
3264 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3265 }
3266
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 indent = 2;
3268 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003269 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 for (;;)
3271 {
3272 if (KeyTyped)
3273 {
3274 msg_scroll = TRUE;
3275 saved_wait_return = FALSE;
3276 }
3277 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278
3279 if (line_arg != NULL)
3280 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003281 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 theline = line_arg;
3283 p = vim_strchr(theline, '\n');
3284 if (p == NULL)
3285 line_arg += STRLEN(line_arg);
3286 else
3287 {
3288 *p = NUL;
3289 line_arg = p + 1;
3290 }
3291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003293 {
3294 vim_free(line_to_free);
3295 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003296 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003297 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003298 theline = eap->getline(':', eap->cookie, indent,
3299 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003300 line_to_free = theline;
3301 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003302 if (KeyTyped)
3303 lines_left = Rows - 1;
3304 if (theline == NULL)
3305 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003306 if (skip_until != NULL)
3307 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3308 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003309 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 else
3311 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003312 goto erret;
3313 }
3314
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003315 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003316 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003317 if (SOURCING_LNUM < sourcing_lnum_off)
3318 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319 else
3320 sourcing_lnum_off = 0;
3321
3322 if (skip_until != NULL)
3323 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003324 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003325 // * ":append" and "."
3326 // * ":python <<EOF" and "EOF"
3327 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3328 if (heredoc_trimmed == NULL
3329 || (is_heredoc && skipwhite(theline) == theline)
3330 || STRNCMP(theline, heredoc_trimmed,
3331 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003332 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003333 if (heredoc_trimmed == NULL)
3334 p = theline;
3335 else if (is_heredoc)
3336 p = skipwhite(theline) == theline
3337 ? theline : theline + STRLEN(heredoc_trimmed);
3338 else
3339 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003340 if (STRCMP(p, skip_until) == 0)
3341 {
3342 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003343 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003344 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003345 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003346 }
3347 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 }
3349 else
3350 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003351 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003352 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 ;
3354
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003355 // Check for "endfunction" or "enddef".
3356 if (checkforcmd(&p, nesting_def[nesting]
3357 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003359 char_u *nextcmd = NULL;
3360
Bram Moolenaar663bb232017-06-22 19:12:10 +02003361 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003362 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003363 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003364 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003365 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003366 give_warning2(eap->cmdidx == CMD_def
3367 ? (char_u *)_("W1001: Text found after :enddef: %s")
3368 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003369 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003370 if (nextcmd != NULL)
3371 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003372 // Another command follows. If the line came from "eap" we
3373 // can simply point into it, otherwise we need to change
3374 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003375 eap->nextcmd = nextcmd;
3376 if (line_to_free != NULL)
3377 {
3378 vim_free(*eap->cmdlinep);
3379 *eap->cmdlinep = line_to_free;
3380 line_to_free = NULL;
3381 }
3382 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003383 break;
3384 }
3385
Bram Moolenaare38eab22019-12-05 21:50:01 +01003386 // Increase indent inside "if", "while", "for" and "try", decrease
3387 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003388 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 indent -= 2;
3390 else if (STRNCMP(p, "if", 2) == 0
3391 || STRNCMP(p, "wh", 2) == 0
3392 || STRNCMP(p, "for", 3) == 0
3393 || STRNCMP(p, "try", 3) == 0)
3394 indent += 2;
3395
Bram Moolenaare38eab22019-12-05 21:50:01 +01003396 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003397 // Only recognize "def" inside "def", not inside "function",
3398 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003399 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003400 if (checkforcmd(&p, "function", 2)
3401 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402 {
3403 if (*p == '!')
3404 p = skipwhite(p + 1);
3405 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003406 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407 if (*skipwhite(p) == '(')
3408 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003409 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003410 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003411 else
3412 {
3413 ++nesting;
3414 nesting_def[nesting] = (c == 'd');
3415 indent += 2;
3416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 }
3418 }
3419
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003420 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003421 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003422 if (eap->cmdidx != CMD_def
3423 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003424 || (p[0] == 'c'
3425 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3426 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3427 && (STRNCMP(&p[3], "nge", 3) != 0
3428 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 || (p[0] == 'i'
3430 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003431 && (!ASCII_ISALPHA(p[2])
3432 || (p[2] == 's'
3433 && (!ASCII_ISALPHA(p[3])
3434 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 skip_until = vim_strsave((char_u *)".");
3436
Bram Moolenaare38eab22019-12-05 21:50:01 +01003437 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438 arg = skipwhite(skiptowhite(p));
3439 if (arg[0] == '<' && arg[1] =='<'
3440 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003441 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3442 || ((p[2] == '3' || p[2] == 'x')
3443 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 || (p[0] == 'p' && p[1] == 'e'
3445 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3446 || (p[0] == 't' && p[1] == 'c'
3447 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3448 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3449 && !ASCII_ISALPHA(p[3]))
3450 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3451 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3452 || (p[0] == 'm' && p[1] == 'z'
3453 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3454 ))
3455 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003456 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003458 if (STRNCMP(p, "trim", 4) == 0)
3459 {
3460 // Ignore leading white space.
3461 p = skipwhite(p + 4);
3462 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003463 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003464 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 if (*p == NUL)
3466 skip_until = vim_strsave((char_u *)".");
3467 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003468 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003469 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003470 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003472
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003473 // Check for ":cmd v =<< [trim] EOF"
3474 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003475 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003476 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003477 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003478 if (*arg == '[')
3479 arg = vim_strchr(arg, ']');
3480 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003481 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003482 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3483 && arg[1] == '<' && arg[2] =='<');
3484
3485 if (!found)
3486 // skip over the argument after "cmd"
3487 arg = skipwhite(skiptowhite(arg));
3488 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003489 && (checkforcmd(&p, "let", 2)
3490 || checkforcmd(&p, "var", 3)
3491 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003492 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003493 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003494 p = skipwhite(arg + 3);
3495 if (STRNCMP(p, "trim", 4) == 0)
3496 {
3497 // Ignore leading white space.
3498 p = skipwhite(p + 4);
3499 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003500 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003501 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003502 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003503 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003504 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003505 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003506 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 }
3508
Bram Moolenaare38eab22019-12-05 21:50:01 +01003509 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512
Bram Moolenaare38eab22019-12-05 21:50:01 +01003513 // Copy the line to newly allocated memory. get_one_sourceline()
3514 // allocates 250 bytes per line, this saves 80% on average. The cost
3515 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003517 if (p == NULL)
3518 goto erret;
3519 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520
Bram Moolenaare38eab22019-12-05 21:50:01 +01003521 // Add NULL lines for continuation lines, so that the line count is
3522 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 while (sourcing_lnum_off-- > 0)
3524 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3525
Bram Moolenaare38eab22019-12-05 21:50:01 +01003526 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003527 if (line_arg != NULL && *line_arg == NUL)
3528 line_arg = NULL;
3529 }
3530
Bram Moolenaare38eab22019-12-05 21:50:01 +01003531 // Don't define the function when skipping commands or when an error was
3532 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 if (eap->skip || did_emsg)
3534 goto erret;
3535
3536 /*
3537 * If there are no errors, add the function
3538 */
3539 if (fudi.fd_dict == NULL)
3540 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003541 hashtab_T *ht;
3542
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 v = find_var(name, &ht, FALSE);
3544 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3545 {
3546 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3547 name);
3548 goto erret;
3549 }
3550
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003551 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003552 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003554 char_u *uname = untrans_function_name(name);
3555
3556 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3557 }
3558
3559 if (fp != NULL || import != NULL)
3560 {
3561 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003562
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003563 // Function can be replaced with "function!" and when sourcing the
3564 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003565 // A name that is used by an import can not be overruled.
3566 if (import != NULL
3567 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003568 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003569 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003571 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003572 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003573 else
3574 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 goto erret;
3576 }
3577 if (fp->uf_calls > 0)
3578 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003579 emsg_funcname(
3580 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 name);
3582 goto erret;
3583 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003584 if (fp->uf_refcount > 1)
3585 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003586 // This function is referenced somewhere, don't redefine it but
3587 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003588 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003589 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003590 fp = NULL;
3591 overwrite = TRUE;
3592 }
3593 else
3594 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003595 char_u *exp_name = fp->uf_name_exp;
3596
3597 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003598 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003599 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003600 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003601 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003602 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003603#ifdef FEAT_PROFILE
3604 fp->uf_profiling = FALSE;
3605 fp->uf_prof_initialized = FALSE;
3606#endif
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003607 unlink_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003608 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 }
3610 }
3611 else
3612 {
3613 char numbuf[20];
3614
3615 fp = NULL;
3616 if (fudi.fd_newkey == NULL && !eap->forceit)
3617 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003618 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 goto erret;
3620 }
3621 if (fudi.fd_di == NULL)
3622 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003623 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003624 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 goto erret;
3626 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003627 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003628 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 goto erret;
3630
Bram Moolenaare38eab22019-12-05 21:50:01 +01003631 // Give the function a sequential number. Can only be used with a
3632 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 vim_free(name);
3634 sprintf(numbuf, "%d", ++func_nr);
3635 name = vim_strsave((char_u *)numbuf);
3636 if (name == NULL)
3637 goto erret;
3638 }
3639
3640 if (fp == NULL)
3641 {
3642 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3643 {
3644 int slen, plen;
3645 char_u *scriptname;
3646
Bram Moolenaare38eab22019-12-05 21:50:01 +01003647 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003649 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 {
3651 scriptname = autoload_name(name);
3652 if (scriptname != NULL)
3653 {
3654 p = vim_strchr(scriptname, '/');
3655 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003656 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003658 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 j = OK;
3660 vim_free(scriptname);
3661 }
3662 }
3663 if (j == FAIL)
3664 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003665 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666 goto erret;
3667 }
3668 }
3669
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003670 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 if (fp == NULL)
3672 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003673 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003674 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675
3676 if (fudi.fd_dict != NULL)
3677 {
3678 if (fudi.fd_di == NULL)
3679 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003680 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3682 if (fudi.fd_di == NULL)
3683 {
3684 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003685 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686 goto erret;
3687 }
3688 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3689 {
3690 vim_free(fudi.fd_di);
3691 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003692 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 goto erret;
3694 }
3695 }
3696 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003697 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 clear_tv(&fudi.fd_di->di_tv);
3699 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701
Bram Moolenaare38eab22019-12-05 21:50:01 +01003702 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 flags |= FC_DICT;
3704 }
3705
Bram Moolenaare38eab22019-12-05 21:50:01 +01003706 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003707 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003708 if (overwrite)
3709 {
3710 hi = hash_find(&func_hashtab, name);
3711 hi->hi_key = UF2HIKEY(fp);
3712 }
3713 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714 {
3715 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003716 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 goto erret;
3718 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003719 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720 }
3721 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003722 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003723 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003724 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003725
3726 if (eap->cmdidx == CMD_def)
3727 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003728 int lnum_save = SOURCING_LNUM;
3729 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003730
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003731 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003732
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003733 // error messages are for the first function line
3734 SOURCING_LNUM = sourcing_lnum_top;
3735
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003736 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003737 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003738 int count = cstack->cs_idx + 1;
3739 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003740
3741 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003742 // a block that is visible now but not when the function is called
3743 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003744 fp->uf_block_ids = ALLOC_MULT(int, count);
3745 if (fp->uf_block_ids != NULL)
3746 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003747 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003748 sizeof(int) * count);
3749 fp->uf_block_depth = count;
3750 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003751
3752 // Set flag in each block to indicate a function was defined. This
3753 // is used to keep the variable when leaving the block, see
3754 // hide_script_var().
3755 for (i = 0; i <= cstack->cs_idx; ++i)
3756 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003757 }
3758
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003759 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003760 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003761 SOURCING_LNUM = lnum_save;
3762 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003763 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003764 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003765
3766 // parse the return type, if any
3767 if (ret_type == NULL)
3768 fp->uf_ret_type = &t_void;
3769 else
3770 {
3771 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003772 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003773 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003774 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003775 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003776 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003777 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003780 if ((flags & FC_CLOSURE) != 0)
3781 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003782 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003783 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003784 }
3785 else
3786 fp->uf_scoped = NULL;
3787
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789 if (prof_def_func())
3790 func_do_profile(fp);
3791#endif
3792 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003793 if (sandbox)
3794 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003795 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003796 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 fp->uf_flags = flags;
3798 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003799 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003800 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003801 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003802 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003803 if (is_export)
3804 {
3805 fp->uf_flags |= FC_EXPORT;
3806 // let ex_export() know the export worked.
3807 is_export = FALSE;
3808 }
3809
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003810 if (eap->cmdidx == CMD_def)
3811 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003812 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3813 // :func does not use Vim9 script syntax, even in a Vim9 script file
3814 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003815
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 goto ret_free;
3817
3818erret:
3819 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003820 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821errret_2:
3822 ga_clear_strings(&newlines);
3823ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003824 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003826 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003827 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003829 if (name != name_arg)
3830 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003831 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 did_emsg |= saved_did_emsg;
3833 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003834
3835 return fp;
3836}
3837
3838/*
3839 * ":function"
3840 */
3841 void
3842ex_function(exarg_T *eap)
3843{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003844 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003845}
3846
3847/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003848 * :defcompile - compile all :def functions in the current script that need to
3849 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003850 */
3851 void
3852ex_defcompile(exarg_T *eap UNUSED)
3853{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003854 long todo = (long)func_hashtab.ht_used;
3855 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003856 hashitem_T *hi;
3857 ufunc_T *ufunc;
3858
3859 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3860 {
3861 if (!HASHITEM_EMPTY(hi))
3862 {
3863 --todo;
3864 ufunc = HI2UF(hi);
3865 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003866 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3867 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003868 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003869 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003870
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003871 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003872 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003873 // a function has been added or removed, need to start over
3874 todo = (long)func_hashtab.ht_used;
3875 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003876 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003877 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003878 }
3879 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003880 }
3881 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882}
3883
3884/*
3885 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3886 * Return 2 if "p" starts with "s:".
3887 * Return 0 otherwise.
3888 */
3889 int
3890eval_fname_script(char_u *p)
3891{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003892 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3893 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3895 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3896 return 5;
3897 if (p[0] == 's' && p[1] == ':')
3898 return 2;
3899 return 0;
3900}
3901
3902 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003903translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003904{
3905 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003906 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003907 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003908}
3909
3910/*
3911 * Return TRUE when "ufunc" has old-style "..." varargs
3912 * or named varargs "...name: type".
3913 */
3914 int
3915has_varargs(ufunc_T *ufunc)
3916{
3917 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918}
3919
3920/*
3921 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003922 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003923 */
3924 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003925function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926{
3927 char_u *nm = name;
3928 char_u *p;
3929 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003930 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003931 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003933 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3934 if (no_deref)
3935 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003936 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937 nm = skipwhite(nm);
3938
Bram Moolenaare38eab22019-12-05 21:50:01 +01003939 // Only accept "funcname", "funcname ", "funcname (..." and
3940 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003942 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 vim_free(p);
3944 return n;
3945}
3946
Bram Moolenaar113e1072019-01-20 15:30:40 +01003947#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 char_u *
3949get_expanded_name(char_u *name, int check)
3950{
3951 char_u *nm = name;
3952 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003953 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003955 p = trans_function_name(&nm, &is_global, FALSE,
3956 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003958 if (p != NULL && *nm == NUL
3959 && (!check || translated_function_exists(p, is_global)))
3960 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003961
3962 vim_free(p);
3963 return NULL;
3964}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003965#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003967/*
3968 * Function given to ExpandGeneric() to obtain the list of user defined
3969 * function names.
3970 */
3971 char_u *
3972get_user_func_name(expand_T *xp, int idx)
3973{
3974 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003975 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976 static hashitem_T *hi;
3977 ufunc_T *fp;
3978
3979 if (idx == 0)
3980 {
3981 done = 0;
3982 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003983 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003985 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 {
3987 if (done++ > 0)
3988 ++hi;
3989 while (HASHITEM_EMPTY(hi))
3990 ++hi;
3991 fp = HI2UF(hi);
3992
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003993 // don't show dead, dict and lambda functions
3994 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003995 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003996 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003997
3998 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003999 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000
4001 cat_func_name(IObuff, fp);
4002 if (xp->xp_context != EXPAND_USER_FUNC)
4003 {
4004 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004005 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006 STRCAT(IObuff, ")");
4007 }
4008 return IObuff;
4009 }
4010 return NULL;
4011}
4012
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004013/*
4014 * ":delfunction {name}"
4015 */
4016 void
4017ex_delfunction(exarg_T *eap)
4018{
4019 ufunc_T *fp = NULL;
4020 char_u *p;
4021 char_u *name;
4022 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004023 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024
4025 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004026 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 vim_free(fudi.fd_newkey);
4028 if (name == NULL)
4029 {
4030 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004031 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 return;
4033 }
4034 if (!ends_excmd(*skipwhite(p)))
4035 {
4036 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004037 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 return;
4039 }
4040 eap->nextcmd = check_nextcmd(p);
4041 if (eap->nextcmd != NULL)
4042 *p = NUL;
4043
4044 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004045 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 vim_free(name);
4047
4048 if (!eap->skip)
4049 {
4050 if (fp == NULL)
4051 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004052 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004053 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 return;
4055 }
4056 if (fp->uf_calls > 0)
4057 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004058 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 return;
4060 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004061 if (fp->uf_flags & FC_VIM9)
4062 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004063 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004064 return;
4065 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066
4067 if (fudi.fd_dict != NULL)
4068 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004069 // Delete the dict item that refers to the function, it will
4070 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4072 }
4073 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004074 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004075 // A normal function (not a numbered function or lambda) has a
4076 // refcount of 1 for the entry in the hashtable. When deleting
4077 // it and the refcount is more than one, it should be kept.
4078 // A numbered function and lambda should be kept if the refcount is
4079 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004080 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004081 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004082 // Function is still referenced somewhere. Don't free it but
4083 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004084 if (func_remove(fp))
4085 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004086 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004087 }
4088 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004089 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004090 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091 }
4092}
4093
4094/*
4095 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004096 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 */
4098 void
4099func_unref(char_u *name)
4100{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004101 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004103 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004105 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004106 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004109 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004111 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004113 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004114 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004115 // Only delete it when it's not being used. Otherwise it's done
4116 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004117 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004118 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004119 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004120}
4121
4122/*
4123 * Unreference a Function: decrement the reference count and free it when it
4124 * becomes zero.
4125 */
4126 void
4127func_ptr_unref(ufunc_T *fp)
4128{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004129 if (fp != NULL && --fp->uf_refcount <= 0)
4130 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004131 // Only delete it when it's not being used. Otherwise it's done
4132 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004133 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004134 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135 }
4136}
4137
4138/*
4139 * Count a reference to a Function.
4140 */
4141 void
4142func_ref(char_u *name)
4143{
4144 ufunc_T *fp;
4145
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004146 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004148 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004149 if (fp != NULL)
4150 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004152 // Only give an error for a numbered function.
4153 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004154 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004155}
4156
4157/*
4158 * Count a reference to a Function.
4159 */
4160 void
4161func_ptr_ref(ufunc_T *fp)
4162{
4163 if (fp != NULL)
4164 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165}
4166
4167/*
4168 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4169 * referenced from anywhere that is in use.
4170 */
4171 static int
4172can_free_funccal(funccall_T *fc, int copyID)
4173{
4174 return (fc->l_varlist.lv_copyID != copyID
4175 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004176 && fc->l_avars.dv_copyID != copyID
4177 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178}
4179
4180/*
4181 * ":return [expr]"
4182 */
4183 void
4184ex_return(exarg_T *eap)
4185{
4186 char_u *arg = eap->arg;
4187 typval_T rettv;
4188 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004189 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190
4191 if (current_funccal == NULL)
4192 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004193 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 return;
4195 }
4196
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004197 CLEAR_FIELD(evalarg);
4198 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4199
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004200 if (eap->skip)
4201 ++emsg_skip;
4202
4203 eap->nextcmd = NULL;
4204 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004205 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 {
4207 if (!eap->skip)
4208 returning = do_return(eap, FALSE, TRUE, &rettv);
4209 else
4210 clear_tv(&rettv);
4211 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004212 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004213 else if (!eap->skip)
4214 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004215 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004216 update_force_abort();
4217
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218 /*
4219 * Return unless the expression evaluation has been cancelled due to an
4220 * aborting error, an interrupt, or an exception.
4221 */
4222 if (!aborting())
4223 returning = do_return(eap, FALSE, TRUE, NULL);
4224 }
4225
Bram Moolenaare38eab22019-12-05 21:50:01 +01004226 // When skipping or the return gets pending, advance to the next command
4227 // in this line (!returning). Otherwise, ignore the rest of the line.
4228 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229 if (returning)
4230 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004231 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232 eap->nextcmd = check_nextcmd(arg);
4233
4234 if (eap->skip)
4235 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004236 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237}
4238
4239/*
4240 * ":1,25call func(arg1, arg2)" function call.
4241 */
4242 void
4243ex_call(exarg_T *eap)
4244{
4245 char_u *arg = eap->arg;
4246 char_u *startarg;
4247 char_u *name;
4248 char_u *tofree;
4249 int len;
4250 typval_T rettv;
4251 linenr_T lnum;
4252 int doesrange;
4253 int failed = FALSE;
4254 funcdict_T fudi;
4255 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004256 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257
Bram Moolenaare6b53242020-07-01 17:28:33 +02004258 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259 if (eap->skip)
4260 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004261 // trans_function_name() doesn't work well when skipping, use eval0()
4262 // instead to skip to any following command, e.g. for:
4263 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004265 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 clear_tv(&rettv);
4267 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004268 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004269 return;
4270 }
4271
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004272 tofree = trans_function_name(&arg, NULL, eap->skip,
4273 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274 if (fudi.fd_newkey != NULL)
4275 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004276 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004277 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278 vim_free(fudi.fd_newkey);
4279 }
4280 if (tofree == NULL)
4281 return;
4282
Bram Moolenaare38eab22019-12-05 21:50:01 +01004283 // Increase refcount on dictionary, it could get deleted when evaluating
4284 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285 if (fudi.fd_dict != NULL)
4286 ++fudi.fd_dict->dv_refcount;
4287
Bram Moolenaare38eab22019-12-05 21:50:01 +01004288 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4289 // contents. For VAR_PARTIAL get its partial, unless we already have one
4290 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291 len = (int)STRLEN(tofree);
4292 name = deref_func_name(tofree, &len,
4293 partial != NULL ? NULL : &partial, FALSE);
4294
Bram Moolenaare38eab22019-12-05 21:50:01 +01004295 // Skip white space to allow ":call func ()". Not good, but required for
4296 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004298 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299
4300 if (*startarg != '(')
4301 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004302 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 goto end;
4304 }
4305
4306 /*
4307 * When skipping, evaluate the function once, to find the end of the
4308 * arguments.
4309 * When the function takes a range, this is discovered after the first
4310 * call, and the loop is broken.
4311 */
4312 if (eap->skip)
4313 {
4314 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004315 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 }
4317 else
4318 lnum = eap->line1;
4319 for ( ; lnum <= eap->line2; ++lnum)
4320 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004321 funcexe_T funcexe;
4322
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 if (!eap->skip && eap->addr_count > 0)
4324 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004325 if (lnum > curbuf->b_ml.ml_line_count)
4326 {
4327 // If the function deleted lines or switched to another buffer
4328 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004329 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004330 break;
4331 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332 curwin->w_cursor.lnum = lnum;
4333 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004334 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 }
4336 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004337
Bram Moolenaara80faa82020-04-12 19:37:17 +02004338 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004339 funcexe.firstline = eap->line1;
4340 funcexe.lastline = eap->line2;
4341 funcexe.doesrange = &doesrange;
4342 funcexe.evaluate = !eap->skip;
4343 funcexe.partial = partial;
4344 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004345 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 {
4347 failed = TRUE;
4348 break;
4349 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004350 if (has_watchexpr())
4351 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004353 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004354 if (handle_subscript(&arg, &rettv,
4355 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004356 {
4357 failed = TRUE;
4358 break;
4359 }
4360
4361 clear_tv(&rettv);
4362 if (doesrange || eap->skip)
4363 break;
4364
Bram Moolenaare38eab22019-12-05 21:50:01 +01004365 // Stop when immediately aborting on error, or when an interrupt
4366 // occurred or an exception was thrown but not caught.
4367 // get_func_tv() returned OK, so that the check for trailing
4368 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004369 if (aborting())
4370 break;
4371 }
4372 if (eap->skip)
4373 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004374 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375
Bram Moolenaare51bb172020-02-16 19:42:23 +01004376 // When inside :try we need to check for following "| catch".
4377 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004379 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004380 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004381 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004383 if (!failed)
4384 {
4385 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004386 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004387 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004388 }
4389 else
4390 eap->nextcmd = check_nextcmd(arg);
4391 }
4392
4393end:
4394 dict_unref(fudi.fd_dict);
4395 vim_free(tofree);
4396}
4397
4398/*
4399 * Return from a function. Possibly makes the return pending. Also called
4400 * for a pending return at the ":endtry" or after returning from an extra
4401 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4402 * when called due to a ":return" command. "rettv" may point to a typval_T
4403 * with the return rettv. Returns TRUE when the return can be carried out,
4404 * FALSE when the return gets pending.
4405 */
4406 int
4407do_return(
4408 exarg_T *eap,
4409 int reanimate,
4410 int is_cmd,
4411 void *rettv)
4412{
4413 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004414 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415
4416 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004417 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 current_funccal->returned = FALSE;
4419
4420 /*
4421 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4422 * not in its finally clause (which then is to be executed next) is found.
4423 * In this case, make the ":return" pending for execution at the ":endtry".
4424 * Otherwise, return normally.
4425 */
4426 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4427 if (idx >= 0)
4428 {
4429 cstack->cs_pending[idx] = CSTP_RETURN;
4430
4431 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004432 // A pending return again gets pending. "rettv" points to an
4433 // allocated variable with the rettv of the original ":return"'s
4434 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004435 cstack->cs_rettv[idx] = rettv;
4436 else
4437 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004438 // When undoing a return in order to make it pending, get the stored
4439 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 if (reanimate)
4441 rettv = current_funccal->rettv;
4442
4443 if (rettv != NULL)
4444 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4447 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4448 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004449 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 }
4451 else
4452 cstack->cs_rettv[idx] = NULL;
4453
4454 if (reanimate)
4455 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004456 // The pending return value could be overwritten by a ":return"
4457 // without argument in a finally clause; reset the default
4458 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 current_funccal->rettv->v_type = VAR_NUMBER;
4460 current_funccal->rettv->vval.v_number = 0;
4461 }
4462 }
4463 report_make_pending(CSTP_RETURN, rettv);
4464 }
4465 else
4466 {
4467 current_funccal->returned = TRUE;
4468
Bram Moolenaare38eab22019-12-05 21:50:01 +01004469 // If the return is carried out now, store the return value. For
4470 // a return immediately after reanimation, the value is already
4471 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 if (!reanimate && rettv != NULL)
4473 {
4474 clear_tv(current_funccal->rettv);
4475 *current_funccal->rettv = *(typval_T *)rettv;
4476 if (!is_cmd)
4477 vim_free(rettv);
4478 }
4479 }
4480
4481 return idx < 0;
4482}
4483
4484/*
4485 * Free the variable with a pending return value.
4486 */
4487 void
4488discard_pending_return(void *rettv)
4489{
4490 free_tv((typval_T *)rettv);
4491}
4492
4493/*
4494 * Generate a return command for producing the value of "rettv". The result
4495 * is an allocated string. Used by report_pending() for verbose messages.
4496 */
4497 char_u *
4498get_return_cmd(void *rettv)
4499{
4500 char_u *s = NULL;
4501 char_u *tofree = NULL;
4502 char_u numbuf[NUMBUFLEN];
4503
4504 if (rettv != NULL)
4505 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4506 if (s == NULL)
4507 s = (char_u *)"";
4508
4509 STRCPY(IObuff, ":return ");
4510 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4511 if (STRLEN(s) + 8 >= IOSIZE)
4512 STRCPY(IObuff + IOSIZE - 4, "...");
4513 vim_free(tofree);
4514 return vim_strsave(IObuff);
4515}
4516
4517/*
4518 * Get next function line.
4519 * Called by do_cmdline() to get the next line.
4520 * Returns allocated string, or NULL for end of function.
4521 */
4522 char_u *
4523get_func_line(
4524 int c UNUSED,
4525 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004526 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004527 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528{
4529 funccall_T *fcp = (funccall_T *)cookie;
4530 ufunc_T *fp = fcp->func;
4531 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004532 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533
Bram Moolenaare38eab22019-12-05 21:50:01 +01004534 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 if (fcp->dbg_tick != debug_tick)
4536 {
4537 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004538 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539 fcp->dbg_tick = debug_tick;
4540 }
4541#ifdef FEAT_PROFILE
4542 if (do_profiling == PROF_YES)
4543 func_line_end(cookie);
4544#endif
4545
4546 gap = &fp->uf_lines;
4547 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4548 || fcp->returned)
4549 retval = NULL;
4550 else
4551 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004552 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004553 while (fcp->linenr < gap->ga_len
4554 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4555 ++fcp->linenr;
4556 if (fcp->linenr >= gap->ga_len)
4557 retval = NULL;
4558 else
4559 {
4560 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004561 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562#ifdef FEAT_PROFILE
4563 if (do_profiling == PROF_YES)
4564 func_line_start(cookie);
4565#endif
4566 }
4567 }
4568
Bram Moolenaare38eab22019-12-05 21:50:01 +01004569 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004570 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004572 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004573 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004575 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 fcp->dbg_tick = debug_tick;
4577 }
4578
4579 return retval;
4580}
4581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582/*
4583 * Return TRUE if the currently active function should be ended, because a
4584 * return was encountered or an error occurred. Used inside a ":while".
4585 */
4586 int
4587func_has_ended(void *cookie)
4588{
4589 funccall_T *fcp = (funccall_T *)cookie;
4590
Bram Moolenaare38eab22019-12-05 21:50:01 +01004591 // Ignore the "abort" flag if the abortion behavior has been changed due to
4592 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4594 || fcp->returned);
4595}
4596
4597/*
4598 * return TRUE if cookie indicates a function which "abort"s on errors.
4599 */
4600 int
4601func_has_abort(
4602 void *cookie)
4603{
4604 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4605}
4606
4607
4608/*
4609 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4610 * Don't do this when "Func" is already a partial that was bound
4611 * explicitly (pt_auto is FALSE).
4612 * Changes "rettv" in-place.
4613 * Returns the updated "selfdict_in".
4614 */
4615 dict_T *
4616make_partial(dict_T *selfdict_in, typval_T *rettv)
4617{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004618 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 char_u *tofree = NULL;
4620 ufunc_T *fp;
4621 char_u fname_buf[FLEN_FIXED + 1];
4622 int error;
4623 dict_T *selfdict = selfdict_in;
4624
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004625 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4626 fp = rettv->vval.v_partial->pt_func;
4627 else
4628 {
4629 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4630 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004631 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004632 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004633 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004634 vim_free(tofree);
4635 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004636
4637 if (fp != NULL && (fp->uf_flags & FC_DICT))
4638 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004639 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004640
4641 if (pt != NULL)
4642 {
4643 pt->pt_refcount = 1;
4644 pt->pt_dict = selfdict;
4645 pt->pt_auto = TRUE;
4646 selfdict = NULL;
4647 if (rettv->v_type == VAR_FUNC)
4648 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004649 // Just a function: Take over the function name and use
4650 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651 pt->pt_name = rettv->vval.v_string;
4652 }
4653 else
4654 {
4655 partial_T *ret_pt = rettv->vval.v_partial;
4656 int i;
4657
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 // Partial: copy the function name, use selfdict and copy
4659 // args. Can't take over name or args, the partial might
4660 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004661 if (ret_pt->pt_name != NULL)
4662 {
4663 pt->pt_name = vim_strsave(ret_pt->pt_name);
4664 func_ref(pt->pt_name);
4665 }
4666 else
4667 {
4668 pt->pt_func = ret_pt->pt_func;
4669 func_ptr_ref(pt->pt_func);
4670 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671 if (ret_pt->pt_argc > 0)
4672 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004673 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004675 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676 pt->pt_argc = 0;
4677 else
4678 {
4679 pt->pt_argc = ret_pt->pt_argc;
4680 for (i = 0; i < pt->pt_argc; i++)
4681 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4682 }
4683 }
4684 partial_unref(ret_pt);
4685 }
4686 rettv->v_type = VAR_PARTIAL;
4687 rettv->vval.v_partial = pt;
4688 }
4689 }
4690 return selfdict;
4691}
4692
4693/*
4694 * Return the name of the executed function.
4695 */
4696 char_u *
4697func_name(void *cookie)
4698{
4699 return ((funccall_T *)cookie)->func->uf_name;
4700}
4701
4702/*
4703 * Return the address holding the next breakpoint line for a funccall cookie.
4704 */
4705 linenr_T *
4706func_breakpoint(void *cookie)
4707{
4708 return &((funccall_T *)cookie)->breakpoint;
4709}
4710
4711/*
4712 * Return the address holding the debug tick for a funccall cookie.
4713 */
4714 int *
4715func_dbg_tick(void *cookie)
4716{
4717 return &((funccall_T *)cookie)->dbg_tick;
4718}
4719
4720/*
4721 * Return the nesting level for a funccall cookie.
4722 */
4723 int
4724func_level(void *cookie)
4725{
4726 return ((funccall_T *)cookie)->level;
4727}
4728
4729/*
4730 * Return TRUE when a function was ended by a ":return" command.
4731 */
4732 int
4733current_func_returned(void)
4734{
4735 return current_funccal->returned;
4736}
4737
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 int
4739free_unref_funccal(int copyID, int testing)
4740{
4741 int did_free = FALSE;
4742 int did_free_funccal = FALSE;
4743 funccall_T *fc, **pfc;
4744
4745 for (pfc = &previous_funccal; *pfc != NULL; )
4746 {
4747 if (can_free_funccal(*pfc, copyID))
4748 {
4749 fc = *pfc;
4750 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004751 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 did_free = TRUE;
4753 did_free_funccal = TRUE;
4754 }
4755 else
4756 pfc = &(*pfc)->caller;
4757 }
4758 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004759 // When a funccal was freed some more items might be garbage
4760 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 (void)garbage_collect(testing);
4762
4763 return did_free;
4764}
4765
4766/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004767 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 */
4769 static funccall_T *
4770get_funccal(void)
4771{
4772 int i;
4773 funccall_T *funccal;
4774 funccall_T *temp_funccal;
4775
4776 funccal = current_funccal;
4777 if (debug_backtrace_level > 0)
4778 {
4779 for (i = 0; i < debug_backtrace_level; i++)
4780 {
4781 temp_funccal = funccal->caller;
4782 if (temp_funccal)
4783 funccal = temp_funccal;
4784 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004785 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 debug_backtrace_level = i;
4787 }
4788 }
4789 return funccal;
4790}
4791
4792/*
4793 * Return the hashtable used for local variables in the current funccal.
4794 * Return NULL if there is no current funccal.
4795 */
4796 hashtab_T *
4797get_funccal_local_ht()
4798{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004799 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 return NULL;
4801 return &get_funccal()->l_vars.dv_hashtab;
4802}
4803
4804/*
4805 * Return the l: scope variable.
4806 * Return NULL if there is no current funccal.
4807 */
4808 dictitem_T *
4809get_funccal_local_var()
4810{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004811 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 return NULL;
4813 return &get_funccal()->l_vars_var;
4814}
4815
4816/*
4817 * Return the hashtable used for argument in the current funccal.
4818 * Return NULL if there is no current funccal.
4819 */
4820 hashtab_T *
4821get_funccal_args_ht()
4822{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004823 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824 return NULL;
4825 return &get_funccal()->l_avars.dv_hashtab;
4826}
4827
4828/*
4829 * Return the a: scope variable.
4830 * Return NULL if there is no current funccal.
4831 */
4832 dictitem_T *
4833get_funccal_args_var()
4834{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004835 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004837 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838}
4839
4840/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841 * List function variables, if there is a function.
4842 */
4843 void
4844list_func_vars(int *first)
4845{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004846 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004848 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849}
4850
4851/*
4852 * If "ht" is the hashtable for local variables in the current funccal, return
4853 * the dict that contains it.
4854 * Otherwise return NULL.
4855 */
4856 dict_T *
4857get_current_funccal_dict(hashtab_T *ht)
4858{
4859 if (current_funccal != NULL
4860 && ht == &current_funccal->l_vars.dv_hashtab)
4861 return &current_funccal->l_vars;
4862 return NULL;
4863}
4864
4865/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004866 * Search hashitem in parent scope.
4867 */
4868 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004869find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004870{
4871 funccall_T *old_current_funccal = current_funccal;
4872 hashtab_T *ht;
4873 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004874 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004875
4876 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4877 return NULL;
4878
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004879 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004880 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004881 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004882 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004883 ht = find_var_ht(name, &varname);
4884 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004885 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004886 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004887 if (!HASHITEM_EMPTY(hi))
4888 {
4889 *pht = ht;
4890 break;
4891 }
4892 }
4893 if (current_funccal == current_funccal->func->uf_scoped)
4894 break;
4895 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004896 }
4897 current_funccal = old_current_funccal;
4898
4899 return hi;
4900}
4901
4902/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004903 * Search variable in parent scope.
4904 */
4905 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004906find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004907{
4908 dictitem_T *v = NULL;
4909 funccall_T *old_current_funccal = current_funccal;
4910 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004911 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004912
4913 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4914 return NULL;
4915
Bram Moolenaare38eab22019-12-05 21:50:01 +01004916 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004917 current_funccal = current_funccal->func->uf_scoped;
4918 while (current_funccal)
4919 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004920 ht = find_var_ht(name, &varname);
4921 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004922 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004923 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004924 if (v != NULL)
4925 break;
4926 }
4927 if (current_funccal == current_funccal->func->uf_scoped)
4928 break;
4929 current_funccal = current_funccal->func->uf_scoped;
4930 }
4931 current_funccal = old_current_funccal;
4932
4933 return v;
4934}
4935
4936/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937 * Set "copyID + 1" in previous_funccal and callers.
4938 */
4939 int
4940set_ref_in_previous_funccal(int copyID)
4941{
4942 int abort = FALSE;
4943 funccall_T *fc;
4944
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004945 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004947 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004948 abort = abort
4949 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4950 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004951 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004952 }
4953 return abort;
4954}
4955
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004956 static int
4957set_ref_in_funccal(funccall_T *fc, int copyID)
4958{
4959 int abort = FALSE;
4960
4961 if (fc->fc_copyID != copyID)
4962 {
4963 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004964 abort = abort
4965 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4966 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004967 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004968 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004969 }
4970 return abort;
4971}
4972
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973/*
4974 * Set "copyID" in all local vars and arguments in the call stack.
4975 */
4976 int
4977set_ref_in_call_stack(int copyID)
4978{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004979 int abort = FALSE;
4980 funccall_T *fc;
4981 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004983 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004984 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004985
4986 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004987 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4988 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004989 abort = abort || set_ref_in_funccal(fc, copyID);
4990
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004991 return abort;
4992}
4993
4994/*
4995 * Set "copyID" in all functions available by name.
4996 */
4997 int
4998set_ref_in_functions(int copyID)
4999{
5000 int todo;
5001 hashitem_T *hi = NULL;
5002 int abort = FALSE;
5003 ufunc_T *fp;
5004
5005 todo = (int)func_hashtab.ht_used;
5006 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005007 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005008 if (!HASHITEM_EMPTY(hi))
5009 {
5010 --todo;
5011 fp = HI2UF(hi);
5012 if (!func_name_refcount(fp->uf_name))
5013 abort = abort || set_ref_in_func(NULL, fp, copyID);
5014 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005015 }
5016 return abort;
5017}
5018
5019/*
5020 * Set "copyID" in all function arguments.
5021 */
5022 int
5023set_ref_in_func_args(int copyID)
5024{
5025 int i;
5026 int abort = FALSE;
5027
5028 for (i = 0; i < funcargs.ga_len; ++i)
5029 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5030 copyID, NULL, NULL);
5031 return abort;
5032}
5033
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005034/*
5035 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005036 * Returns TRUE if setting references failed somehow.
5037 */
5038 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005039set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005040{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005041 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005042 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005043 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005044 char_u fname_buf[FLEN_FIXED + 1];
5045 char_u *tofree = NULL;
5046 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005047 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005048
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005049 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005050 return FALSE;
5051
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005052 if (fp_in == NULL)
5053 {
5054 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005055 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005056 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005057 if (fp != NULL)
5058 {
5059 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005060 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005061 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005062
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005063 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005064 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005065}
5066
Bram Moolenaare38eab22019-12-05 21:50:01 +01005067#endif // FEAT_EVAL