blob: f9f302a17060c573a1189c21d092c96b4124d3d7 [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
352 type = parse_type(&p, &fp->uf_type_list);
353 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
372 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
373 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.
463 * Return NULL if no valid arrow found.
464 */
465 static char_u *
466skip_arrow(char_u *start, int equal_arrow)
467{
468 char_u *s = start;
469
470 if (equal_arrow)
471 {
472 if (*s == ':')
473 s = skip_type(skipwhite(s + 1), TRUE);
474 s = skipwhite(s);
475 if (*s != '=')
476 return NULL;
477 ++s;
478 }
479 if (*s != '>')
480 return NULL;
481 return skipwhite(s + 1);
482}
483
484/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200485 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100486 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100487 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200488 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
489 */
490 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100491get_lambda_tv(
492 char_u **arg,
493 typval_T *rettv,
494 int types_optional,
495 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200496{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200497 int evaluate = evalarg != NULL
498 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200499 garray_T newargs;
500 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200501 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100502 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200503 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100504 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200505 int varargs;
506 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200507 char_u *s;
508 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200509 int *old_eval_lavars = eval_lavars_used;
510 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200511 char_u *tofree = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100512 int equal_arrow = **arg == '(';
513
514 if (equal_arrow && !in_vim9script())
515 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200516
517 ga_init(&newargs);
518 ga_init(&newlines);
519
Bram Moolenaar65c44152020-12-24 15:14:01 +0100520 // First, check if this is a lambda expression. "->" or "=>" must exist.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200521 s = skipwhite(*arg + 1);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100522 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100523 types_optional ? &argtypes : NULL, types_optional,
524 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100525 if (ret == FAIL || skip_arrow(s, equal_arrow) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100526 {
527 if (types_optional)
528 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200529 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100530 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200531
Bram Moolenaare38eab22019-12-05 21:50:01 +0100532 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200533 if (evaluate)
534 pnewargs = &newargs;
535 else
536 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 *arg = skipwhite(*arg + 1);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100538 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100539 types_optional ? &argtypes : NULL, types_optional,
540 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 if (ret == FAIL || (*arg = skip_arrow(*arg, equal_arrow)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100542 {
543 if (types_optional)
544 ga_clear_strings(&argtypes);
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100546 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200547
Bram Moolenaare38eab22019-12-05 21:50:01 +0100548 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200549 if (evaluate)
550 eval_lavars_used = &eval_lavars;
551
Bram Moolenaar65c44152020-12-24 15:14:01 +0100552 *arg = skipwhite_and_linebreak(*arg, evalarg);
553
554 // Only recognize "{" as the start of a function body when followed by
555 // white space, "{key: val}" is a dict.
556 if (equal_arrow && **arg == '{' && IS_WHITE_OR_NUL((*arg)[1]))
557 {
558 // TODO: process the function body upto the "}".
559 emsg("Lambda function body not supported yet");
560 goto errret;
561 }
562
Bram Moolenaare38eab22019-12-05 21:50:01 +0100563 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200564 start = *arg;
565 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200566 if (ret == FAIL)
567 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200568 if (evalarg != NULL)
569 {
570 // avoid that the expression gets freed when another line break follows
571 tofree = evalarg->eval_tofree;
572 evalarg->eval_tofree = NULL;
573 }
574
Bram Moolenaar65c44152020-12-24 15:14:01 +0100575 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100576 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 *arg = skipwhite_and_linebreak(*arg, evalarg);
578 if (**arg != '}')
579 {
580 semsg(_("E451: Expected }: %s"), *arg);
581 goto errret;
582 }
583 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100584 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200585
586 if (evaluate)
587 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200588 int len;
589 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200590 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200591 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200592
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200593 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200594 if (fp == NULL)
595 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200596 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200597 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200598 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200599 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200600
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200601 ga_init2(&newlines, (int)sizeof(char_u *), 1);
602 if (ga_grow(&newlines, 1) == FAIL)
603 goto errret;
604
Bram Moolenaare38eab22019-12-05 21:50:01 +0100605 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200606 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200607 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200608 if (p == NULL)
609 goto errret;
610 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
611 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200612 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200613 if (strstr((char *)p + 7, "a:") == NULL)
614 // No a: variables are used for sure.
615 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200616
617 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100618 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200619 hash_add(&func_hashtab, UF2HIKEY(fp));
620 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200621 ga_init(&fp->uf_def_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100622 if (types_optional
623 && parse_argument_types(fp, &argtypes, FALSE) == FAIL)
624 goto errret;
625
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200626 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200627 if (current_funccal != NULL && eval_lavars)
628 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200629 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200630 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200631 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200632 }
633 else
634 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200635
636#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200637 if (prof_def_func())
638 func_do_profile(fp);
639#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200640 if (sandbox)
641 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100642 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200643 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200644 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200646 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100647 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200648
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200649 pt->pt_func = fp;
650 pt->pt_refcount = 1;
651 rettv->vval.v_partial = pt;
652 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200654
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200655 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200656 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200657 evalarg->eval_tofree = tofree;
658 else
659 vim_free(tofree);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100660 if (types_optional)
661 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200662 return OK;
663
664errret:
665 ga_clear_strings(&newargs);
666 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100667 if (types_optional)
668 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200669 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100670 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200671 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200672 evalarg->eval_tofree = tofree;
673 else
674 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200675 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200676 return FAIL;
677}
678
679/*
680 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
681 * name it contains, otherwise return "name".
682 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
683 * "partialp".
684 */
685 char_u *
686deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
687{
688 dictitem_T *v;
689 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200690 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691
692 if (partialp != NULL)
693 *partialp = NULL;
694
695 cc = name[*lenp];
696 name[*lenp] = NUL;
697 v = find_var(name, NULL, no_autoload);
698 name[*lenp] = cc;
699 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
700 {
701 if (v->di_tv.vval.v_string == NULL)
702 {
703 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100704 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200705 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200706 s = v->di_tv.vval.v_string;
707 *lenp = (int)STRLEN(s);
708 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200709 }
710
711 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
712 {
713 partial_T *pt = v->di_tv.vval.v_partial;
714
715 if (pt == NULL)
716 {
717 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100718 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200719 }
720 if (partialp != NULL)
721 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200722 s = partial_name(pt);
723 *lenp = (int)STRLEN(s);
724 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200725 }
726
727 return name;
728}
729
730/*
731 * Give an error message with a function name. Handle <SNR> things.
732 * "ermsg" is to be passed without translation, use N_() instead of _().
733 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100734 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200735emsg_funcname(char *ermsg, char_u *name)
736{
737 char_u *p;
738
739 if (*name == K_SPECIAL)
740 p = concat_str((char_u *)"<SNR>", name + 3);
741 else
742 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100743 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200744 if (p != name)
745 vim_free(p);
746}
747
748/*
749 * Allocate a variable for the result of a function.
750 * Return OK or FAIL.
751 */
752 int
753get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200754 char_u *name, // name of the function
755 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200756 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200757 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200758 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200759 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200760{
761 char_u *argp;
762 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100763 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
764 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200765 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200766
767 /*
768 * Get the arguments.
769 */
770 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200771 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
772 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200773 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200774 // skip the '(' or ',' and possibly line breaks
775 argp = skipwhite_and_linebreak(argp + 1, evalarg);
776
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200777 if (*argp == ')' || *argp == ',' || *argp == NUL)
778 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200779 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200780 {
781 ret = FAIL;
782 break;
783 }
784 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200785 // The comma should come right after the argument, but this wasn't
786 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200787 if (vim9script)
788 {
789 if (*argp != ',' && *skipwhite(argp) == ',')
790 {
791 semsg(_(e_no_white_space_allowed_before_str), ",");
792 ret = FAIL;
793 break;
794 }
795 }
796 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200797 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200798 if (*argp != ',')
799 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200800 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
801 {
802 semsg(_(e_white_space_required_after_str), ",");
803 ret = FAIL;
804 break;
805 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200806 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200807 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200808 if (*argp == ')')
809 ++argp;
810 else
811 ret = FAIL;
812
813 if (ret == OK)
814 {
815 int i = 0;
816
817 if (get_vim_var_nr(VV_TESTING))
818 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100819 // Prepare for calling test_garbagecollect_now(), need to know
820 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200821 if (funcargs.ga_itemsize == 0)
822 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
823 for (i = 0; i < argcount; ++i)
824 if (ga_grow(&funcargs, 1) == OK)
825 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
826 &argvars[i];
827 }
828
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200829 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200830
831 funcargs.ga_len -= i;
832 }
833 else if (!aborting())
834 {
835 if (argcount == MAX_FUNC_ARGS)
836 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
837 else
838 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
839 }
840
841 while (--argcount >= 0)
842 clear_tv(&argvars[argcount]);
843
Bram Moolenaar8294d492020-08-10 22:40:56 +0200844 if (in_vim9script())
845 *arg = argp;
846 else
847 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200848 return ret;
849}
850
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200851/*
852 * Return TRUE if "p" starts with "<SID>" or "s:".
853 * Only works if eval_fname_script() returned non-zero for "p"!
854 */
855 static int
856eval_fname_sid(char_u *p)
857{
858 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
859}
860
861/*
862 * In a script change <SID>name() and s:name() to K_SNR 123_name().
863 * Change <SNR>123_name() to K_SNR 123_name().
864 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
865 * (slow).
866 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100867 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200868fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
869{
870 int llen;
871 char_u *fname;
872 int i;
873
874 llen = eval_fname_script(name);
875 if (llen > 0)
876 {
877 fname_buf[0] = K_SPECIAL;
878 fname_buf[1] = KS_EXTRA;
879 fname_buf[2] = (int)KE_SNR;
880 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100881 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200882 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200883 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100884 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200885 else
886 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200887 sprintf((char *)fname_buf + 3, "%ld_",
888 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200889 i = (int)STRLEN(fname_buf);
890 }
891 }
892 if (i + STRLEN(name + llen) < FLEN_FIXED)
893 {
894 STRCPY(fname_buf + i, name + llen);
895 fname = fname_buf;
896 }
897 else
898 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200899 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200900 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100901 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200902 else
903 {
904 *tofree = fname;
905 mch_memmove(fname, fname_buf, (size_t)i);
906 STRCPY(fname + i, name + llen);
907 }
908 }
909 }
910 else
911 fname = name;
912 return fname;
913}
914
915/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100916 * Find a function "name" in script "sid".
917 */
918 static ufunc_T *
919find_func_with_sid(char_u *name, int sid)
920{
921 hashitem_T *hi;
922 char_u buffer[200];
923
924 buffer[0] = K_SPECIAL;
925 buffer[1] = KS_EXTRA;
926 buffer[2] = (int)KE_SNR;
927 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
928 (long)sid, name);
929 hi = hash_find(&func_hashtab, buffer);
930 if (!HASHITEM_EMPTY(hi))
931 return HI2UF(hi);
932
933 return NULL;
934}
935
936/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200937 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200938 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200939 * Return NULL for unknown function.
940 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200941 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200942find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200943{
944 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100945 ufunc_T *func;
946 imported_T *imported;
947
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200948 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100949 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200950 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200951 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +0200952 int find_script_local = in_vim9script()
953 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100954
Bram Moolenaar95006e32020-08-29 17:47:08 +0200955 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100956 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200957 // Find script-local function before global one.
958 func = find_func_with_sid(name, current_sctx.sc_sid);
959 if (func != NULL)
960 return func;
961 }
962
Bram Moolenaarefa94442020-08-08 22:16:00 +0200963 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200964 && name[1] == KS_EXTRA
965 && name[2] == KE_SNR)
966 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200967 // Caller changes s: to <SNR>99_name.
968
969 after_script = name + 3;
970 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200971 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200972 ++after_script;
973 else
974 after_script = NULL;
975 }
Bram Moolenaar95006e32020-08-29 17:47:08 +0200976 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200977 {
978 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200979 if (after_script != NULL && sid != current_sctx.sc_sid)
980 imported = find_imported_in_script(after_script, 0, sid);
981 else
982 imported = find_imported(after_script == NULL
983 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200984 if (imported != NULL && imported->imp_funcname != NULL)
985 {
986 hi = hash_find(&func_hashtab, imported->imp_funcname);
987 if (!HASHITEM_EMPTY(hi))
988 return HI2UF(hi);
989 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100990 }
991 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200992
Bram Moolenaara26b9702020-04-18 19:53:28 +0200993 hi = hash_find(&func_hashtab,
994 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200995 if (!HASHITEM_EMPTY(hi))
996 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100997
998 return NULL;
999}
1000
1001/*
1002 * Find a function by name, return pointer to it in ufuncs.
1003 * "cctx" is passed in a :def function to find imported functions.
1004 * Return NULL for unknown or dead function.
1005 */
1006 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001007find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001008{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001009 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001010
1011 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1012 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001013 return NULL;
1014}
1015
1016/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001017 * Return TRUE if "ufunc" is a global function.
1018 */
1019 int
1020func_is_global(ufunc_T *ufunc)
1021{
1022 return ufunc->uf_name[0] != K_SPECIAL;
1023}
1024
1025/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001026 * Copy the function name of "fp" to buffer "buf".
1027 * "buf" must be able to hold the function name plus three bytes.
1028 * Takes care of script-local function names.
1029 */
1030 static void
1031cat_func_name(char_u *buf, ufunc_T *fp)
1032{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001033 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001034 {
1035 STRCPY(buf, "<SNR>");
1036 STRCAT(buf, fp->uf_name + 3);
1037 }
1038 else
1039 STRCPY(buf, fp->uf_name);
1040}
1041
1042/*
1043 * Add a number variable "name" to dict "dp" with value "nr".
1044 */
1045 static void
1046add_nr_var(
1047 dict_T *dp,
1048 dictitem_T *v,
1049 char *name,
1050 varnumber_T nr)
1051{
1052 STRCPY(v->di_key, name);
1053 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1054 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1055 v->di_tv.v_type = VAR_NUMBER;
1056 v->di_tv.v_lock = VAR_FIXED;
1057 v->di_tv.vval.v_number = nr;
1058}
1059
1060/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001061 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001062 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001063 static void
1064free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001065{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001066 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001067
1068 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1069 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001070 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001071
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001072 // When garbage collecting a funccall_T may be freed before the
1073 // function that references it, clear its uf_scoped field.
1074 // The function may have been redefined and point to another
1075 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001076 if (fp != NULL && fp->uf_scoped == fc)
1077 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001078 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001079 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001081 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001082 vim_free(fc);
1083}
1084
1085/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001086 * Free "fc" and what it contains.
1087 * Can be called only when "fc" is kept beyond the period of it called,
1088 * i.e. after cleanup_function_call(fc).
1089 */
1090 static void
1091free_funccal_contents(funccall_T *fc)
1092{
1093 listitem_T *li;
1094
1095 // Free all l: variables.
1096 vars_clear(&fc->l_vars.dv_hashtab);
1097
1098 // Free all a: variables.
1099 vars_clear(&fc->l_avars.dv_hashtab);
1100
1101 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001102 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001103 clear_tv(&li->li_tv);
1104
1105 free_funccal(fc);
1106}
1107
1108/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001109 * Handle the last part of returning from a function: free the local hashtable.
1110 * Unless it is still in use by a closure.
1111 */
1112 static void
1113cleanup_function_call(funccall_T *fc)
1114{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001115 int may_free_fc = fc->fc_refcount <= 0;
1116 int free_fc = TRUE;
1117
Bram Moolenaar6914c642017-04-01 21:21:30 +02001118 current_funccal = fc->caller;
1119
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001120 // Free all l: variables if not referred.
1121 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1122 vars_clear(&fc->l_vars.dv_hashtab);
1123 else
1124 free_fc = FALSE;
1125
1126 // If the a:000 list and the l: and a: dicts are not referenced and
1127 // there is no closure using it, we can free the funccall_T and what's
1128 // in it.
1129 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1130 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001131 else
1132 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001133 int todo;
1134 hashitem_T *hi;
1135 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001136
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001137 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001138
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001139 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001140 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1141 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1142 {
1143 if (!HASHITEM_EMPTY(hi))
1144 {
1145 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001146 di = HI2DI(hi);
1147 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001148 }
1149 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001150 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001151
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001152 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1153 fc->l_varlist.lv_first = NULL;
1154 else
1155 {
1156 listitem_T *li;
1157
1158 free_fc = FALSE;
1159
1160 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001161 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001162 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001163 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001164
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001165 if (free_fc)
1166 free_funccal(fc);
1167 else
1168 {
1169 static int made_copy = 0;
1170
1171 // "fc" is still in use. This can happen when returning "a:000",
1172 // assigning "l:" to a global variable or defining a closure.
1173 // Link "fc" in the list for garbage collection later.
1174 fc->caller = previous_funccal;
1175 previous_funccal = fc;
1176
1177 if (want_garbage_collect)
1178 // If garbage collector is ready, clear count.
1179 made_copy = 0;
1180 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001181 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001182 // We have made a lot of copies, worth 4 Mbyte. This can happen
1183 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001184 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001185 // too much memory.
1186 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001187 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001188 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001189 }
1190}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001191
1192/*
1193 * There are two kinds of function names:
1194 * 1. ordinary names, function defined with :function or :def
1195 * 2. numbered functions and lambdas
1196 * For the first we only count the name stored in func_hashtab as a reference,
1197 * using function() does not count as a reference, because the function is
1198 * looked up by name.
1199 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001200 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001201func_name_refcount(char_u *name)
1202{
1203 return isdigit(*name) || *name == '<';
1204}
1205
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001206/*
1207 * Unreference "fc": decrement the reference count and free it when it
1208 * becomes zero. "fp" is detached from "fc".
1209 * When "force" is TRUE we are exiting.
1210 */
1211 static void
1212funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1213{
1214 funccall_T **pfc;
1215 int i;
1216
1217 if (fc == NULL)
1218 return;
1219
1220 if (--fc->fc_refcount <= 0 && (force || (
1221 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1222 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1223 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1224 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1225 {
1226 if (fc == *pfc)
1227 {
1228 *pfc = fc->caller;
1229 free_funccal_contents(fc);
1230 return;
1231 }
1232 }
1233 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1234 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1235 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1236}
1237
1238/*
1239 * Remove the function from the function hashtable. If the function was
1240 * deleted while it still has references this was already done.
1241 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1242 */
1243 static int
1244func_remove(ufunc_T *fp)
1245{
1246 hashitem_T *hi;
1247
1248 // Return if it was already virtually deleted.
1249 if (fp->uf_flags & FC_DEAD)
1250 return FALSE;
1251
1252 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1253 if (!HASHITEM_EMPTY(hi))
1254 {
1255 // When there is a def-function index do not actually remove the
1256 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001257 // Do remove it when it's a copy.
1258 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001259 fp->uf_flags |= FC_DEAD;
1260 else
1261 hash_remove(&func_hashtab, hi);
1262 return TRUE;
1263 }
1264 return FALSE;
1265}
1266
1267 static void
1268func_clear_items(ufunc_T *fp)
1269{
1270 ga_clear_strings(&(fp->uf_args));
1271 ga_clear_strings(&(fp->uf_def_args));
1272 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001273 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001274 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001275 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001276 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001277 clear_type_list(&fp->uf_type_list);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001278 partial_unref(fp->uf_partial);
1279 fp->uf_partial = NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001280
1281#ifdef FEAT_LUA
1282 if (fp->uf_cb_free != NULL)
1283 {
1284 fp->uf_cb_free(fp->uf_cb_state);
1285 fp->uf_cb_free = NULL;
1286 }
1287
1288 fp->uf_cb_state = NULL;
1289 fp->uf_cb = NULL;
1290#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001291#ifdef FEAT_PROFILE
1292 VIM_CLEAR(fp->uf_tml_count);
1293 VIM_CLEAR(fp->uf_tml_total);
1294 VIM_CLEAR(fp->uf_tml_self);
1295#endif
1296}
1297
1298/*
1299 * Free all things that a function contains. Does not free the function
1300 * itself, use func_free() for that.
1301 * When "force" is TRUE we are exiting.
1302 */
1303 static void
1304func_clear(ufunc_T *fp, int force)
1305{
1306 if (fp->uf_cleared)
1307 return;
1308 fp->uf_cleared = TRUE;
1309
1310 // clear this function
1311 func_clear_items(fp);
1312 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001313 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001314}
1315
1316/*
1317 * Free a function and remove it from the list of functions. Does not free
1318 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001319 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001320 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001321 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001322 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001323func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001324{
1325 // Only remove it when not done already, otherwise we would remove a newer
1326 // version of the function with the same name.
1327 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1328 func_remove(fp);
1329
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001330 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001331 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001332 if (fp->uf_dfunc_idx > 0)
1333 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001334 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001335 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001336 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001337 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001338 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001339}
1340
1341/*
1342 * Free all things that a function contains and free the function itself.
1343 * When "force" is TRUE we are exiting.
1344 */
1345 static void
1346func_clear_free(ufunc_T *fp, int force)
1347{
1348 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001349 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1350 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001351 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001352 else
1353 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001354}
1355
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001356/*
1357 * Copy already defined function "lambda" to a new function with name "global".
1358 * This is for when a compiled function defines a global function.
1359 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001360 int
1361copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001362{
1363 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001364 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001365
1366 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001367 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001368 semsg(_(e_lambda_function_not_found_str), lambda);
1369 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001370 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001371
1372 // TODO: handle ! to overwrite
1373 fp = find_func(global, TRUE, NULL);
1374 if (fp != NULL)
1375 {
1376 semsg(_(e_funcexts), global);
1377 return FAIL;
1378 }
1379
1380 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1381 if (fp == NULL)
1382 return FAIL;
1383
1384 fp->uf_varargs = ufunc->uf_varargs;
1385 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1386 fp->uf_def_status = ufunc->uf_def_status;
1387 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1388 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1389 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1390 == FAIL
1391 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1392 goto failed;
1393
1394 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1395 : vim_strsave(ufunc->uf_name_exp);
1396 if (ufunc->uf_arg_types != NULL)
1397 {
1398 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1399 if (fp->uf_arg_types == NULL)
1400 goto failed;
1401 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1402 sizeof(type_T *) * fp->uf_args.ga_len);
1403 }
1404 if (ufunc->uf_def_arg_idx != NULL)
1405 {
1406 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1407 if (fp->uf_def_arg_idx == NULL)
1408 goto failed;
1409 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1410 sizeof(int) * fp->uf_def_args.ga_len + 1);
1411 }
1412 if (ufunc->uf_va_name != NULL)
1413 {
1414 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1415 if (fp->uf_va_name == NULL)
1416 goto failed;
1417 }
1418 fp->uf_ret_type = ufunc->uf_ret_type;
1419
1420 fp->uf_refcount = 1;
1421 STRCPY(fp->uf_name, global);
1422 hash_add(&func_hashtab, UF2HIKEY(fp));
1423
1424 // the referenced dfunc_T is now used one more time
1425 link_def_function(fp);
1426
1427 // Create a partial to store the context of the function, if not done
1428 // already.
1429 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1430 {
1431 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1432
1433 if (pt == NULL)
1434 goto failed;
1435 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
1436 goto failed;
1437 ufunc->uf_partial = pt;
1438 --pt->pt_refcount; // not referenced here yet
1439 }
1440 if (ufunc->uf_partial != NULL)
1441 {
1442 fp->uf_partial = ufunc->uf_partial;
1443 ++fp->uf_partial->pt_refcount;
1444 }
1445
1446 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001447
1448failed:
1449 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001450 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001451}
1452
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001453static int funcdepth = 0;
1454
1455/*
1456 * Increment the function call depth count.
1457 * Return FAIL when going over 'maxfuncdepth'.
1458 * Otherwise return OK, must call funcdepth_decrement() later!
1459 */
1460 int
1461funcdepth_increment(void)
1462{
1463 if (funcdepth >= p_mfd)
1464 {
1465 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1466 return FAIL;
1467 }
1468 ++funcdepth;
1469 return OK;
1470}
1471
1472 void
1473funcdepth_decrement(void)
1474{
1475 --funcdepth;
1476}
1477
1478/*
1479 * Get the current function call depth.
1480 */
1481 int
1482funcdepth_get(void)
1483{
1484 return funcdepth;
1485}
1486
1487/*
1488 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001489 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001490 * times as funcdepth_increment().
1491 */
1492 void
1493funcdepth_restore(int depth)
1494{
1495 funcdepth = depth;
1496}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001497
1498/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499 * Call a user function.
1500 */
1501 static void
1502call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001503 ufunc_T *fp, // pointer to function
1504 int argcount, // nr of args
1505 typval_T *argvars, // arguments
1506 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001507 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001508 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001510 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001511 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001512 funccall_T *fc;
1513 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001514 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001516 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 int i;
1518 int ai;
1519 int islambda = FALSE;
1520 char_u numbuf[NUMBUFLEN];
1521 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522#ifdef FEAT_PROFILE
1523 proftime_T wait_start;
1524 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001525 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001527 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001529 // If depth of calling is getting too high, don't execute the function.
1530 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 rettv->v_type = VAR_NUMBER;
1533 rettv->vval.v_number = -1;
1534 return;
1535 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001536
Bram Moolenaare38eab22019-12-05 21:50:01 +01001537 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001538
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001539 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001540 if (fc == NULL)
1541 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001542 fc->caller = current_funccal;
1543 current_funccal = fc;
1544 fc->func = fp;
1545 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001546 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001547 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1549 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001550 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001551 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001552 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001554 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001555 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001556 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001557 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001558 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001559 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001560 free_funccal(fc);
1561 return;
1562 }
1563
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1565 islambda = TRUE;
1566
1567 /*
1568 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1569 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1570 * each argument variable and saves a lot of time.
1571 */
1572 /*
1573 * Init l: variables.
1574 */
1575 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1576 if (selfdict != NULL)
1577 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001578 // Set l:self to "selfdict". Use "name" to avoid a warning from
1579 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580 v = &fc->fixvar[fixvar_idx++].var;
1581 name = v->di_key;
1582 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001583 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1585 v->di_tv.v_type = VAR_DICT;
1586 v->di_tv.v_lock = 0;
1587 v->di_tv.vval.v_dict = selfdict;
1588 ++selfdict->dv_refcount;
1589 }
1590
1591 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001592 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001593 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 * Set a:000 to a list with room for the "..." arguments.
1595 */
1596 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001597 if ((fp->uf_flags & FC_NOARGS) == 0)
1598 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001599 (varnumber_T)(argcount >= fp->uf_args.ga_len
1600 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001601 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001602 if ((fp->uf_flags & FC_NOARGS) == 0)
1603 {
1604 // Use "name" to avoid a warning from some compiler that checks the
1605 // destination size.
1606 v = &fc->fixvar[fixvar_idx++].var;
1607 name = v->di_key;
1608 STRCPY(name, "000");
1609 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1610 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1611 v->di_tv.v_type = VAR_LIST;
1612 v->di_tv.v_lock = VAR_FIXED;
1613 v->di_tv.vval.v_list = &fc->l_varlist;
1614 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001615 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001616 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1617 fc->l_varlist.lv_lock = VAR_FIXED;
1618
1619 /*
1620 * Set a:firstline to "firstline" and a:lastline to "lastline".
1621 * Set a:name to named arguments.
1622 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001623 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001625 if ((fp->uf_flags & FC_NOARGS) == 0)
1626 {
1627 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001628 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001629 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001630 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001631 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001632 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633 {
1634 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001635 typval_T def_rettv;
1636 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637
1638 ai = i - fp->uf_args.ga_len;
1639 if (ai < 0)
1640 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001641 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 name = FUNCARG(fp, i);
1643 if (islambda)
1644 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001645
1646 // evaluate named argument default expression
1647 isdefault = ai + fp->uf_def_args.ga_len >= 0
1648 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1649 && argvars[i].vval.v_number == VVAL_NONE));
1650 if (isdefault)
1651 {
1652 char_u *default_expr = NULL;
1653 def_rettv.v_type = VAR_NUMBER;
1654 def_rettv.vval.v_number = -1;
1655
1656 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1657 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001658 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001659 {
1660 default_arg_err = 1;
1661 break;
1662 }
1663 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001664 }
1665 else
1666 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001667 if ((fp->uf_flags & FC_NOARGS) != 0)
1668 // Bail out if no a: arguments used (in lambda).
1669 break;
1670
Bram Moolenaare38eab22019-12-05 21:50:01 +01001671 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672 sprintf((char *)numbuf, "%d", ai + 1);
1673 name = numbuf;
1674 }
1675 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1676 {
1677 v = &fc->fixvar[fixvar_idx++].var;
1678 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001679 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 }
1681 else
1682 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001683 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 if (v == NULL)
1685 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001686 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001689 // Note: the values are copied directly to avoid alloc/free.
1690 // "argvars" must have VAR_FIXED for v_lock.
1691 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692 v->di_tv.v_lock = VAR_FIXED;
1693
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694 if (addlocal)
1695 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001696 // Named arguments should be accessed without the "a:" prefix in
1697 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001698 copy_tv(&v->di_tv, &v->di_tv);
1699 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001701 else
1702 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703
1704 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1705 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001706 listitem_T *li = &fc->l_listitems[ai];
1707
1708 li->li_tv = argvars[i];
1709 li->li_tv.v_lock = VAR_FIXED;
1710 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001711 }
1712 }
1713
Bram Moolenaare38eab22019-12-05 21:50:01 +01001714 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001716
1717 if (fp->uf_flags & FC_SANDBOX)
1718 {
1719 using_sandbox = TRUE;
1720 ++sandbox;
1721 }
1722
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001723 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001724 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001725 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001727 ++no_wait_return;
1728 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001729
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001730 smsg(_("calling %s"), SOURCING_NAME);
1731 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001733 char_u buf[MSG_BUF_LEN];
1734 char_u numbuf2[NUMBUFLEN];
1735 char_u *tofree;
1736 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001737
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001738 msg_puts("(");
1739 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001741 if (i > 0)
1742 msg_puts(", ");
1743 if (argvars[i].v_type == VAR_NUMBER)
1744 msg_outnum((long)argvars[i].vval.v_number);
1745 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001746 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001747 // Do not want errors such as E724 here.
1748 ++emsg_off;
1749 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1750 --emsg_off;
1751 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001752 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001753 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001755 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1756 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001758 msg_puts((char *)s);
1759 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001760 }
1761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001763 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001765 msg_puts("\n"); // don't overwrite this either
1766
1767 verbose_leave_scroll();
1768 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 }
1770#ifdef FEAT_PROFILE
1771 if (do_profiling == PROF_YES)
1772 {
1773 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001774 {
1775 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001777 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 if (fp->uf_profiling
1779 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1780 {
1781 ++fp->uf_tm_count;
1782 profile_start(&call_start);
1783 profile_zero(&fp->uf_tm_children);
1784 }
1785 script_prof_save(&wait_start);
1786 }
1787#endif
1788
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001789 save_current_sctx = current_sctx;
1790 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001791 save_did_emsg = did_emsg;
1792 did_emsg = FALSE;
1793
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001794 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1795 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001796 else if (islambda)
1797 {
1798 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1799
1800 // A Lambda always has the command "return {expr}". It is much faster
1801 // to evaluate {expr} directly.
1802 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001803 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001804 --ex_nesting_level;
1805 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001806 else
1807 // call do_cmdline() to execute the lines
1808 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001809 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1810
1811 --RedrawingDisabled;
1812
Bram Moolenaare38eab22019-12-05 21:50:01 +01001813 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1815 {
1816 clear_tv(rettv);
1817 rettv->v_type = VAR_NUMBER;
1818 rettv->vval.v_number = -1;
1819 }
1820
1821#ifdef FEAT_PROFILE
1822 if (do_profiling == PROF_YES && (fp->uf_profiling
1823 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1824 {
1825 profile_end(&call_start);
1826 profile_sub_wait(&wait_start, &call_start);
1827 profile_add(&fp->uf_tm_total, &call_start);
1828 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1829 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1830 {
1831 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1832 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1833 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001834 if (started_profiling)
1835 // make a ":profdel func" stop profiling the function
1836 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 }
1838#endif
1839
Bram Moolenaare38eab22019-12-05 21:50:01 +01001840 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 if (p_verbose >= 12)
1842 {
1843 ++no_wait_return;
1844 verbose_enter_scroll();
1845
1846 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001847 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001849 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 (long)fc->rettv->vval.v_number);
1851 else
1852 {
1853 char_u buf[MSG_BUF_LEN];
1854 char_u numbuf2[NUMBUFLEN];
1855 char_u *tofree;
1856 char_u *s;
1857
Bram Moolenaare38eab22019-12-05 21:50:01 +01001858 // The value may be very long. Skip the middle part, so that we
1859 // have some idea how it starts and ends. smsg() would always
1860 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001861 ++emsg_off;
1862 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1863 --emsg_off;
1864 if (s != NULL)
1865 {
1866 if (vim_strsize(s) > MSG_BUF_CLEN)
1867 {
1868 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1869 s = buf;
1870 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001871 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001872 vim_free(tofree);
1873 }
1874 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001875 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001876
1877 verbose_leave_scroll();
1878 --no_wait_return;
1879 }
1880
Bram Moolenaare31ee862020-01-07 20:59:34 +01001881 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001882 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001883 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884#ifdef FEAT_PROFILE
1885 if (do_profiling == PROF_YES)
1886 script_prof_restore(&wait_start);
1887#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001888 if (using_sandbox)
1889 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001891 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001892 {
1893 ++no_wait_return;
1894 verbose_enter_scroll();
1895
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001896 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001897 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001898
1899 verbose_leave_scroll();
1900 --no_wait_return;
1901 }
1902
1903 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001904 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001905 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906}
1907
1908/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001909 * Check the argument count for user function "fp".
1910 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1911 */
1912 int
1913check_user_func_argcount(ufunc_T *fp, int argcount)
1914{
1915 int regular_args = fp->uf_args.ga_len;
1916
1917 if (argcount < regular_args - fp->uf_def_args.ga_len)
1918 return FCERR_TOOFEW;
1919 else if (!has_varargs(fp) && argcount > regular_args)
1920 return FCERR_TOOMANY;
1921 return FCERR_UNKNOWN;
1922}
1923
1924/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001925 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001926 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001927 int
1928call_user_func_check(
1929 ufunc_T *fp,
1930 int argcount,
1931 typval_T *argvars,
1932 typval_T *rettv,
1933 funcexe_T *funcexe,
1934 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001935{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001936 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001937
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001938 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1939 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01001940 error = check_user_func_argcount(fp, argcount);
1941 if (error != FCERR_UNKNOWN)
1942 return error;
1943 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001944 error = FCERR_DICT;
1945 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001946 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947 int did_save_redo = FALSE;
1948 save_redo_T save_redo;
1949
1950 /*
1951 * Call the user function.
1952 * Save and restore search patterns, script variables and
1953 * redo buffer.
1954 */
1955 save_search_patterns();
1956 if (!ins_compl_active())
1957 {
1958 saveRedobuff(&save_redo);
1959 did_save_redo = TRUE;
1960 }
1961 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001962 call_user_func(fp, argcount, argvars, rettv, funcexe,
1963 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001964 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1965 // Function was unreferenced while being used, free it now.
1966 func_clear_free(fp, FALSE);
1967 if (did_save_redo)
1968 restoreRedobuff(&save_redo);
1969 restore_search_patterns();
1970 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001971 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001972 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001973}
1974
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001975static funccal_entry_T *funccal_stack = NULL;
1976
1977/*
1978 * Save the current function call pointer, and set it to NULL.
1979 * Used when executing autocommands and for ":source".
1980 */
1981 void
1982save_funccal(funccal_entry_T *entry)
1983{
1984 entry->top_funccal = current_funccal;
1985 entry->next = funccal_stack;
1986 funccal_stack = entry;
1987 current_funccal = NULL;
1988}
1989
1990 void
1991restore_funccal(void)
1992{
1993 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001994 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001995 else
1996 {
1997 current_funccal = funccal_stack->top_funccal;
1998 funccal_stack = funccal_stack->next;
1999 }
2000}
2001
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002002 funccall_T *
2003get_current_funccal(void)
2004{
2005 return current_funccal;
2006}
2007
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002008/*
2009 * Mark all functions of script "sid" as deleted.
2010 */
2011 void
2012delete_script_functions(int sid)
2013{
2014 hashitem_T *hi;
2015 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002016 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002017 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002018 size_t len;
2019
2020 buf[0] = K_SPECIAL;
2021 buf[1] = KS_EXTRA;
2022 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002023 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002024 len = STRLEN(buf);
2025
Bram Moolenaarce658352020-07-31 23:47:12 +02002026 while (todo > 0)
2027 {
2028 todo = func_hashtab.ht_used;
2029 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2030 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002031 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002032 fp = HI2UF(hi);
2033 if (STRNCMP(fp->uf_name, buf, len) == 0)
2034 {
2035 int changed = func_hashtab.ht_changed;
2036
2037 fp->uf_flags |= FC_DEAD;
2038 func_clear(fp, TRUE);
2039 // When clearing a function another function can be cleared
2040 // as a side effect. When that happens start over.
2041 if (changed != func_hashtab.ht_changed)
2042 break;
2043 }
2044 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002045 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002046 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002047}
2048
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002049#if defined(EXITFREE) || defined(PROTO)
2050 void
2051free_all_functions(void)
2052{
2053 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002054 ufunc_T *fp;
2055 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002056 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002057 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058
Bram Moolenaare38eab22019-12-05 21:50:01 +01002059 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002060 while (current_funccal != NULL)
2061 {
2062 clear_tv(current_funccal->rettv);
2063 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002064 if (current_funccal == NULL && funccal_stack != NULL)
2065 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002066 }
2067
Bram Moolenaare38eab22019-12-05 21:50:01 +01002068 // First clear what the functions contain. Since this may lower the
2069 // reference count of a function, it may also free a function and change
2070 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002071 while (todo > 0)
2072 {
2073 todo = func_hashtab.ht_used;
2074 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2075 if (!HASHITEM_EMPTY(hi))
2076 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002077 // clear the def function index now
2078 fp = HI2UF(hi);
2079 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002080 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002081
Bram Moolenaare38eab22019-12-05 21:50:01 +01002082 // Only free functions that are not refcounted, those are
2083 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002084 if (func_name_refcount(fp->uf_name))
2085 ++skipped;
2086 else
2087 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002088 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002089 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002090 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002091 {
2092 skipped = 0;
2093 break;
2094 }
2095 }
2096 --todo;
2097 }
2098 }
2099
Bram Moolenaare38eab22019-12-05 21:50:01 +01002100 // Now actually free the functions. Need to start all over every time,
2101 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002102 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002103 while (func_hashtab.ht_used > skipped)
2104 {
2105 todo = func_hashtab.ht_used;
2106 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002107 if (!HASHITEM_EMPTY(hi))
2108 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002109 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002110 // Only free functions that are not refcounted, those are
2111 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002112 fp = HI2UF(hi);
2113 if (func_name_refcount(fp->uf_name))
2114 ++skipped;
2115 else
2116 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002117 if (func_free(fp, FALSE) == OK)
2118 {
2119 skipped = 0;
2120 break;
2121 }
2122 // did not actually free it
2123 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002124 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002126 }
2127 if (skipped == 0)
2128 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002129
2130 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002131}
2132#endif
2133
2134/*
2135 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002136 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002137 * "len" is the length of "name", or -1 for NUL terminated.
2138 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002139 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002140builtin_function(char_u *name, int len)
2141{
2142 char_u *p;
2143
Bram Moolenaara26b9702020-04-18 19:53:28 +02002144 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002145 return FALSE;
2146 p = vim_strchr(name, AUTOLOAD_CHAR);
2147 return p == NULL || (len > 0 && p > name + len);
2148}
2149
2150 int
2151func_call(
2152 char_u *name,
2153 typval_T *args,
2154 partial_T *partial,
2155 dict_T *selfdict,
2156 typval_T *rettv)
2157{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002158 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159 listitem_T *item;
2160 typval_T argv[MAX_FUNC_ARGS + 1];
2161 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002162 int r = 0;
2163
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002164 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002165 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002166 {
2167 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2168 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002169 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002170 break;
2171 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002172 // Make a copy of each argument. This is needed to be able to set
2173 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002174 copy_tv(&item->li_tv, &argv[argc++]);
2175 }
2176
2177 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002178 {
2179 funcexe_T funcexe;
2180
Bram Moolenaara80faa82020-04-12 19:37:17 +02002181 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002182 funcexe.firstline = curwin->w_cursor.lnum;
2183 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002184 funcexe.evaluate = TRUE;
2185 funcexe.partial = partial;
2186 funcexe.selfdict = selfdict;
2187 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2188 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002189
Bram Moolenaare38eab22019-12-05 21:50:01 +01002190 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002191 while (argc > 0)
2192 clear_tv(&argv[--argc]);
2193
2194 return r;
2195}
2196
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002197static int callback_depth = 0;
2198
2199 int
2200get_callback_depth(void)
2201{
2202 return callback_depth;
2203}
2204
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002205/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002206 * Invoke call_func() with a callback.
2207 */
2208 int
2209call_callback(
2210 callback_T *callback,
2211 int len, // length of "name" or -1 to use strlen()
2212 typval_T *rettv, // return value goes here
2213 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002214 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002215 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002216{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002217 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002218 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002219
Bram Moolenaara80faa82020-04-12 19:37:17 +02002220 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002221 funcexe.evaluate = TRUE;
2222 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002223 ++callback_depth;
2224 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2225 --callback_depth;
2226 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002227}
2228
2229/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002230 * Give an error message for the result of a function.
2231 * Nothing if "error" is FCERR_NONE.
2232 */
2233 void
2234user_func_error(int error, char_u *name)
2235{
2236 switch (error)
2237 {
2238 case FCERR_UNKNOWN:
2239 emsg_funcname(e_unknownfunc, name);
2240 break;
2241 case FCERR_NOTMETHOD:
2242 emsg_funcname(
2243 N_("E276: Cannot use function as a method: %s"), name);
2244 break;
2245 case FCERR_DELETED:
2246 emsg_funcname(N_(e_func_deleted), name);
2247 break;
2248 case FCERR_TOOMANY:
2249 emsg_funcname((char *)e_toomanyarg, name);
2250 break;
2251 case FCERR_TOOFEW:
2252 emsg_funcname((char *)e_toofewarg, name);
2253 break;
2254 case FCERR_SCRIPT:
2255 emsg_funcname(
2256 N_("E120: Using <SID> not in a script context: %s"), name);
2257 break;
2258 case FCERR_DICT:
2259 emsg_funcname(
2260 N_("E725: Calling dict function without Dictionary: %s"),
2261 name);
2262 break;
2263 }
2264}
2265
2266/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002267 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002268 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 * Return FAIL when the function can't be called, OK otherwise.
2270 * Also returns OK when an error was encountered while executing the function.
2271 */
2272 int
2273call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002274 char_u *funcname, // name of the function
2275 int len, // length of "name" or -1 to use strlen()
2276 typval_T *rettv, // return value goes here
2277 int argcount_in, // number of "argvars"
2278 typval_T *argvars_in, // vars for arguments, must have "argcount"
2279 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002280 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002281{
2282 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002283 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002285 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 char_u fname_buf[FLEN_FIXED + 1];
2287 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002288 char_u *fname = NULL;
2289 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290 int argcount = argcount_in;
2291 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002292 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002293 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2294 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002296 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002297 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002299 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2300 // even when call_func() returns FAIL.
2301 rettv->v_type = VAR_UNKNOWN;
2302
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002303 if (partial != NULL)
2304 fp = partial->pt_func;
2305 if (fp == NULL)
2306 {
2307 // Make a copy of the name, if it comes from a funcref variable it
2308 // could be changed or deleted in the called function.
2309 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2310 if (name == NULL)
2311 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002312
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002313 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2314 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002315
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002316 if (funcexe->doesrange != NULL)
2317 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002318
2319 if (partial != NULL)
2320 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002321 // When the function has a partial with a dict and there is a dict
2322 // argument, use the dict argument. That is backwards compatible.
2323 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002324 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002325 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002326 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 {
2328 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002329 {
2330 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2331 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002332 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002333 goto theend;
2334 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002335 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002336 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002337 for (i = 0; i < argcount_in; ++i)
2338 argv[i + argv_clear] = argvars_in[i];
2339 argvars = argv;
2340 argcount = partial->pt_argc + argcount_in;
2341 }
2342 }
2343
Bram Moolenaaref140542019-12-31 21:27:13 +01002344 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345 {
2346 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002347 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348
Bram Moolenaar333894b2020-08-01 18:53:07 +02002349 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002350 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002351 {
2352 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002354 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355
Bram Moolenaare38eab22019-12-05 21:50:01 +01002356 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002357 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002358 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002360 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 {
2362 /*
2363 * User defined function.
2364 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002365 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002366 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367
Bram Moolenaare38eab22019-12-05 21:50:01 +01002368 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369 if (fp == NULL
2370 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002371 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 && !aborting())
2373 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002374 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002375 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002377 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2379 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002380 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002381 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002383 if (fp == NULL)
2384 {
2385 char_u *p = untrans_function_name(rfname);
2386
2387 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002388 // Don't do this if the name starts with "s:".
2389 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002390 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002391 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002393 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002394 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002395#ifdef FEAT_LUA
2396 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2397 {
2398 cfunc_T cb = fp->uf_cb;
2399
2400 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2401 }
2402#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002403 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002405 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002406 // postponed filling in the arguments, do it now
2407 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002408 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002409
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002410 if (funcexe->basetv != NULL)
2411 {
2412 // Method call: base->Method()
2413 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2414 argv[0] = *funcexe->basetv;
2415 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002416 argvars = argv;
2417 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002418 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002419
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002420 error = call_user_func_check(fp, argcount, argvars, rettv,
2421 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 }
2423 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002424 else if (funcexe->basetv != NULL)
2425 {
2426 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002427 * expr->method(): Find the method name in the table, call its
2428 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002429 */
2430 error = call_internal_method(fname, argcount, argvars, rettv,
2431 funcexe->basetv);
2432 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 else
2434 {
2435 /*
2436 * Find the function name in the table, call its implementation.
2437 */
2438 error = call_internal_func(fname, argcount, argvars, rettv);
2439 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002440
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002441 /*
2442 * The function call (or "FuncUndefined" autocommand sequence) might
2443 * have been aborted by an error, an interrupt, or an explicitly thrown
2444 * exception that has not been caught so far. This situation can be
2445 * tested for by calling aborting(). For an error in an internal
2446 * function or for the "E132" error in call_user_func(), however, the
2447 * throw point at which the "force_abort" flag (temporarily reset by
2448 * emsg()) is normally updated has not been reached yet. We need to
2449 * update that flag first to make aborting() reliable.
2450 */
2451 update_force_abort();
2452 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002453 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 ret = OK;
2455
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002456theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 /*
2458 * Report an error unless the argument evaluation or function call has been
2459 * cancelled due to an aborting error, an interrupt, or an exception.
2460 */
2461 if (!aborting())
2462 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002463 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464 }
2465
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002466 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002468 clear_tv(&argv[--argv_clear + argv_base]);
2469
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 vim_free(tofree);
2471 vim_free(name);
2472
2473 return ret;
2474}
2475
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002476 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002477printable_func_name(ufunc_T *fp)
2478{
2479 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2480}
2481
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002483 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 */
2485 static void
2486list_func_head(ufunc_T *fp, int indent)
2487{
2488 int j;
2489
2490 msg_start();
2491 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002492 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002493 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002494 msg_puts("def ");
2495 else
2496 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002497 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498 msg_putchar('(');
2499 for (j = 0; j < fp->uf_args.ga_len; ++j)
2500 {
2501 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002502 msg_puts(", ");
2503 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002504 if (fp->uf_arg_types != NULL)
2505 {
2506 char *tofree;
2507
2508 msg_puts(": ");
2509 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2510 vim_free(tofree);
2511 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002512 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2513 {
2514 msg_puts(" = ");
2515 msg_puts(((char **)(fp->uf_def_args.ga_data))
2516 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2517 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 }
2519 if (fp->uf_varargs)
2520 {
2521 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002522 msg_puts(", ");
2523 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002525 if (fp->uf_va_name != NULL)
2526 {
2527 if (j)
2528 msg_puts(", ");
2529 msg_puts("...");
2530 msg_puts((char *)fp->uf_va_name);
2531 if (fp->uf_va_type)
2532 {
2533 char *tofree;
2534
2535 msg_puts(": ");
2536 msg_puts(type_name(fp->uf_va_type, &tofree));
2537 vim_free(tofree);
2538 }
2539 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002541
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002542 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002543 {
2544 if (fp->uf_ret_type != &t_void)
2545 {
2546 char *tofree;
2547
2548 msg_puts(": ");
2549 msg_puts(type_name(fp->uf_ret_type, &tofree));
2550 vim_free(tofree);
2551 }
2552 }
2553 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002554 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002556 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002558 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002559 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002560 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 msg_clr_eos();
2562 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002563 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564}
2565
2566/*
2567 * Get a function name, translating "<SID>" and "<SNR>".
2568 * Also handles a Funcref in a List or Dictionary.
2569 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002570 * Set "*is_global" to TRUE when the function must be global, unless
2571 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572 * flags:
2573 * TFN_INT: internal function name OK
2574 * TFN_QUIET: be quiet
2575 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002576 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002577 * Advances "pp" to just after the function name (if no error).
2578 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002579 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002580trans_function_name(
2581 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002582 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002583 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002585 funcdict_T *fdp, // return: info about dictionary used
2586 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587{
2588 char_u *name = NULL;
2589 char_u *start;
2590 char_u *end;
2591 int lead;
2592 char_u sid_buf[20];
2593 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002594 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002595 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002596 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002597 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002598
2599 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002600 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 start = *pp;
2602
Bram Moolenaare38eab22019-12-05 21:50:01 +01002603 // Check for hard coded <SNR>: already translated function ID (from a user
2604 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002605 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2606 && (*pp)[2] == (int)KE_SNR)
2607 {
2608 *pp += 3;
2609 len = get_id_len(pp) + 3;
2610 return vim_strnsave(start, len);
2611 }
2612
Bram Moolenaare38eab22019-12-05 21:50:01 +01002613 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2614 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 lead = eval_fname_script(start);
2616 if (lead > 2)
2617 start += lead;
2618
Bram Moolenaare38eab22019-12-05 21:50:01 +01002619 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002620 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 lead > 2 ? 0 : FNE_CHECK_START);
2622 if (end == start)
2623 {
2624 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002625 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 goto theend;
2627 }
2628 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2629 {
2630 /*
2631 * Report an invalid expression in braces, unless the expression
2632 * evaluation has been cancelled due to an aborting error, an
2633 * interrupt, or an exception.
2634 */
2635 if (!aborting())
2636 {
2637 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002638 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 }
2640 else
2641 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2642 goto theend;
2643 }
2644
2645 if (lv.ll_tv != NULL)
2646 {
2647 if (fdp != NULL)
2648 {
2649 fdp->fd_dict = lv.ll_dict;
2650 fdp->fd_newkey = lv.ll_newkey;
2651 lv.ll_newkey = NULL;
2652 fdp->fd_di = lv.ll_di;
2653 }
2654 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2655 {
2656 name = vim_strsave(lv.ll_tv->vval.v_string);
2657 *pp = end;
2658 }
2659 else if (lv.ll_tv->v_type == VAR_PARTIAL
2660 && lv.ll_tv->vval.v_partial != NULL)
2661 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002662 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 *pp = end;
2664 if (partial != NULL)
2665 *partial = lv.ll_tv->vval.v_partial;
2666 }
2667 else
2668 {
2669 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2670 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002671 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672 else
2673 *pp = end;
2674 name = NULL;
2675 }
2676 goto theend;
2677 }
2678
2679 if (lv.ll_name == NULL)
2680 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002681 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 *pp = end;
2683 goto theend;
2684 }
2685
Bram Moolenaare38eab22019-12-05 21:50:01 +01002686 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 if (lv.ll_exp_name != NULL)
2688 {
2689 len = (int)STRLEN(lv.ll_exp_name);
2690 name = deref_func_name(lv.ll_exp_name, &len, partial,
2691 flags & TFN_NO_AUTOLOAD);
2692 if (name == lv.ll_exp_name)
2693 name = NULL;
2694 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002695 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 {
2697 len = (int)(end - *pp);
2698 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2699 if (name == *pp)
2700 name = NULL;
2701 }
2702 if (name != NULL)
2703 {
2704 name = vim_strsave(name);
2705 *pp = end;
2706 if (STRNCMP(name, "<SNR>", 5) == 0)
2707 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002708 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 name[0] = K_SPECIAL;
2710 name[1] = KS_EXTRA;
2711 name[2] = (int)KE_SNR;
2712 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2713 }
2714 goto theend;
2715 }
2716
2717 if (lv.ll_exp_name != NULL)
2718 {
2719 len = (int)STRLEN(lv.ll_exp_name);
2720 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2721 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2722 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002723 // When there was "s:" already or the name expanded to get a
2724 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 lv.ll_name += 2;
2726 len -= 2;
2727 lead = 2;
2728 }
2729 }
2730 else
2731 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002732 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002734 {
2735 if (is_global != NULL && lv.ll_name[0] == 'g')
2736 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002737 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002738 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 len = (int)(end - lv.ll_name);
2740 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002741 if (len <= 0)
2742 {
2743 if (!skip)
2744 emsg(_(e_function_name));
2745 goto theend;
2746 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002748 // In Vim9 script a user function is script-local by default, unless it
2749 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002750 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002751 if (vim9script)
2752 {
2753 char_u *p;
2754
2755 // SomeScript#func() is a global function.
2756 for (p = start; *p != NUL && *p != '('; ++p)
2757 if (*p == AUTOLOAD_CHAR)
2758 vim9script = FALSE;
2759 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002760
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 /*
2762 * Copy the function name to allocated memory.
2763 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2764 * Accept <SNR>123_name() outside a script.
2765 */
2766 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002767 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002768 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002770 if (!vim9script)
2771 lead = 3;
2772 if (vim9script || (lv.ll_exp_name != NULL
2773 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 || eval_fname_sid(*pp))
2775 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002776 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002777 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002779 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 goto theend;
2781 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002782 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002783 if (vim9script)
2784 extra = 3 + (int)STRLEN(sid_buf);
2785 else
2786 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002787 }
2788 }
2789 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2790 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002791 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 start);
2793 goto theend;
2794 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002795 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 {
2797 char_u *cp = vim_strchr(lv.ll_name, ':');
2798
2799 if (cp != NULL && cp < end)
2800 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002801 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 goto theend;
2803 }
2804 }
2805
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002806 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 if (name != NULL)
2808 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002809 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 {
2811 name[0] = K_SPECIAL;
2812 name[1] = KS_EXTRA;
2813 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002814 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 STRCPY(name + 3, sid_buf);
2816 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002817 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2818 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 }
2820 *pp = end;
2821
2822theend:
2823 clear_lval(&lv);
2824 return name;
2825}
2826
2827/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002828 * Assuming "name" is the result of trans_function_name() and it was prefixed
2829 * to use the script-local name, return the unmodified name (points into
2830 * "name"). Otherwise return NULL.
2831 * This can be used to first search for a script-local function and fall back
2832 * to the global function if not found.
2833 */
2834 char_u *
2835untrans_function_name(char_u *name)
2836{
2837 char_u *p;
2838
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002839 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002840 {
2841 p = vim_strchr(name, '_');
2842 if (p != NULL)
2843 return p + 1;
2844 }
2845 return NULL;
2846}
2847
2848/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002849 * List functions. When "regmatch" is NULL all of then.
2850 * Otherwise functions matching "regmatch".
2851 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002852 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002853list_functions(regmatch_T *regmatch)
2854{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002855 int changed = func_hashtab.ht_changed;
2856 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002857 hashitem_T *hi;
2858
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002859 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002860 {
2861 if (!HASHITEM_EMPTY(hi))
2862 {
2863 ufunc_T *fp = HI2UF(hi);
2864
2865 --todo;
2866 if ((fp->uf_flags & FC_DEAD) == 0
2867 && (regmatch == NULL
2868 ? !message_filtered(fp->uf_name)
2869 && !func_name_refcount(fp->uf_name)
2870 : !isdigit(*fp->uf_name)
2871 && vim_regexec(regmatch, fp->uf_name, 0)))
2872 {
2873 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002874 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002875 {
2876 emsg(_("E454: function list was modified"));
2877 return;
2878 }
2879 }
2880 }
2881 }
2882}
2883
2884/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002885 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002886 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2887 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002888 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002890 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002891define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892{
2893 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002894 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 int j;
2896 int c;
2897 int saved_did_emsg;
2898 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002899 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002900 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 char_u *p;
2902 char_u *arg;
2903 char_u *line_arg = NULL;
2904 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002906 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 garray_T newlines;
2908 int varargs = FALSE;
2909 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002910 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002911 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002912 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002913 int indent;
2914 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002915#define MAX_FUNC_NESTING 50
2916 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 dictitem_T *v;
2918 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002919 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002922 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002923 linenr_T sourcing_lnum_off;
2924 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002925 int is_heredoc = FALSE;
2926 char_u *skip_until = NULL;
2927 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002928 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002929 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930
2931 /*
2932 * ":function" without argument: list functions.
2933 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002934 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002935 {
2936 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002937 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002939 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 }
2941
2942 /*
2943 * ":function /pat": list functions matching pattern.
2944 */
2945 if (*eap->arg == '/')
2946 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002947 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002948 if (!eap->skip)
2949 {
2950 regmatch_T regmatch;
2951
2952 c = *p;
2953 *p = NUL;
2954 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2955 *p = c;
2956 if (regmatch.regprog != NULL)
2957 {
2958 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002959 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002960 vim_regfree(regmatch.regprog);
2961 }
2962 }
2963 if (*p == '/')
2964 ++p;
2965 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002966 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967 }
2968
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002969 ga_init(&newargs);
2970 ga_init(&argtypes);
2971 ga_init(&default_args);
2972
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002973 /*
2974 * Get the function name. There are these situations:
2975 * func normal function name
2976 * "name" == func, "fudi.fd_dict" == NULL
2977 * dict.func new dictionary entry
2978 * "name" == NULL, "fudi.fd_dict" set,
2979 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2980 * dict.func existing dict entry with a Funcref
2981 * "name" == func, "fudi.fd_dict" set,
2982 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2983 * dict.func existing dict entry that's not a Funcref
2984 * "name" == NULL, "fudi.fd_dict" set,
2985 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2986 * s:func script-local function name
2987 * g:func global function name, same as "func"
2988 */
2989 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002990 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002992 // nested function, argument is (args).
2993 paren = TRUE;
2994 CLEAR_FIELD(fudi);
2995 }
2996 else
2997 {
2998 name = trans_function_name(&p, &is_global, eap->skip,
2999 TFN_NO_AUTOLOAD, &fudi, NULL);
3000 paren = (vim_strchr(p, '(') != NULL);
3001 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003003 /*
3004 * Return on an invalid expression in braces, unless the expression
3005 * evaluation has been cancelled due to an aborting error, an
3006 * interrupt, or an exception.
3007 */
3008 if (!aborting())
3009 {
3010 if (!eap->skip && fudi.fd_newkey != NULL)
3011 semsg(_(e_dictkey), fudi.fd_newkey);
3012 vim_free(fudi.fd_newkey);
3013 return NULL;
3014 }
3015 else
3016 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018 }
3019
Bram Moolenaare38eab22019-12-05 21:50:01 +01003020 // An error in a function call during evaluation of an expression in magic
3021 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 saved_did_emsg = did_emsg;
3023 did_emsg = FALSE;
3024
3025 /*
3026 * ":function func" with only function name: list function.
3027 */
3028 if (!paren)
3029 {
3030 if (!ends_excmd(*skipwhite(p)))
3031 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003032 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 goto ret_free;
3034 }
3035 eap->nextcmd = check_nextcmd(p);
3036 if (eap->nextcmd != NULL)
3037 *p = NUL;
3038 if (!eap->skip && !got_int)
3039 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003040 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003041 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3042 {
3043 char_u *up = untrans_function_name(name);
3044
3045 // With Vim9 script the name was made script-local, if not
3046 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003047 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003048 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003049 }
3050
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 if (fp != NULL)
3052 {
3053 list_func_head(fp, TRUE);
3054 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3055 {
3056 if (FUNCLINE(fp, j) == NULL)
3057 continue;
3058 msg_putchar('\n');
3059 msg_outnum((long)(j + 1));
3060 if (j < 9)
3061 msg_putchar(' ');
3062 if (j < 99)
3063 msg_putchar(' ');
3064 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003065 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 ui_breakcheck();
3067 }
3068 if (!got_int)
3069 {
3070 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003071 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003072 msg_puts(" enddef");
3073 else
3074 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003075 }
3076 }
3077 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003078 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079 }
3080 goto ret_free;
3081 }
3082
3083 /*
3084 * ":function name(arg1, arg2)" Define function.
3085 */
3086 p = skipwhite(p);
3087 if (*p != '(')
3088 {
3089 if (!eap->skip)
3090 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003091 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 goto ret_free;
3093 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003094 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003095 if (vim_strchr(p, '(') != NULL)
3096 p = vim_strchr(p, '(');
3097 }
3098 p = skipwhite(p + 1);
3099
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003100 // In Vim9 script only global functions can be redefined.
3101 if (vim9script && eap->forceit && !is_global)
3102 {
3103 emsg(_(e_nobang));
3104 goto ret_free;
3105 }
3106
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003107 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3108
Bram Moolenaar04b12692020-05-04 23:24:44 +02003109 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003110 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003111 // Check the name of the function. Unless it's a dictionary function
3112 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 if (name != NULL)
3114 arg = name;
3115 else
3116 arg = fudi.fd_newkey;
3117 if (arg != NULL && (fudi.fd_di == NULL
3118 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3119 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3120 {
3121 if (*arg == K_SPECIAL)
3122 j = 3;
3123 else
3124 j = 0;
3125 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3126 : eval_isnamec(arg[j])))
3127 ++j;
3128 if (arg[j] != NUL)
3129 emsg_funcname((char *)e_invarg2, arg);
3130 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003131 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003133 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 }
3135
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003136 // This may get more lines and make the pointers into the first line
3137 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003138 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003139 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003140 &varargs, &default_args, eap->skip,
3141 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 goto errret_2;
3143
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003144 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003146 // find the return type: :def Func(): type
3147 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003149 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003150 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003151 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003152 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003153 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003154 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003155 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003156 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003157 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003158 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003159 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003160 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003162 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003164 else
3165 // find extra arguments "range", "dict", "abort" and "closure"
3166 for (;;)
3167 {
3168 p = skipwhite(p);
3169 if (STRNCMP(p, "range", 5) == 0)
3170 {
3171 flags |= FC_RANGE;
3172 p += 5;
3173 }
3174 else if (STRNCMP(p, "dict", 4) == 0)
3175 {
3176 flags |= FC_DICT;
3177 p += 4;
3178 }
3179 else if (STRNCMP(p, "abort", 5) == 0)
3180 {
3181 flags |= FC_ABORT;
3182 p += 5;
3183 }
3184 else if (STRNCMP(p, "closure", 7) == 0)
3185 {
3186 flags |= FC_CLOSURE;
3187 p += 7;
3188 if (current_funccal == NULL)
3189 {
3190 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3191 name == NULL ? (char_u *)"" : name);
3192 goto erret;
3193 }
3194 }
3195 else
3196 break;
3197 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198
Bram Moolenaare38eab22019-12-05 21:50:01 +01003199 // When there is a line break use what follows for the function body.
3200 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 if (*p == '\n')
3202 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003203 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003204 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3205 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003206 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3207 && !eap->skip
3208 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003209 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210
3211 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003212 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3213 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 */
3215 if (KeyTyped)
3216 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003217 // Check if the function already exists, don't let the user type the
3218 // whole function before telling him it doesn't work! For a script we
3219 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220 if (!eap->skip && !eap->forceit)
3221 {
3222 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003223 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003224 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003225 emsg_funcname(e_funcexts, name);
3226 }
3227
3228 if (!eap->skip && did_emsg)
3229 goto erret;
3230
Bram Moolenaare38eab22019-12-05 21:50:01 +01003231 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 cmdline_row = msg_row;
3233 }
3234
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003235 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003236 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003237
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003238 // Detect having skipped over comment lines to find the return
3239 // type. Add NULL lines to keep the line count correct.
3240 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3241 if (SOURCING_LNUM < sourcing_lnum_off)
3242 {
3243 sourcing_lnum_off -= SOURCING_LNUM;
3244 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3245 goto erret;
3246 while (sourcing_lnum_off-- > 0)
3247 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3248 }
3249
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 indent = 2;
3251 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003252 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 for (;;)
3254 {
3255 if (KeyTyped)
3256 {
3257 msg_scroll = TRUE;
3258 saved_wait_return = FALSE;
3259 }
3260 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261
3262 if (line_arg != NULL)
3263 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003264 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 theline = line_arg;
3266 p = vim_strchr(theline, '\n');
3267 if (p == NULL)
3268 line_arg += STRLEN(line_arg);
3269 else
3270 {
3271 *p = NUL;
3272 line_arg = p + 1;
3273 }
3274 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003276 {
3277 vim_free(line_to_free);
3278 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003279 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003280 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003281 theline = eap->getline(':', eap->cookie, indent,
3282 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003283 line_to_free = theline;
3284 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285 if (KeyTyped)
3286 lines_left = Rows - 1;
3287 if (theline == NULL)
3288 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003289 if (skip_until != NULL)
3290 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3291 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003292 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293 else
3294 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003295 goto erret;
3296 }
3297
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003298 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003299 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003300 if (SOURCING_LNUM < sourcing_lnum_off)
3301 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003302 else
3303 sourcing_lnum_off = 0;
3304
3305 if (skip_until != NULL)
3306 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003308 // * ":append" and "."
3309 // * ":python <<EOF" and "EOF"
3310 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3311 if (heredoc_trimmed == NULL
3312 || (is_heredoc && skipwhite(theline) == theline)
3313 || STRNCMP(theline, heredoc_trimmed,
3314 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003315 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003316 if (heredoc_trimmed == NULL)
3317 p = theline;
3318 else if (is_heredoc)
3319 p = skipwhite(theline) == theline
3320 ? theline : theline + STRLEN(heredoc_trimmed);
3321 else
3322 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003323 if (STRCMP(p, skip_until) == 0)
3324 {
3325 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003326 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003327 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003328 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003329 }
3330 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 }
3332 else
3333 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003334 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003335 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 ;
3337
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003338 // Check for "endfunction" or "enddef".
3339 if (checkforcmd(&p, nesting_def[nesting]
3340 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003342 char_u *nextcmd = NULL;
3343
Bram Moolenaar663bb232017-06-22 19:12:10 +02003344 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003345 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003346 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003347 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003348 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003349 give_warning2(eap->cmdidx == CMD_def
3350 ? (char_u *)_("W1001: Text found after :enddef: %s")
3351 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003352 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003353 if (nextcmd != NULL)
3354 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003355 // Another command follows. If the line came from "eap" we
3356 // can simply point into it, otherwise we need to change
3357 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003358 eap->nextcmd = nextcmd;
3359 if (line_to_free != NULL)
3360 {
3361 vim_free(*eap->cmdlinep);
3362 *eap->cmdlinep = line_to_free;
3363 line_to_free = NULL;
3364 }
3365 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 break;
3367 }
3368
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // Increase indent inside "if", "while", "for" and "try", decrease
3370 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003371 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 indent -= 2;
3373 else if (STRNCMP(p, "if", 2) == 0
3374 || STRNCMP(p, "wh", 2) == 0
3375 || STRNCMP(p, "for", 3) == 0
3376 || STRNCMP(p, "try", 3) == 0)
3377 indent += 2;
3378
Bram Moolenaare38eab22019-12-05 21:50:01 +01003379 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003380 // Only recognize "def" inside "def", not inside "function",
3381 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003382 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003383 if (checkforcmd(&p, "function", 2)
3384 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385 {
3386 if (*p == '!')
3387 p = skipwhite(p + 1);
3388 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003389 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 if (*skipwhite(p) == '(')
3391 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003392 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003393 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003394 else
3395 {
3396 ++nesting;
3397 nesting_def[nesting] = (c == 'd');
3398 indent += 2;
3399 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 }
3401 }
3402
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003403 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003404 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003405 if (eap->cmdidx != CMD_def
3406 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003407 || (p[0] == 'c'
3408 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3409 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3410 && (STRNCMP(&p[3], "nge", 3) != 0
3411 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412 || (p[0] == 'i'
3413 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003414 && (!ASCII_ISALPHA(p[2])
3415 || (p[2] == 's'
3416 && (!ASCII_ISALPHA(p[3])
3417 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 skip_until = vim_strsave((char_u *)".");
3419
Bram Moolenaare38eab22019-12-05 21:50:01 +01003420 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 arg = skipwhite(skiptowhite(p));
3422 if (arg[0] == '<' && arg[1] =='<'
3423 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003424 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3425 || ((p[2] == '3' || p[2] == 'x')
3426 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 || (p[0] == 'p' && p[1] == 'e'
3428 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3429 || (p[0] == 't' && p[1] == 'c'
3430 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3431 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3432 && !ASCII_ISALPHA(p[3]))
3433 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3434 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3435 || (p[0] == 'm' && p[1] == 'z'
3436 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3437 ))
3438 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003439 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003441 if (STRNCMP(p, "trim", 4) == 0)
3442 {
3443 // Ignore leading white space.
3444 p = skipwhite(p + 4);
3445 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003446 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003447 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 if (*p == NUL)
3449 skip_until = vim_strsave((char_u *)".");
3450 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003451 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003452 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003453 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003455
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003456 // Check for ":cmd v =<< [trim] EOF"
3457 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003458 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003459 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003460 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003461 if (*arg == '[')
3462 arg = vim_strchr(arg, ']');
3463 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003464 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003465 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3466 && arg[1] == '<' && arg[2] =='<');
3467
3468 if (!found)
3469 // skip over the argument after "cmd"
3470 arg = skipwhite(skiptowhite(arg));
3471 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003472 && (checkforcmd(&p, "let", 2)
3473 || checkforcmd(&p, "var", 3)
3474 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003475 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003476 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003477 p = skipwhite(arg + 3);
3478 if (STRNCMP(p, "trim", 4) == 0)
3479 {
3480 // Ignore leading white space.
3481 p = skipwhite(p + 4);
3482 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003483 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003484 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003485 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003486 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003487 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003488 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003489 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 }
3491
Bram Moolenaare38eab22019-12-05 21:50:01 +01003492 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003494 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495
Bram Moolenaare38eab22019-12-05 21:50:01 +01003496 // Copy the line to newly allocated memory. get_one_sourceline()
3497 // allocates 250 bytes per line, this saves 80% on average. The cost
3498 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003500 if (p == NULL)
3501 goto erret;
3502 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003503
Bram Moolenaare38eab22019-12-05 21:50:01 +01003504 // Add NULL lines for continuation lines, so that the line count is
3505 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003506 while (sourcing_lnum_off-- > 0)
3507 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3508
Bram Moolenaare38eab22019-12-05 21:50:01 +01003509 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 if (line_arg != NULL && *line_arg == NUL)
3511 line_arg = NULL;
3512 }
3513
Bram Moolenaare38eab22019-12-05 21:50:01 +01003514 // Don't define the function when skipping commands or when an error was
3515 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 if (eap->skip || did_emsg)
3517 goto erret;
3518
3519 /*
3520 * If there are no errors, add the function
3521 */
3522 if (fudi.fd_dict == NULL)
3523 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003524 hashtab_T *ht;
3525
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 v = find_var(name, &ht, FALSE);
3527 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3528 {
3529 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3530 name);
3531 goto erret;
3532 }
3533
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003534 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003535 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003537 char_u *uname = untrans_function_name(name);
3538
3539 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3540 }
3541
3542 if (fp != NULL || import != NULL)
3543 {
3544 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003545
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003546 // Function can be replaced with "function!" and when sourcing the
3547 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003548 // A name that is used by an import can not be overruled.
3549 if (import != NULL
3550 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003551 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003552 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003554 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003555 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003556 else
3557 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 goto erret;
3559 }
3560 if (fp->uf_calls > 0)
3561 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003562 emsg_funcname(
3563 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 name);
3565 goto erret;
3566 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003567 if (fp->uf_refcount > 1)
3568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003569 // This function is referenced somewhere, don't redefine it but
3570 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003571 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003572 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003573 fp = NULL;
3574 overwrite = TRUE;
3575 }
3576 else
3577 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003578 char_u *exp_name = fp->uf_name_exp;
3579
3580 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003581 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003582 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003583 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003584 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003585 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003586#ifdef FEAT_PROFILE
3587 fp->uf_profiling = FALSE;
3588 fp->uf_prof_initialized = FALSE;
3589#endif
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003590 unlink_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003591 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 }
3593 }
3594 else
3595 {
3596 char numbuf[20];
3597
3598 fp = NULL;
3599 if (fudi.fd_newkey == NULL && !eap->forceit)
3600 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003601 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 goto erret;
3603 }
3604 if (fudi.fd_di == NULL)
3605 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003606 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003607 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 goto erret;
3609 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003610 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003611 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612 goto erret;
3613
Bram Moolenaare38eab22019-12-05 21:50:01 +01003614 // Give the function a sequential number. Can only be used with a
3615 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 vim_free(name);
3617 sprintf(numbuf, "%d", ++func_nr);
3618 name = vim_strsave((char_u *)numbuf);
3619 if (name == NULL)
3620 goto erret;
3621 }
3622
3623 if (fp == NULL)
3624 {
3625 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3626 {
3627 int slen, plen;
3628 char_u *scriptname;
3629
Bram Moolenaare38eab22019-12-05 21:50:01 +01003630 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003632 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 {
3634 scriptname = autoload_name(name);
3635 if (scriptname != NULL)
3636 {
3637 p = vim_strchr(scriptname, '/');
3638 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003639 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003641 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 j = OK;
3643 vim_free(scriptname);
3644 }
3645 }
3646 if (j == FAIL)
3647 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003648 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 goto erret;
3650 }
3651 }
3652
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003653 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654 if (fp == NULL)
3655 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003656 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003657 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658
3659 if (fudi.fd_dict != NULL)
3660 {
3661 if (fudi.fd_di == NULL)
3662 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003663 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3665 if (fudi.fd_di == NULL)
3666 {
3667 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003668 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 goto erret;
3670 }
3671 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3672 {
3673 vim_free(fudi.fd_di);
3674 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003675 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 goto erret;
3677 }
3678 }
3679 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003680 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 clear_tv(&fudi.fd_di->di_tv);
3682 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684
Bram Moolenaare38eab22019-12-05 21:50:01 +01003685 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686 flags |= FC_DICT;
3687 }
3688
Bram Moolenaare38eab22019-12-05 21:50:01 +01003689 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003690 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003691 if (overwrite)
3692 {
3693 hi = hash_find(&func_hashtab, name);
3694 hi->hi_key = UF2HIKEY(fp);
3695 }
3696 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 {
3698 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003699 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 goto erret;
3701 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003702 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 }
3704 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003705 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003706 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003707 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003708
3709 if (eap->cmdidx == CMD_def)
3710 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003711 int lnum_save = SOURCING_LNUM;
3712 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003713
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003714 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003715
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003716 // error messages are for the first function line
3717 SOURCING_LNUM = sourcing_lnum_top;
3718
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003719 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003720 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003721 int count = cstack->cs_idx + 1;
3722 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003723
3724 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003725 // a block that is visible now but not when the function is called
3726 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003727 fp->uf_block_ids = ALLOC_MULT(int, count);
3728 if (fp->uf_block_ids != NULL)
3729 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003730 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003731 sizeof(int) * count);
3732 fp->uf_block_depth = count;
3733 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003734
3735 // Set flag in each block to indicate a function was defined. This
3736 // is used to keep the variable when leaving the block, see
3737 // hide_script_var().
3738 for (i = 0; i <= cstack->cs_idx; ++i)
3739 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003740 }
3741
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003742 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003743 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003744 SOURCING_LNUM = lnum_save;
3745 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003746 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003747 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003748
3749 // parse the return type, if any
3750 if (ret_type == NULL)
3751 fp->uf_ret_type = &t_void;
3752 else
3753 {
3754 p = ret_type;
3755 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3756 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003757 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003758 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003759 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003760 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003761
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003763 if ((flags & FC_CLOSURE) != 0)
3764 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003765 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003766 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003767 }
3768 else
3769 fp->uf_scoped = NULL;
3770
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 if (prof_def_func())
3773 func_do_profile(fp);
3774#endif
3775 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003776 if (sandbox)
3777 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003778 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003779 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 fp->uf_flags = flags;
3781 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003782 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003783 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003784 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003785 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003786 if (is_export)
3787 {
3788 fp->uf_flags |= FC_EXPORT;
3789 // let ex_export() know the export worked.
3790 is_export = FALSE;
3791 }
3792
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003793 if (eap->cmdidx == CMD_def)
3794 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003795 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3796 // :func does not use Vim9 script syntax, even in a Vim9 script file
3797 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003798
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 goto ret_free;
3800
3801erret:
3802 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003803 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804errret_2:
3805 ga_clear_strings(&newlines);
3806ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003807 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003809 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003810 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003812 if (name != name_arg)
3813 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003814 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 did_emsg |= saved_did_emsg;
3816 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003817
3818 return fp;
3819}
3820
3821/*
3822 * ":function"
3823 */
3824 void
3825ex_function(exarg_T *eap)
3826{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003827 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003828}
3829
3830/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003831 * :defcompile - compile all :def functions in the current script that need to
3832 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003833 */
3834 void
3835ex_defcompile(exarg_T *eap UNUSED)
3836{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003837 long todo = (long)func_hashtab.ht_used;
3838 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003839 hashitem_T *hi;
3840 ufunc_T *ufunc;
3841
3842 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3843 {
3844 if (!HASHITEM_EMPTY(hi))
3845 {
3846 --todo;
3847 ufunc = HI2UF(hi);
3848 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003849 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3850 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003851 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003852 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003853
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003854 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003855 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003856 // a function has been added or removed, need to start over
3857 todo = (long)func_hashtab.ht_used;
3858 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003859 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003860 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003861 }
3862 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003863 }
3864 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865}
3866
3867/*
3868 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3869 * Return 2 if "p" starts with "s:".
3870 * Return 0 otherwise.
3871 */
3872 int
3873eval_fname_script(char_u *p)
3874{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003875 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3876 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3878 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3879 return 5;
3880 if (p[0] == 's' && p[1] == ':')
3881 return 2;
3882 return 0;
3883}
3884
3885 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003886translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887{
3888 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003889 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003890 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003891}
3892
3893/*
3894 * Return TRUE when "ufunc" has old-style "..." varargs
3895 * or named varargs "...name: type".
3896 */
3897 int
3898has_varargs(ufunc_T *ufunc)
3899{
3900 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901}
3902
3903/*
3904 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003905 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 */
3907 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003908function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909{
3910 char_u *nm = name;
3911 char_u *p;
3912 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003913 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003914 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003916 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3917 if (no_deref)
3918 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003919 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 nm = skipwhite(nm);
3921
Bram Moolenaare38eab22019-12-05 21:50:01 +01003922 // Only accept "funcname", "funcname ", "funcname (..." and
3923 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003925 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 vim_free(p);
3927 return n;
3928}
3929
Bram Moolenaar113e1072019-01-20 15:30:40 +01003930#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 char_u *
3932get_expanded_name(char_u *name, int check)
3933{
3934 char_u *nm = name;
3935 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003936 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003938 p = trans_function_name(&nm, &is_global, FALSE,
3939 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003941 if (p != NULL && *nm == NUL
3942 && (!check || translated_function_exists(p, is_global)))
3943 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944
3945 vim_free(p);
3946 return NULL;
3947}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003948#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950/*
3951 * Function given to ExpandGeneric() to obtain the list of user defined
3952 * function names.
3953 */
3954 char_u *
3955get_user_func_name(expand_T *xp, int idx)
3956{
3957 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003958 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959 static hashitem_T *hi;
3960 ufunc_T *fp;
3961
3962 if (idx == 0)
3963 {
3964 done = 0;
3965 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003966 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003967 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003968 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 {
3970 if (done++ > 0)
3971 ++hi;
3972 while (HASHITEM_EMPTY(hi))
3973 ++hi;
3974 fp = HI2UF(hi);
3975
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003976 // don't show dead, dict and lambda functions
3977 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003978 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003979 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980
3981 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983
3984 cat_func_name(IObuff, fp);
3985 if (xp->xp_context != EXPAND_USER_FUNC)
3986 {
3987 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003988 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 STRCAT(IObuff, ")");
3990 }
3991 return IObuff;
3992 }
3993 return NULL;
3994}
3995
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996/*
3997 * ":delfunction {name}"
3998 */
3999 void
4000ex_delfunction(exarg_T *eap)
4001{
4002 ufunc_T *fp = NULL;
4003 char_u *p;
4004 char_u *name;
4005 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004006 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007
4008 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004009 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 vim_free(fudi.fd_newkey);
4011 if (name == NULL)
4012 {
4013 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004014 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 return;
4016 }
4017 if (!ends_excmd(*skipwhite(p)))
4018 {
4019 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004020 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 return;
4022 }
4023 eap->nextcmd = check_nextcmd(p);
4024 if (eap->nextcmd != NULL)
4025 *p = NUL;
4026
4027 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004028 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 vim_free(name);
4030
4031 if (!eap->skip)
4032 {
4033 if (fp == NULL)
4034 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004035 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004036 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 return;
4038 }
4039 if (fp->uf_calls > 0)
4040 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004041 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 return;
4043 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004044 if (fp->uf_flags & FC_VIM9)
4045 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004046 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004047 return;
4048 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049
4050 if (fudi.fd_dict != NULL)
4051 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004052 // Delete the dict item that refers to the function, it will
4053 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4055 }
4056 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004057 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004058 // A normal function (not a numbered function or lambda) has a
4059 // refcount of 1 for the entry in the hashtable. When deleting
4060 // it and the refcount is more than one, it should be kept.
4061 // A numbered function and lambda should be kept if the refcount is
4062 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004063 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004064 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004065 // Function is still referenced somewhere. Don't free it but
4066 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004067 if (func_remove(fp))
4068 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004069 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004070 }
4071 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004072 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004073 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 }
4075}
4076
4077/*
4078 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004079 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 */
4081 void
4082func_unref(char_u *name)
4083{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004084 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004086 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004088 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004089 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004092 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004094 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004096 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004098 // Only delete it when it's not being used. Otherwise it's done
4099 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004100 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004101 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004102 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004103}
4104
4105/*
4106 * Unreference a Function: decrement the reference count and free it when it
4107 * becomes zero.
4108 */
4109 void
4110func_ptr_unref(ufunc_T *fp)
4111{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004112 if (fp != NULL && --fp->uf_refcount <= 0)
4113 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004114 // Only delete it when it's not being used. Otherwise it's done
4115 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004116 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004117 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 }
4119}
4120
4121/*
4122 * Count a reference to a Function.
4123 */
4124 void
4125func_ref(char_u *name)
4126{
4127 ufunc_T *fp;
4128
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004129 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004131 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004132 if (fp != NULL)
4133 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004135 // Only give an error for a numbered function.
4136 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004137 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004138}
4139
4140/*
4141 * Count a reference to a Function.
4142 */
4143 void
4144func_ptr_ref(ufunc_T *fp)
4145{
4146 if (fp != NULL)
4147 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148}
4149
4150/*
4151 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4152 * referenced from anywhere that is in use.
4153 */
4154 static int
4155can_free_funccal(funccall_T *fc, int copyID)
4156{
4157 return (fc->l_varlist.lv_copyID != copyID
4158 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004159 && fc->l_avars.dv_copyID != copyID
4160 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161}
4162
4163/*
4164 * ":return [expr]"
4165 */
4166 void
4167ex_return(exarg_T *eap)
4168{
4169 char_u *arg = eap->arg;
4170 typval_T rettv;
4171 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004172 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173
4174 if (current_funccal == NULL)
4175 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004176 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 return;
4178 }
4179
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004180 CLEAR_FIELD(evalarg);
4181 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4182
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 if (eap->skip)
4184 ++emsg_skip;
4185
4186 eap->nextcmd = NULL;
4187 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004188 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 {
4190 if (!eap->skip)
4191 returning = do_return(eap, FALSE, TRUE, &rettv);
4192 else
4193 clear_tv(&rettv);
4194 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004195 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196 else if (!eap->skip)
4197 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004198 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004199 update_force_abort();
4200
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 /*
4202 * Return unless the expression evaluation has been cancelled due to an
4203 * aborting error, an interrupt, or an exception.
4204 */
4205 if (!aborting())
4206 returning = do_return(eap, FALSE, TRUE, NULL);
4207 }
4208
Bram Moolenaare38eab22019-12-05 21:50:01 +01004209 // When skipping or the return gets pending, advance to the next command
4210 // in this line (!returning). Otherwise, ignore the rest of the line.
4211 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 if (returning)
4213 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004214 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215 eap->nextcmd = check_nextcmd(arg);
4216
4217 if (eap->skip)
4218 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004219 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220}
4221
4222/*
4223 * ":1,25call func(arg1, arg2)" function call.
4224 */
4225 void
4226ex_call(exarg_T *eap)
4227{
4228 char_u *arg = eap->arg;
4229 char_u *startarg;
4230 char_u *name;
4231 char_u *tofree;
4232 int len;
4233 typval_T rettv;
4234 linenr_T lnum;
4235 int doesrange;
4236 int failed = FALSE;
4237 funcdict_T fudi;
4238 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004239 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240
Bram Moolenaare6b53242020-07-01 17:28:33 +02004241 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242 if (eap->skip)
4243 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004244 // trans_function_name() doesn't work well when skipping, use eval0()
4245 // instead to skip to any following command, e.g. for:
4246 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004248 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249 clear_tv(&rettv);
4250 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004251 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 return;
4253 }
4254
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004255 tofree = trans_function_name(&arg, NULL, eap->skip,
4256 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257 if (fudi.fd_newkey != NULL)
4258 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004259 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004260 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 vim_free(fudi.fd_newkey);
4262 }
4263 if (tofree == NULL)
4264 return;
4265
Bram Moolenaare38eab22019-12-05 21:50:01 +01004266 // Increase refcount on dictionary, it could get deleted when evaluating
4267 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 if (fudi.fd_dict != NULL)
4269 ++fudi.fd_dict->dv_refcount;
4270
Bram Moolenaare38eab22019-12-05 21:50:01 +01004271 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4272 // contents. For VAR_PARTIAL get its partial, unless we already have one
4273 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274 len = (int)STRLEN(tofree);
4275 name = deref_func_name(tofree, &len,
4276 partial != NULL ? NULL : &partial, FALSE);
4277
Bram Moolenaare38eab22019-12-05 21:50:01 +01004278 // Skip white space to allow ":call func ()". Not good, but required for
4279 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004281 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282
4283 if (*startarg != '(')
4284 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004285 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 goto end;
4287 }
4288
4289 /*
4290 * When skipping, evaluate the function once, to find the end of the
4291 * arguments.
4292 * When the function takes a range, this is discovered after the first
4293 * call, and the loop is broken.
4294 */
4295 if (eap->skip)
4296 {
4297 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004298 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 }
4300 else
4301 lnum = eap->line1;
4302 for ( ; lnum <= eap->line2; ++lnum)
4303 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004304 funcexe_T funcexe;
4305
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 if (!eap->skip && eap->addr_count > 0)
4307 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004308 if (lnum > curbuf->b_ml.ml_line_count)
4309 {
4310 // If the function deleted lines or switched to another buffer
4311 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004312 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004313 break;
4314 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 curwin->w_cursor.lnum = lnum;
4316 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 }
4319 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004320
Bram Moolenaara80faa82020-04-12 19:37:17 +02004321 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004322 funcexe.firstline = eap->line1;
4323 funcexe.lastline = eap->line2;
4324 funcexe.doesrange = &doesrange;
4325 funcexe.evaluate = !eap->skip;
4326 funcexe.partial = partial;
4327 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004328 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 {
4330 failed = TRUE;
4331 break;
4332 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004333 if (has_watchexpr())
4334 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004336 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004337 if (handle_subscript(&arg, &rettv,
4338 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004339 {
4340 failed = TRUE;
4341 break;
4342 }
4343
4344 clear_tv(&rettv);
4345 if (doesrange || eap->skip)
4346 break;
4347
Bram Moolenaare38eab22019-12-05 21:50:01 +01004348 // Stop when immediately aborting on error, or when an interrupt
4349 // occurred or an exception was thrown but not caught.
4350 // get_func_tv() returned OK, so that the check for trailing
4351 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 if (aborting())
4353 break;
4354 }
4355 if (eap->skip)
4356 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004357 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358
Bram Moolenaare51bb172020-02-16 19:42:23 +01004359 // When inside :try we need to check for following "| catch".
4360 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004362 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004363 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004364 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004365 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004366 if (!failed)
4367 {
4368 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004369 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004370 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004371 }
4372 else
4373 eap->nextcmd = check_nextcmd(arg);
4374 }
4375
4376end:
4377 dict_unref(fudi.fd_dict);
4378 vim_free(tofree);
4379}
4380
4381/*
4382 * Return from a function. Possibly makes the return pending. Also called
4383 * for a pending return at the ":endtry" or after returning from an extra
4384 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4385 * when called due to a ":return" command. "rettv" may point to a typval_T
4386 * with the return rettv. Returns TRUE when the return can be carried out,
4387 * FALSE when the return gets pending.
4388 */
4389 int
4390do_return(
4391 exarg_T *eap,
4392 int reanimate,
4393 int is_cmd,
4394 void *rettv)
4395{
4396 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004397 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398
4399 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004400 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401 current_funccal->returned = FALSE;
4402
4403 /*
4404 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4405 * not in its finally clause (which then is to be executed next) is found.
4406 * In this case, make the ":return" pending for execution at the ":endtry".
4407 * Otherwise, return normally.
4408 */
4409 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4410 if (idx >= 0)
4411 {
4412 cstack->cs_pending[idx] = CSTP_RETURN;
4413
4414 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004415 // A pending return again gets pending. "rettv" points to an
4416 // allocated variable with the rettv of the original ":return"'s
4417 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 cstack->cs_rettv[idx] = rettv;
4419 else
4420 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004421 // When undoing a return in order to make it pending, get the stored
4422 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 if (reanimate)
4424 rettv = current_funccal->rettv;
4425
4426 if (rettv != NULL)
4427 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004428 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4430 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4431 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004432 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 }
4434 else
4435 cstack->cs_rettv[idx] = NULL;
4436
4437 if (reanimate)
4438 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004439 // The pending return value could be overwritten by a ":return"
4440 // without argument in a finally clause; reset the default
4441 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 current_funccal->rettv->v_type = VAR_NUMBER;
4443 current_funccal->rettv->vval.v_number = 0;
4444 }
4445 }
4446 report_make_pending(CSTP_RETURN, rettv);
4447 }
4448 else
4449 {
4450 current_funccal->returned = TRUE;
4451
Bram Moolenaare38eab22019-12-05 21:50:01 +01004452 // If the return is carried out now, store the return value. For
4453 // a return immediately after reanimation, the value is already
4454 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 if (!reanimate && rettv != NULL)
4456 {
4457 clear_tv(current_funccal->rettv);
4458 *current_funccal->rettv = *(typval_T *)rettv;
4459 if (!is_cmd)
4460 vim_free(rettv);
4461 }
4462 }
4463
4464 return idx < 0;
4465}
4466
4467/*
4468 * Free the variable with a pending return value.
4469 */
4470 void
4471discard_pending_return(void *rettv)
4472{
4473 free_tv((typval_T *)rettv);
4474}
4475
4476/*
4477 * Generate a return command for producing the value of "rettv". The result
4478 * is an allocated string. Used by report_pending() for verbose messages.
4479 */
4480 char_u *
4481get_return_cmd(void *rettv)
4482{
4483 char_u *s = NULL;
4484 char_u *tofree = NULL;
4485 char_u numbuf[NUMBUFLEN];
4486
4487 if (rettv != NULL)
4488 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4489 if (s == NULL)
4490 s = (char_u *)"";
4491
4492 STRCPY(IObuff, ":return ");
4493 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4494 if (STRLEN(s) + 8 >= IOSIZE)
4495 STRCPY(IObuff + IOSIZE - 4, "...");
4496 vim_free(tofree);
4497 return vim_strsave(IObuff);
4498}
4499
4500/*
4501 * Get next function line.
4502 * Called by do_cmdline() to get the next line.
4503 * Returns allocated string, or NULL for end of function.
4504 */
4505 char_u *
4506get_func_line(
4507 int c UNUSED,
4508 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004509 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004510 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511{
4512 funccall_T *fcp = (funccall_T *)cookie;
4513 ufunc_T *fp = fcp->func;
4514 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004515 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516
Bram Moolenaare38eab22019-12-05 21:50:01 +01004517 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004518 if (fcp->dbg_tick != debug_tick)
4519 {
4520 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004521 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522 fcp->dbg_tick = debug_tick;
4523 }
4524#ifdef FEAT_PROFILE
4525 if (do_profiling == PROF_YES)
4526 func_line_end(cookie);
4527#endif
4528
4529 gap = &fp->uf_lines;
4530 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4531 || fcp->returned)
4532 retval = NULL;
4533 else
4534 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004535 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 while (fcp->linenr < gap->ga_len
4537 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4538 ++fcp->linenr;
4539 if (fcp->linenr >= gap->ga_len)
4540 retval = NULL;
4541 else
4542 {
4543 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004544 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545#ifdef FEAT_PROFILE
4546 if (do_profiling == PROF_YES)
4547 func_line_start(cookie);
4548#endif
4549 }
4550 }
4551
Bram Moolenaare38eab22019-12-05 21:50:01 +01004552 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004553 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004555 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004556 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004558 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 fcp->dbg_tick = debug_tick;
4560 }
4561
4562 return retval;
4563}
4564
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565/*
4566 * Return TRUE if the currently active function should be ended, because a
4567 * return was encountered or an error occurred. Used inside a ":while".
4568 */
4569 int
4570func_has_ended(void *cookie)
4571{
4572 funccall_T *fcp = (funccall_T *)cookie;
4573
Bram Moolenaare38eab22019-12-05 21:50:01 +01004574 // Ignore the "abort" flag if the abortion behavior has been changed due to
4575 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4577 || fcp->returned);
4578}
4579
4580/*
4581 * return TRUE if cookie indicates a function which "abort"s on errors.
4582 */
4583 int
4584func_has_abort(
4585 void *cookie)
4586{
4587 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4588}
4589
4590
4591/*
4592 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4593 * Don't do this when "Func" is already a partial that was bound
4594 * explicitly (pt_auto is FALSE).
4595 * Changes "rettv" in-place.
4596 * Returns the updated "selfdict_in".
4597 */
4598 dict_T *
4599make_partial(dict_T *selfdict_in, typval_T *rettv)
4600{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004601 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004602 char_u *tofree = NULL;
4603 ufunc_T *fp;
4604 char_u fname_buf[FLEN_FIXED + 1];
4605 int error;
4606 dict_T *selfdict = selfdict_in;
4607
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004608 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4609 fp = rettv->vval.v_partial->pt_func;
4610 else
4611 {
4612 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4613 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004614 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004615 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004616 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004617 vim_free(tofree);
4618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619
4620 if (fp != NULL && (fp->uf_flags & FC_DICT))
4621 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004622 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004623
4624 if (pt != NULL)
4625 {
4626 pt->pt_refcount = 1;
4627 pt->pt_dict = selfdict;
4628 pt->pt_auto = TRUE;
4629 selfdict = NULL;
4630 if (rettv->v_type == VAR_FUNC)
4631 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004632 // Just a function: Take over the function name and use
4633 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 pt->pt_name = rettv->vval.v_string;
4635 }
4636 else
4637 {
4638 partial_T *ret_pt = rettv->vval.v_partial;
4639 int i;
4640
Bram Moolenaare38eab22019-12-05 21:50:01 +01004641 // Partial: copy the function name, use selfdict and copy
4642 // args. Can't take over name or args, the partial might
4643 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004644 if (ret_pt->pt_name != NULL)
4645 {
4646 pt->pt_name = vim_strsave(ret_pt->pt_name);
4647 func_ref(pt->pt_name);
4648 }
4649 else
4650 {
4651 pt->pt_func = ret_pt->pt_func;
4652 func_ptr_ref(pt->pt_func);
4653 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654 if (ret_pt->pt_argc > 0)
4655 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004656 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004657 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659 pt->pt_argc = 0;
4660 else
4661 {
4662 pt->pt_argc = ret_pt->pt_argc;
4663 for (i = 0; i < pt->pt_argc; i++)
4664 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4665 }
4666 }
4667 partial_unref(ret_pt);
4668 }
4669 rettv->v_type = VAR_PARTIAL;
4670 rettv->vval.v_partial = pt;
4671 }
4672 }
4673 return selfdict;
4674}
4675
4676/*
4677 * Return the name of the executed function.
4678 */
4679 char_u *
4680func_name(void *cookie)
4681{
4682 return ((funccall_T *)cookie)->func->uf_name;
4683}
4684
4685/*
4686 * Return the address holding the next breakpoint line for a funccall cookie.
4687 */
4688 linenr_T *
4689func_breakpoint(void *cookie)
4690{
4691 return &((funccall_T *)cookie)->breakpoint;
4692}
4693
4694/*
4695 * Return the address holding the debug tick for a funccall cookie.
4696 */
4697 int *
4698func_dbg_tick(void *cookie)
4699{
4700 return &((funccall_T *)cookie)->dbg_tick;
4701}
4702
4703/*
4704 * Return the nesting level for a funccall cookie.
4705 */
4706 int
4707func_level(void *cookie)
4708{
4709 return ((funccall_T *)cookie)->level;
4710}
4711
4712/*
4713 * Return TRUE when a function was ended by a ":return" command.
4714 */
4715 int
4716current_func_returned(void)
4717{
4718 return current_funccal->returned;
4719}
4720
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721 int
4722free_unref_funccal(int copyID, int testing)
4723{
4724 int did_free = FALSE;
4725 int did_free_funccal = FALSE;
4726 funccall_T *fc, **pfc;
4727
4728 for (pfc = &previous_funccal; *pfc != NULL; )
4729 {
4730 if (can_free_funccal(*pfc, copyID))
4731 {
4732 fc = *pfc;
4733 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004734 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 did_free = TRUE;
4736 did_free_funccal = TRUE;
4737 }
4738 else
4739 pfc = &(*pfc)->caller;
4740 }
4741 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004742 // When a funccal was freed some more items might be garbage
4743 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744 (void)garbage_collect(testing);
4745
4746 return did_free;
4747}
4748
4749/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004750 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 */
4752 static funccall_T *
4753get_funccal(void)
4754{
4755 int i;
4756 funccall_T *funccal;
4757 funccall_T *temp_funccal;
4758
4759 funccal = current_funccal;
4760 if (debug_backtrace_level > 0)
4761 {
4762 for (i = 0; i < debug_backtrace_level; i++)
4763 {
4764 temp_funccal = funccal->caller;
4765 if (temp_funccal)
4766 funccal = temp_funccal;
4767 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004768 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 debug_backtrace_level = i;
4770 }
4771 }
4772 return funccal;
4773}
4774
4775/*
4776 * Return the hashtable used for local variables in the current funccal.
4777 * Return NULL if there is no current funccal.
4778 */
4779 hashtab_T *
4780get_funccal_local_ht()
4781{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004782 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 return NULL;
4784 return &get_funccal()->l_vars.dv_hashtab;
4785}
4786
4787/*
4788 * Return the l: scope variable.
4789 * Return NULL if there is no current funccal.
4790 */
4791 dictitem_T *
4792get_funccal_local_var()
4793{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004794 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 return NULL;
4796 return &get_funccal()->l_vars_var;
4797}
4798
4799/*
4800 * Return the hashtable used for argument in the current funccal.
4801 * Return NULL if there is no current funccal.
4802 */
4803 hashtab_T *
4804get_funccal_args_ht()
4805{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004806 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 return NULL;
4808 return &get_funccal()->l_avars.dv_hashtab;
4809}
4810
4811/*
4812 * Return the a: scope variable.
4813 * Return NULL if there is no current funccal.
4814 */
4815 dictitem_T *
4816get_funccal_args_var()
4817{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004818 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004820 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004821}
4822
4823/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824 * List function variables, if there is a function.
4825 */
4826 void
4827list_func_vars(int *first)
4828{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004829 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004830 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004831 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832}
4833
4834/*
4835 * If "ht" is the hashtable for local variables in the current funccal, return
4836 * the dict that contains it.
4837 * Otherwise return NULL.
4838 */
4839 dict_T *
4840get_current_funccal_dict(hashtab_T *ht)
4841{
4842 if (current_funccal != NULL
4843 && ht == &current_funccal->l_vars.dv_hashtab)
4844 return &current_funccal->l_vars;
4845 return NULL;
4846}
4847
4848/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004849 * Search hashitem in parent scope.
4850 */
4851 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004852find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004853{
4854 funccall_T *old_current_funccal = current_funccal;
4855 hashtab_T *ht;
4856 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004857 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004858
4859 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4860 return NULL;
4861
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004862 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004863 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004864 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004865 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004866 ht = find_var_ht(name, &varname);
4867 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004868 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004869 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004870 if (!HASHITEM_EMPTY(hi))
4871 {
4872 *pht = ht;
4873 break;
4874 }
4875 }
4876 if (current_funccal == current_funccal->func->uf_scoped)
4877 break;
4878 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004879 }
4880 current_funccal = old_current_funccal;
4881
4882 return hi;
4883}
4884
4885/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004886 * Search variable in parent scope.
4887 */
4888 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004889find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004890{
4891 dictitem_T *v = NULL;
4892 funccall_T *old_current_funccal = current_funccal;
4893 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004894 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004895
4896 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4897 return NULL;
4898
Bram Moolenaare38eab22019-12-05 21:50:01 +01004899 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004900 current_funccal = current_funccal->func->uf_scoped;
4901 while (current_funccal)
4902 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004903 ht = find_var_ht(name, &varname);
4904 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004905 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004906 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004907 if (v != NULL)
4908 break;
4909 }
4910 if (current_funccal == current_funccal->func->uf_scoped)
4911 break;
4912 current_funccal = current_funccal->func->uf_scoped;
4913 }
4914 current_funccal = old_current_funccal;
4915
4916 return v;
4917}
4918
4919/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920 * Set "copyID + 1" in previous_funccal and callers.
4921 */
4922 int
4923set_ref_in_previous_funccal(int copyID)
4924{
4925 int abort = FALSE;
4926 funccall_T *fc;
4927
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004928 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004929 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004930 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004931 abort = abort
4932 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4933 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004934 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 }
4936 return abort;
4937}
4938
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004939 static int
4940set_ref_in_funccal(funccall_T *fc, int copyID)
4941{
4942 int abort = FALSE;
4943
4944 if (fc->fc_copyID != copyID)
4945 {
4946 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004947 abort = abort
4948 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4949 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004950 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004951 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004952 }
4953 return abort;
4954}
4955
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956/*
4957 * Set "copyID" in all local vars and arguments in the call stack.
4958 */
4959 int
4960set_ref_in_call_stack(int copyID)
4961{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004962 int abort = FALSE;
4963 funccall_T *fc;
4964 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004966 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004967 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004968
4969 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004970 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4971 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004972 abort = abort || set_ref_in_funccal(fc, copyID);
4973
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004974 return abort;
4975}
4976
4977/*
4978 * Set "copyID" in all functions available by name.
4979 */
4980 int
4981set_ref_in_functions(int copyID)
4982{
4983 int todo;
4984 hashitem_T *hi = NULL;
4985 int abort = FALSE;
4986 ufunc_T *fp;
4987
4988 todo = (int)func_hashtab.ht_used;
4989 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004990 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004991 if (!HASHITEM_EMPTY(hi))
4992 {
4993 --todo;
4994 fp = HI2UF(hi);
4995 if (!func_name_refcount(fp->uf_name))
4996 abort = abort || set_ref_in_func(NULL, fp, copyID);
4997 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004998 }
4999 return abort;
5000}
5001
5002/*
5003 * Set "copyID" in all function arguments.
5004 */
5005 int
5006set_ref_in_func_args(int copyID)
5007{
5008 int i;
5009 int abort = FALSE;
5010
5011 for (i = 0; i < funcargs.ga_len; ++i)
5012 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5013 copyID, NULL, NULL);
5014 return abort;
5015}
5016
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005017/*
5018 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005019 * Returns TRUE if setting references failed somehow.
5020 */
5021 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005022set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005023{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005024 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005025 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005026 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005027 char_u fname_buf[FLEN_FIXED + 1];
5028 char_u *tofree = NULL;
5029 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005030 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005031
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005032 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005033 return FALSE;
5034
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005035 if (fp_in == NULL)
5036 {
5037 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005038 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005039 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005040 if (fp != NULL)
5041 {
5042 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005043 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005044 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005045
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005046 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005047 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005048}
5049
Bram Moolenaare38eab22019-12-05 21:50:01 +01005050#endif // FEAT_EVAL