blob: ccd1bd382e7061c20ffee7c59eeb38a09b56c68b [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.
157 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100158 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200159get_function_args(
160 char_u **argp,
161 char_u endchar,
162 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100163 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100164 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200165 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200166 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200167 int skip,
168 exarg_T *eap,
169 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170{
171 int mustend = FALSE;
172 char_u *arg = *argp;
173 char_u *p = arg;
174 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200175 int any_default = FALSE;
176 char_u *expr;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200177 char_u *whitep = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200178
179 if (newargs != NULL)
180 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100181 if (argtypes != NULL)
182 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200183 if (default_args != NULL)
184 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200185
186 if (varargs != NULL)
187 *varargs = FALSE;
188
189 /*
190 * Isolate the arguments: "arg1, arg2, ...)"
191 */
192 while (*p != endchar)
193 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200194 while (eap != NULL && eap->getline != NULL
195 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200196 {
197 char_u *theline;
198
199 // End of the line, get the next one.
200 theline = eap->getline(':', eap->cookie, 0, TRUE);
201 if (theline == NULL)
202 break;
203 vim_free(*line_to_free);
204 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200205 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200206 p = skipwhite(theline);
207 }
208
209 if (mustend && *p != endchar)
210 {
211 if (!skip)
212 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100213 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200214 }
215 if (*p == endchar)
216 break;
217
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
219 {
220 if (varargs != NULL)
221 *varargs = TRUE;
222 p += 3;
223 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100224
225 if (argtypes != NULL)
226 {
227 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200228 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100230 if (!skip)
231 emsg(_(e_missing_name_after_dots));
232 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100233 }
234
235 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100236 p = one_function_arg(p, newargs, argtypes, types_optional,
237 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100238 if (p == arg)
239 break;
240 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200241 }
242 else
243 {
244 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100245 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100246 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200247 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200248
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200249 if (*skipwhite(p) == '=' && default_args != NULL)
250 {
251 typval_T rettv;
252
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100253 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200254 any_default = TRUE;
255 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200256 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200257 p = skipwhite(p);
258 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200259 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200260 {
261 if (ga_grow(default_args, 1) == FAIL)
262 goto err_ret;
263
264 // trim trailing whitespace
265 while (p > expr && VIM_ISWHITE(p[-1]))
266 p--;
267 c = *p;
268 *p = NUL;
269 expr = vim_strsave(expr);
270 if (expr == NULL)
271 {
272 *p = c;
273 goto err_ret;
274 }
275 ((char_u **)(default_args->ga_data))
276 [default_args->ga_len] = expr;
277 default_args->ga_len++;
278 *p = c;
279 }
280 else
281 mustend = TRUE;
282 }
283 else if (any_default)
284 {
285 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200286 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200287 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200288 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200289 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200290 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200291 // Don't give this error when skipping, it makes the "->" not
292 // found in "{k,v -> x}" and give a confusing error.
293 if (!skip && in_vim9script()
294 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
295 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200296 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200297 goto err_ret;
298 }
299 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200300 else
301 mustend = TRUE;
302 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200303 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200305 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200306
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200307 if (*p != endchar)
308 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100309 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200310
311 *argp = p;
312 return OK;
313
314err_ret:
315 if (newargs != NULL)
316 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 if (default_args != NULL)
318 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200319 return FAIL;
320}
321
322/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100323 * Parse the argument types, filling "fp->uf_arg_types".
324 * Return OK or FAIL.
325 */
326 static int
327parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
328{
329 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
330 if (argtypes->ga_len > 0)
331 {
332 // When "varargs" is set the last name/type goes into uf_va_name
333 // and uf_va_type.
334 int len = argtypes->ga_len - (varargs ? 1 : 0);
335
336 if (len > 0)
337 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
338 if (fp->uf_arg_types != NULL)
339 {
340 int i;
341 type_T *type;
342
343 for (i = 0; i < len; ++ i)
344 {
345 char_u *p = ((char_u **)argtypes->ga_data)[i];
346
347 if (p == NULL)
348 // will get the type from the default value
349 type = &t_unknown;
350 else
351 type = parse_type(&p, &fp->uf_type_list);
352 if (type == NULL)
353 return FAIL;
354 fp->uf_arg_types[i] = type;
355 }
356 }
357 if (varargs)
358 {
359 char_u *p;
360
361 // Move the last argument "...name: type" to uf_va_name and
362 // uf_va_type.
363 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
364 [fp->uf_args.ga_len - 1];
365 --fp->uf_args.ga_len;
366 p = ((char_u **)argtypes->ga_data)[len];
367 if (p == NULL)
368 // todo: get type from default value
369 fp->uf_va_type = &t_any;
370 else
371 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
372 if (fp->uf_va_type == NULL)
373 return FAIL;
374 }
375 }
376 return OK;
377}
378
379/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200380 * Register function "fp" as using "current_funccal" as its scope.
381 */
382 static int
383register_closure(ufunc_T *fp)
384{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200385 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100386 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200387 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200388 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200389 fp->uf_scoped = current_funccal;
390 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200391
Bram Moolenaar58016442016-07-31 18:30:22 +0200392 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
393 return FAIL;
394 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
395 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200396 return OK;
397}
398
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100399 static void
400set_ufunc_name(ufunc_T *fp, char_u *name)
401{
402 STRCPY(fp->uf_name, name);
403
404 if (name[0] == K_SPECIAL)
405 {
406 fp->uf_name_exp = alloc(STRLEN(name) + 3);
407 if (fp->uf_name_exp != NULL)
408 {
409 STRCPY(fp->uf_name_exp, "<SNR>");
410 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
411 }
412 }
413}
414
Bram Moolenaar58016442016-07-31 18:30:22 +0200415/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200416 * Get a name for a lambda. Returned in static memory.
417 */
418 char_u *
419get_lambda_name(void)
420{
421 static char_u name[30];
422 static int lambda_no = 0;
423
424 sprintf((char*)name, "<lambda>%d", ++lambda_no);
425 return name;
426}
427
Bram Moolenaar801ab062020-06-25 19:27:56 +0200428#if defined(FEAT_LUA) || defined(PROTO)
429/*
430 * Registers a native C callback which can be called from Vim script.
431 * Returns the name of the Vim script function.
432 */
433 char_u *
434register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
435{
436 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200437 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200438
439 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
440 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200441 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200442
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200443 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200444 fp->uf_refcount = 1;
445 fp->uf_varargs = TRUE;
446 fp->uf_flags = FC_CFUNC;
447 fp->uf_calls = 0;
448 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200449 fp->uf_cb = cb;
450 fp->uf_cb_free = cb_free;
451 fp->uf_cb_state = state;
452
453 set_ufunc_name(fp, name);
454 hash_add(&func_hashtab, UF2HIKEY(fp));
455
456 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200457}
458#endif
459
Bram Moolenaar04b12692020-05-04 23:24:44 +0200460/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200461 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100462 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200463 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
464 */
465 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100466get_lambda_tv(
467 char_u **arg,
468 typval_T *rettv,
469 int types_optional,
470 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200471{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200472 int evaluate = evalarg != NULL
473 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200474 garray_T newargs;
475 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200476 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100477 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200478 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100479 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200480 int varargs;
481 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200482 char_u *s;
483 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200484 int *old_eval_lavars = eval_lavars_used;
485 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200486 char_u *tofree = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200487
488 ga_init(&newargs);
489 ga_init(&newlines);
490
Bram Moolenaare38eab22019-12-05 21:50:01 +0100491 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200492 s = skipwhite(*arg + 1);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100493 ret = get_function_args(&s, '-', NULL,
494 types_optional ? &argtypes : NULL, types_optional,
495 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200496 if (ret == FAIL || *s != '>')
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200497 return NOTDONE;
498
Bram Moolenaare38eab22019-12-05 21:50:01 +0100499 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200500 if (evaluate)
501 pnewargs = &newargs;
502 else
503 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200504 *arg = skipwhite(*arg + 1);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100505 ret = get_function_args(arg, '-', pnewargs,
506 types_optional ? &argtypes : NULL, types_optional,
507 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200508 if (ret == FAIL || **arg != '>')
509 goto errret;
510
Bram Moolenaare38eab22019-12-05 21:50:01 +0100511 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200512 if (evaluate)
513 eval_lavars_used = &eval_lavars;
514
Bram Moolenaare38eab22019-12-05 21:50:01 +0100515 // Get the start and the end of the expression.
Bram Moolenaar9215f012020-06-27 21:18:00 +0200516 *arg = skipwhite_and_linebreak(*arg + 1, evalarg);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200517 start = *arg;
518 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200519 if (ret == FAIL)
520 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200521 if (evalarg != NULL)
522 {
523 // avoid that the expression gets freed when another line break follows
524 tofree = evalarg->eval_tofree;
525 evalarg->eval_tofree = NULL;
526 }
527
Bram Moolenaar9215f012020-06-27 21:18:00 +0200528 *arg = skipwhite_and_linebreak(*arg, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200529 if (**arg != '}')
Bram Moolenaaree619e52020-03-28 21:38:06 +0100530 {
531 semsg(_("E451: Expected }: %s"), *arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200532 goto errret;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100533 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200534 ++*arg;
535
536 if (evaluate)
537 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200538 int len;
539 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200540 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200541 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200542
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200543 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200544 if (fp == NULL)
545 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200546 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200547 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200548 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200549 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200550
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200551 ga_init2(&newlines, (int)sizeof(char_u *), 1);
552 if (ga_grow(&newlines, 1) == FAIL)
553 goto errret;
554
Bram Moolenaare38eab22019-12-05 21:50:01 +0100555 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200556 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200557 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200558 if (p == NULL)
559 goto errret;
560 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
561 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200562 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200563 if (strstr((char *)p + 7, "a:") == NULL)
564 // No a: variables are used for sure.
565 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200566
567 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100568 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200569 hash_add(&func_hashtab, UF2HIKEY(fp));
570 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200571 ga_init(&fp->uf_def_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100572 if (types_optional
573 && parse_argument_types(fp, &argtypes, FALSE) == FAIL)
574 goto errret;
575
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200576 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200577 if (current_funccal != NULL && eval_lavars)
578 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200579 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200580 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200581 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200582 }
583 else
584 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200585
586#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200587 if (prof_def_func())
588 func_do_profile(fp);
589#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200590 if (sandbox)
591 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100592 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200593 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200594 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200595 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200596 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100597 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200598
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200599 pt->pt_func = fp;
600 pt->pt_refcount = 1;
601 rettv->vval.v_partial = pt;
602 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200603 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200604
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200605 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200606 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200607 evalarg->eval_tofree = tofree;
608 else
609 vim_free(tofree);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100610 if (types_optional)
611 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200612 return OK;
613
614errret:
615 ga_clear_strings(&newargs);
616 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100617 if (types_optional)
618 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200619 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100620 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200621 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200622 evalarg->eval_tofree = tofree;
623 else
624 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200625 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200626 return FAIL;
627}
628
629/*
630 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
631 * name it contains, otherwise return "name".
632 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
633 * "partialp".
634 */
635 char_u *
636deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
637{
638 dictitem_T *v;
639 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200640 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200641
642 if (partialp != NULL)
643 *partialp = NULL;
644
645 cc = name[*lenp];
646 name[*lenp] = NUL;
647 v = find_var(name, NULL, no_autoload);
648 name[*lenp] = cc;
649 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
650 {
651 if (v->di_tv.vval.v_string == NULL)
652 {
653 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100654 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200655 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200656 s = v->di_tv.vval.v_string;
657 *lenp = (int)STRLEN(s);
658 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200659 }
660
661 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
662 {
663 partial_T *pt = v->di_tv.vval.v_partial;
664
665 if (pt == NULL)
666 {
667 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100668 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200669 }
670 if (partialp != NULL)
671 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200672 s = partial_name(pt);
673 *lenp = (int)STRLEN(s);
674 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200675 }
676
677 return name;
678}
679
680/*
681 * Give an error message with a function name. Handle <SNR> things.
682 * "ermsg" is to be passed without translation, use N_() instead of _().
683 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100684 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200685emsg_funcname(char *ermsg, char_u *name)
686{
687 char_u *p;
688
689 if (*name == K_SPECIAL)
690 p = concat_str((char_u *)"<SNR>", name + 3);
691 else
692 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100693 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200694 if (p != name)
695 vim_free(p);
696}
697
698/*
699 * Allocate a variable for the result of a function.
700 * Return OK or FAIL.
701 */
702 int
703get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200704 char_u *name, // name of the function
705 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200706 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200707 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200708 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200709 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200710{
711 char_u *argp;
712 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100713 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
714 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200715 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200716
717 /*
718 * Get the arguments.
719 */
720 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200721 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
722 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200723 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200724 // skip the '(' or ',' and possibly line breaks
725 argp = skipwhite_and_linebreak(argp + 1, evalarg);
726
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200727 if (*argp == ')' || *argp == ',' || *argp == NUL)
728 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200729 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730 {
731 ret = FAIL;
732 break;
733 }
734 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200735 // The comma should come right after the argument, but this wasn't
736 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200737 if (vim9script)
738 {
739 if (*argp != ',' && *skipwhite(argp) == ',')
740 {
741 semsg(_(e_no_white_space_allowed_before_str), ",");
742 ret = FAIL;
743 break;
744 }
745 }
746 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200747 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200748 if (*argp != ',')
749 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200750 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
751 {
752 semsg(_(e_white_space_required_after_str), ",");
753 ret = FAIL;
754 break;
755 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200756 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200757 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200758 if (*argp == ')')
759 ++argp;
760 else
761 ret = FAIL;
762
763 if (ret == OK)
764 {
765 int i = 0;
766
767 if (get_vim_var_nr(VV_TESTING))
768 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100769 // Prepare for calling test_garbagecollect_now(), need to know
770 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200771 if (funcargs.ga_itemsize == 0)
772 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
773 for (i = 0; i < argcount; ++i)
774 if (ga_grow(&funcargs, 1) == OK)
775 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
776 &argvars[i];
777 }
778
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200779 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200780
781 funcargs.ga_len -= i;
782 }
783 else if (!aborting())
784 {
785 if (argcount == MAX_FUNC_ARGS)
786 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
787 else
788 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
789 }
790
791 while (--argcount >= 0)
792 clear_tv(&argvars[argcount]);
793
Bram Moolenaar8294d492020-08-10 22:40:56 +0200794 if (in_vim9script())
795 *arg = argp;
796 else
797 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200798 return ret;
799}
800
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200801/*
802 * Return TRUE if "p" starts with "<SID>" or "s:".
803 * Only works if eval_fname_script() returned non-zero for "p"!
804 */
805 static int
806eval_fname_sid(char_u *p)
807{
808 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
809}
810
811/*
812 * In a script change <SID>name() and s:name() to K_SNR 123_name().
813 * Change <SNR>123_name() to K_SNR 123_name().
814 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
815 * (slow).
816 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100817 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200818fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
819{
820 int llen;
821 char_u *fname;
822 int i;
823
824 llen = eval_fname_script(name);
825 if (llen > 0)
826 {
827 fname_buf[0] = K_SPECIAL;
828 fname_buf[1] = KS_EXTRA;
829 fname_buf[2] = (int)KE_SNR;
830 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100831 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200832 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200833 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100834 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200835 else
836 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200837 sprintf((char *)fname_buf + 3, "%ld_",
838 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200839 i = (int)STRLEN(fname_buf);
840 }
841 }
842 if (i + STRLEN(name + llen) < FLEN_FIXED)
843 {
844 STRCPY(fname_buf + i, name + llen);
845 fname = fname_buf;
846 }
847 else
848 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200849 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200850 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100851 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200852 else
853 {
854 *tofree = fname;
855 mch_memmove(fname, fname_buf, (size_t)i);
856 STRCPY(fname + i, name + llen);
857 }
858 }
859 }
860 else
861 fname = name;
862 return fname;
863}
864
865/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100866 * Find a function "name" in script "sid".
867 */
868 static ufunc_T *
869find_func_with_sid(char_u *name, int sid)
870{
871 hashitem_T *hi;
872 char_u buffer[200];
873
874 buffer[0] = K_SPECIAL;
875 buffer[1] = KS_EXTRA;
876 buffer[2] = (int)KE_SNR;
877 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
878 (long)sid, name);
879 hi = hash_find(&func_hashtab, buffer);
880 if (!HASHITEM_EMPTY(hi))
881 return HI2UF(hi);
882
883 return NULL;
884}
885
886/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200887 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200888 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200889 * Return NULL for unknown function.
890 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200891 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200892find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200893{
894 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100895 ufunc_T *func;
896 imported_T *imported;
897
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200898 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100899 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200900 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200901 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +0200902 int find_script_local = in_vim9script()
903 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100904
Bram Moolenaar95006e32020-08-29 17:47:08 +0200905 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100906 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200907 // Find script-local function before global one.
908 func = find_func_with_sid(name, current_sctx.sc_sid);
909 if (func != NULL)
910 return func;
911 }
912
Bram Moolenaarefa94442020-08-08 22:16:00 +0200913 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200914 && name[1] == KS_EXTRA
915 && name[2] == KE_SNR)
916 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200917 // Caller changes s: to <SNR>99_name.
918
919 after_script = name + 3;
920 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200921 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200922 ++after_script;
923 else
924 after_script = NULL;
925 }
Bram Moolenaar95006e32020-08-29 17:47:08 +0200926 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200927 {
928 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200929 if (after_script != NULL && sid != current_sctx.sc_sid)
930 imported = find_imported_in_script(after_script, 0, sid);
931 else
932 imported = find_imported(after_script == NULL
933 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200934 if (imported != NULL && imported->imp_funcname != NULL)
935 {
936 hi = hash_find(&func_hashtab, imported->imp_funcname);
937 if (!HASHITEM_EMPTY(hi))
938 return HI2UF(hi);
939 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100940 }
941 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200942
Bram Moolenaara26b9702020-04-18 19:53:28 +0200943 hi = hash_find(&func_hashtab,
944 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200945 if (!HASHITEM_EMPTY(hi))
946 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100947
948 return NULL;
949}
950
951/*
952 * Find a function by name, return pointer to it in ufuncs.
953 * "cctx" is passed in a :def function to find imported functions.
954 * Return NULL for unknown or dead function.
955 */
956 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200957find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100958{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200959 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100960
961 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
962 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200963 return NULL;
964}
965
966/*
Bram Moolenaar0f769812020-09-12 18:32:34 +0200967 * Return TRUE if "ufunc" is a global function.
968 */
969 int
970func_is_global(ufunc_T *ufunc)
971{
972 return ufunc->uf_name[0] != K_SPECIAL;
973}
974
975/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200976 * Copy the function name of "fp" to buffer "buf".
977 * "buf" must be able to hold the function name plus three bytes.
978 * Takes care of script-local function names.
979 */
980 static void
981cat_func_name(char_u *buf, ufunc_T *fp)
982{
Bram Moolenaar0f769812020-09-12 18:32:34 +0200983 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200984 {
985 STRCPY(buf, "<SNR>");
986 STRCAT(buf, fp->uf_name + 3);
987 }
988 else
989 STRCPY(buf, fp->uf_name);
990}
991
992/*
993 * Add a number variable "name" to dict "dp" with value "nr".
994 */
995 static void
996add_nr_var(
997 dict_T *dp,
998 dictitem_T *v,
999 char *name,
1000 varnumber_T nr)
1001{
1002 STRCPY(v->di_key, name);
1003 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1004 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1005 v->di_tv.v_type = VAR_NUMBER;
1006 v->di_tv.v_lock = VAR_FIXED;
1007 v->di_tv.vval.v_number = nr;
1008}
1009
1010/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001011 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001012 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001013 static void
1014free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001015{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001016 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001017
1018 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1019 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001020 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001021
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001022 // When garbage collecting a funccall_T may be freed before the
1023 // function that references it, clear its uf_scoped field.
1024 // The function may have been redefined and point to another
1025 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001026 if (fp != NULL && fp->uf_scoped == fc)
1027 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001028 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001029 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001030
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001031 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001032 vim_free(fc);
1033}
1034
1035/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001036 * Free "fc" and what it contains.
1037 * Can be called only when "fc" is kept beyond the period of it called,
1038 * i.e. after cleanup_function_call(fc).
1039 */
1040 static void
1041free_funccal_contents(funccall_T *fc)
1042{
1043 listitem_T *li;
1044
1045 // Free all l: variables.
1046 vars_clear(&fc->l_vars.dv_hashtab);
1047
1048 // Free all a: variables.
1049 vars_clear(&fc->l_avars.dv_hashtab);
1050
1051 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001052 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001053 clear_tv(&li->li_tv);
1054
1055 free_funccal(fc);
1056}
1057
1058/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001059 * Handle the last part of returning from a function: free the local hashtable.
1060 * Unless it is still in use by a closure.
1061 */
1062 static void
1063cleanup_function_call(funccall_T *fc)
1064{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001065 int may_free_fc = fc->fc_refcount <= 0;
1066 int free_fc = TRUE;
1067
Bram Moolenaar6914c642017-04-01 21:21:30 +02001068 current_funccal = fc->caller;
1069
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001070 // Free all l: variables if not referred.
1071 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1072 vars_clear(&fc->l_vars.dv_hashtab);
1073 else
1074 free_fc = FALSE;
1075
1076 // If the a:000 list and the l: and a: dicts are not referenced and
1077 // there is no closure using it, we can free the funccall_T and what's
1078 // in it.
1079 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1080 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001081 else
1082 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001083 int todo;
1084 hashitem_T *hi;
1085 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001086
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001087 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001088
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001089 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001090 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1091 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1092 {
1093 if (!HASHITEM_EMPTY(hi))
1094 {
1095 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001096 di = HI2DI(hi);
1097 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001098 }
1099 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001100 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001101
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001102 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1103 fc->l_varlist.lv_first = NULL;
1104 else
1105 {
1106 listitem_T *li;
1107
1108 free_fc = FALSE;
1109
1110 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001111 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001112 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001113 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001114
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001115 if (free_fc)
1116 free_funccal(fc);
1117 else
1118 {
1119 static int made_copy = 0;
1120
1121 // "fc" is still in use. This can happen when returning "a:000",
1122 // assigning "l:" to a global variable or defining a closure.
1123 // Link "fc" in the list for garbage collection later.
1124 fc->caller = previous_funccal;
1125 previous_funccal = fc;
1126
1127 if (want_garbage_collect)
1128 // If garbage collector is ready, clear count.
1129 made_copy = 0;
1130 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001131 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001132 // We have made a lot of copies, worth 4 Mbyte. This can happen
1133 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001134 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001135 // too much memory.
1136 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001137 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001138 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001139 }
1140}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001141
1142/*
1143 * There are two kinds of function names:
1144 * 1. ordinary names, function defined with :function or :def
1145 * 2. numbered functions and lambdas
1146 * For the first we only count the name stored in func_hashtab as a reference,
1147 * using function() does not count as a reference, because the function is
1148 * looked up by name.
1149 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001150 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001151func_name_refcount(char_u *name)
1152{
1153 return isdigit(*name) || *name == '<';
1154}
1155
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001156/*
1157 * Unreference "fc": decrement the reference count and free it when it
1158 * becomes zero. "fp" is detached from "fc".
1159 * When "force" is TRUE we are exiting.
1160 */
1161 static void
1162funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1163{
1164 funccall_T **pfc;
1165 int i;
1166
1167 if (fc == NULL)
1168 return;
1169
1170 if (--fc->fc_refcount <= 0 && (force || (
1171 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1172 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1173 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1174 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1175 {
1176 if (fc == *pfc)
1177 {
1178 *pfc = fc->caller;
1179 free_funccal_contents(fc);
1180 return;
1181 }
1182 }
1183 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1184 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1185 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1186}
1187
1188/*
1189 * Remove the function from the function hashtable. If the function was
1190 * deleted while it still has references this was already done.
1191 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1192 */
1193 static int
1194func_remove(ufunc_T *fp)
1195{
1196 hashitem_T *hi;
1197
1198 // Return if it was already virtually deleted.
1199 if (fp->uf_flags & FC_DEAD)
1200 return FALSE;
1201
1202 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1203 if (!HASHITEM_EMPTY(hi))
1204 {
1205 // When there is a def-function index do not actually remove the
1206 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001207 // Do remove it when it's a copy.
1208 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001209 fp->uf_flags |= FC_DEAD;
1210 else
1211 hash_remove(&func_hashtab, hi);
1212 return TRUE;
1213 }
1214 return FALSE;
1215}
1216
1217 static void
1218func_clear_items(ufunc_T *fp)
1219{
1220 ga_clear_strings(&(fp->uf_args));
1221 ga_clear_strings(&(fp->uf_def_args));
1222 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001223 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001224 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001225 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001226 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001227 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001228
1229#ifdef FEAT_LUA
1230 if (fp->uf_cb_free != NULL)
1231 {
1232 fp->uf_cb_free(fp->uf_cb_state);
1233 fp->uf_cb_free = NULL;
1234 }
1235
1236 fp->uf_cb_state = NULL;
1237 fp->uf_cb = NULL;
1238#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001239#ifdef FEAT_PROFILE
1240 VIM_CLEAR(fp->uf_tml_count);
1241 VIM_CLEAR(fp->uf_tml_total);
1242 VIM_CLEAR(fp->uf_tml_self);
1243#endif
1244}
1245
1246/*
1247 * Free all things that a function contains. Does not free the function
1248 * itself, use func_free() for that.
1249 * When "force" is TRUE we are exiting.
1250 */
1251 static void
1252func_clear(ufunc_T *fp, int force)
1253{
1254 if (fp->uf_cleared)
1255 return;
1256 fp->uf_cleared = TRUE;
1257
1258 // clear this function
1259 func_clear_items(fp);
1260 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001261 if ((fp->uf_flags & FC_COPY) == 0)
1262 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001263}
1264
1265/*
1266 * Free a function and remove it from the list of functions. Does not free
1267 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001268 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001269 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001270 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001271 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001272func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001273{
1274 // Only remove it when not done already, otherwise we would remove a newer
1275 // version of the function with the same name.
1276 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1277 func_remove(fp);
1278
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001279 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001280 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001281 if (fp->uf_dfunc_idx > 0)
1282 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001283 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001284 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001285 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001286 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001287 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001288}
1289
1290/*
1291 * Free all things that a function contains and free the function itself.
1292 * When "force" is TRUE we are exiting.
1293 */
1294 static void
1295func_clear_free(ufunc_T *fp, int force)
1296{
1297 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001298 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1299 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001300 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001301 else
1302 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001303}
1304
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001305/*
1306 * Copy already defined function "lambda" to a new function with name "global".
1307 * This is for when a compiled function defines a global function.
1308 */
1309 void
1310copy_func(char_u *lambda, char_u *global)
1311{
1312 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1313 ufunc_T *fp;
1314
1315 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001316 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001317 else
1318 {
1319 // TODO: handle ! to overwrite
1320 fp = find_func(global, TRUE, NULL);
1321 if (fp != NULL)
1322 {
1323 semsg(_(e_funcexts), global);
1324 return;
1325 }
1326
1327 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1328 if (fp == NULL)
1329 return;
1330
1331 fp->uf_varargs = ufunc->uf_varargs;
1332 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1333 fp->uf_def_status = ufunc->uf_def_status;
1334 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001335 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1336 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001337 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001338 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001339 goto failed;
1340
1341 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1342 : vim_strsave(ufunc->uf_name_exp);
1343 if (ufunc->uf_arg_types != NULL)
1344 {
1345 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1346 if (fp->uf_arg_types == NULL)
1347 goto failed;
1348 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1349 sizeof(type_T *) * fp->uf_args.ga_len);
1350 }
1351 if (ufunc->uf_def_arg_idx != NULL)
1352 {
1353 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1354 if (fp->uf_def_arg_idx == NULL)
1355 goto failed;
1356 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1357 sizeof(int) * fp->uf_def_args.ga_len + 1);
1358 }
1359 if (ufunc->uf_va_name != NULL)
1360 {
1361 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1362 if (fp->uf_va_name == NULL)
1363 goto failed;
1364 }
1365
1366 fp->uf_refcount = 1;
1367 STRCPY(fp->uf_name, global);
1368 hash_add(&func_hashtab, UF2HIKEY(fp));
1369 }
1370 return;
1371
1372failed:
1373 func_clear_free(fp, TRUE);
1374}
1375
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001376static int funcdepth = 0;
1377
1378/*
1379 * Increment the function call depth count.
1380 * Return FAIL when going over 'maxfuncdepth'.
1381 * Otherwise return OK, must call funcdepth_decrement() later!
1382 */
1383 int
1384funcdepth_increment(void)
1385{
1386 if (funcdepth >= p_mfd)
1387 {
1388 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1389 return FAIL;
1390 }
1391 ++funcdepth;
1392 return OK;
1393}
1394
1395 void
1396funcdepth_decrement(void)
1397{
1398 --funcdepth;
1399}
1400
1401/*
1402 * Get the current function call depth.
1403 */
1404 int
1405funcdepth_get(void)
1406{
1407 return funcdepth;
1408}
1409
1410/*
1411 * Restore the function call depth. This is for cases where there is no
1412 * garantee funcdepth_decrement() can be called exactly the same number of
1413 * times as funcdepth_increment().
1414 */
1415 void
1416funcdepth_restore(int depth)
1417{
1418 funcdepth = depth;
1419}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001420
1421/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422 * Call a user function.
1423 */
1424 static void
1425call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001426 ufunc_T *fp, // pointer to function
1427 int argcount, // nr of args
1428 typval_T *argvars, // arguments
1429 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001430 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001431 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001433 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001434 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435 funccall_T *fc;
1436 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001437 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001439 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 int i;
1441 int ai;
1442 int islambda = FALSE;
1443 char_u numbuf[NUMBUFLEN];
1444 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001445#ifdef FEAT_PROFILE
1446 proftime_T wait_start;
1447 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001448 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001450 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001452 // If depth of calling is getting too high, don't execute the function.
1453 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 rettv->v_type = VAR_NUMBER;
1456 rettv->vval.v_number = -1;
1457 return;
1458 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001459
Bram Moolenaare38eab22019-12-05 21:50:01 +01001460 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001461
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001462 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001463 if (fc == NULL)
1464 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465 fc->caller = current_funccal;
1466 current_funccal = fc;
1467 fc->func = fp;
1468 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001469 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001470 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001471 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1472 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001473 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001474 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001475 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001477 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001478 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001479 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001480 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001481 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001482 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001483 free_funccal(fc);
1484 return;
1485 }
1486
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1488 islambda = TRUE;
1489
1490 /*
1491 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1492 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1493 * each argument variable and saves a lot of time.
1494 */
1495 /*
1496 * Init l: variables.
1497 */
1498 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1499 if (selfdict != NULL)
1500 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001501 // Set l:self to "selfdict". Use "name" to avoid a warning from
1502 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001503 v = &fc->fixvar[fixvar_idx++].var;
1504 name = v->di_key;
1505 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001506 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1508 v->di_tv.v_type = VAR_DICT;
1509 v->di_tv.v_lock = 0;
1510 v->di_tv.vval.v_dict = selfdict;
1511 ++selfdict->dv_refcount;
1512 }
1513
1514 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001515 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001516 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 * Set a:000 to a list with room for the "..." arguments.
1518 */
1519 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001520 if ((fp->uf_flags & FC_NOARGS) == 0)
1521 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001522 (varnumber_T)(argcount >= fp->uf_args.ga_len
1523 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001524 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001525 if ((fp->uf_flags & FC_NOARGS) == 0)
1526 {
1527 // Use "name" to avoid a warning from some compiler that checks the
1528 // destination size.
1529 v = &fc->fixvar[fixvar_idx++].var;
1530 name = v->di_key;
1531 STRCPY(name, "000");
1532 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1533 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1534 v->di_tv.v_type = VAR_LIST;
1535 v->di_tv.v_lock = VAR_FIXED;
1536 v->di_tv.vval.v_list = &fc->l_varlist;
1537 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001538 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001539 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1540 fc->l_varlist.lv_lock = VAR_FIXED;
1541
1542 /*
1543 * Set a:firstline to "firstline" and a:lastline to "lastline".
1544 * Set a:name to named arguments.
1545 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001546 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001547 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001548 if ((fp->uf_flags & FC_NOARGS) == 0)
1549 {
1550 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001551 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001552 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001553 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001554 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001555 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 {
1557 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001558 typval_T def_rettv;
1559 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560
1561 ai = i - fp->uf_args.ga_len;
1562 if (ai < 0)
1563 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001564 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565 name = FUNCARG(fp, i);
1566 if (islambda)
1567 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001568
1569 // evaluate named argument default expression
1570 isdefault = ai + fp->uf_def_args.ga_len >= 0
1571 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1572 && argvars[i].vval.v_number == VVAL_NONE));
1573 if (isdefault)
1574 {
1575 char_u *default_expr = NULL;
1576 def_rettv.v_type = VAR_NUMBER;
1577 def_rettv.vval.v_number = -1;
1578
1579 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1580 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001581 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001582 {
1583 default_arg_err = 1;
1584 break;
1585 }
1586 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587 }
1588 else
1589 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001590 if ((fp->uf_flags & FC_NOARGS) != 0)
1591 // Bail out if no a: arguments used (in lambda).
1592 break;
1593
Bram Moolenaare38eab22019-12-05 21:50:01 +01001594 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595 sprintf((char *)numbuf, "%d", ai + 1);
1596 name = numbuf;
1597 }
1598 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1599 {
1600 v = &fc->fixvar[fixvar_idx++].var;
1601 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001602 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 }
1604 else
1605 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001606 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607 if (v == NULL)
1608 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001609 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001612 // Note: the values are copied directly to avoid alloc/free.
1613 // "argvars" must have VAR_FIXED for v_lock.
1614 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 v->di_tv.v_lock = VAR_FIXED;
1616
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001617 if (addlocal)
1618 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001619 // Named arguments should be accessed without the "a:" prefix in
1620 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001621 copy_tv(&v->di_tv, &v->di_tv);
1622 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001624 else
1625 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626
1627 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1628 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001629 listitem_T *li = &fc->l_listitems[ai];
1630
1631 li->li_tv = argvars[i];
1632 li->li_tv.v_lock = VAR_FIXED;
1633 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 }
1635 }
1636
Bram Moolenaare38eab22019-12-05 21:50:01 +01001637 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001639
1640 if (fp->uf_flags & FC_SANDBOX)
1641 {
1642 using_sandbox = TRUE;
1643 ++sandbox;
1644 }
1645
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001646 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001647 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001648 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001650 ++no_wait_return;
1651 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001653 smsg(_("calling %s"), SOURCING_NAME);
1654 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001655 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001656 char_u buf[MSG_BUF_LEN];
1657 char_u numbuf2[NUMBUFLEN];
1658 char_u *tofree;
1659 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001661 msg_puts("(");
1662 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001663 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001664 if (i > 0)
1665 msg_puts(", ");
1666 if (argvars[i].v_type == VAR_NUMBER)
1667 msg_outnum((long)argvars[i].vval.v_number);
1668 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001669 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001670 // Do not want errors such as E724 here.
1671 ++emsg_off;
1672 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1673 --emsg_off;
1674 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001676 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001677 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001678 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1679 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001681 msg_puts((char *)s);
1682 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 }
1684 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001686 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001688 msg_puts("\n"); // don't overwrite this either
1689
1690 verbose_leave_scroll();
1691 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692 }
1693#ifdef FEAT_PROFILE
1694 if (do_profiling == PROF_YES)
1695 {
1696 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001697 {
1698 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001699 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001700 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 if (fp->uf_profiling
1702 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1703 {
1704 ++fp->uf_tm_count;
1705 profile_start(&call_start);
1706 profile_zero(&fp->uf_tm_children);
1707 }
1708 script_prof_save(&wait_start);
1709 }
1710#endif
1711
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001712 save_current_sctx = current_sctx;
1713 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 save_did_emsg = did_emsg;
1715 did_emsg = FALSE;
1716
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001717 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1718 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001719 else if (islambda)
1720 {
1721 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1722
1723 // A Lambda always has the command "return {expr}". It is much faster
1724 // to evaluate {expr} directly.
1725 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001726 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001727 --ex_nesting_level;
1728 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001729 else
1730 // call do_cmdline() to execute the lines
1731 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1733
1734 --RedrawingDisabled;
1735
Bram Moolenaare38eab22019-12-05 21:50:01 +01001736 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001737 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1738 {
1739 clear_tv(rettv);
1740 rettv->v_type = VAR_NUMBER;
1741 rettv->vval.v_number = -1;
1742 }
1743
1744#ifdef FEAT_PROFILE
1745 if (do_profiling == PROF_YES && (fp->uf_profiling
1746 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1747 {
1748 profile_end(&call_start);
1749 profile_sub_wait(&wait_start, &call_start);
1750 profile_add(&fp->uf_tm_total, &call_start);
1751 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1752 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1753 {
1754 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1755 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1756 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001757 if (started_profiling)
1758 // make a ":profdel func" stop profiling the function
1759 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001760 }
1761#endif
1762
Bram Moolenaare38eab22019-12-05 21:50:01 +01001763 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 if (p_verbose >= 12)
1765 {
1766 ++no_wait_return;
1767 verbose_enter_scroll();
1768
1769 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001770 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001772 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 (long)fc->rettv->vval.v_number);
1774 else
1775 {
1776 char_u buf[MSG_BUF_LEN];
1777 char_u numbuf2[NUMBUFLEN];
1778 char_u *tofree;
1779 char_u *s;
1780
Bram Moolenaare38eab22019-12-05 21:50:01 +01001781 // The value may be very long. Skip the middle part, so that we
1782 // have some idea how it starts and ends. smsg() would always
1783 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784 ++emsg_off;
1785 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1786 --emsg_off;
1787 if (s != NULL)
1788 {
1789 if (vim_strsize(s) > MSG_BUF_CLEN)
1790 {
1791 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1792 s = buf;
1793 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001794 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795 vim_free(tofree);
1796 }
1797 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001798 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799
1800 verbose_leave_scroll();
1801 --no_wait_return;
1802 }
1803
Bram Moolenaare31ee862020-01-07 20:59:34 +01001804 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001805 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001806 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807#ifdef FEAT_PROFILE
1808 if (do_profiling == PROF_YES)
1809 script_prof_restore(&wait_start);
1810#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001811 if (using_sandbox)
1812 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001814 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001815 {
1816 ++no_wait_return;
1817 verbose_enter_scroll();
1818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001819 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001820 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821
1822 verbose_leave_scroll();
1823 --no_wait_return;
1824 }
1825
1826 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001827 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001828 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001829}
1830
1831/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001832 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001833 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001834 int
1835call_user_func_check(
1836 ufunc_T *fp,
1837 int argcount,
1838 typval_T *argvars,
1839 typval_T *rettv,
1840 funcexe_T *funcexe,
1841 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001842{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001843 int error;
1844 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001845
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001846 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1847 *funcexe->doesrange = TRUE;
1848 if (argcount < regular_args - fp->uf_def_args.ga_len)
1849 error = FCERR_TOOFEW;
1850 else if (!has_varargs(fp) && argcount > regular_args)
1851 error = FCERR_TOOMANY;
1852 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1853 error = FCERR_DICT;
1854 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001855 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001856 int did_save_redo = FALSE;
1857 save_redo_T save_redo;
1858
1859 /*
1860 * Call the user function.
1861 * Save and restore search patterns, script variables and
1862 * redo buffer.
1863 */
1864 save_search_patterns();
1865 if (!ins_compl_active())
1866 {
1867 saveRedobuff(&save_redo);
1868 did_save_redo = TRUE;
1869 }
1870 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001871 call_user_func(fp, argcount, argvars, rettv, funcexe,
1872 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001873 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1874 // Function was unreferenced while being used, free it now.
1875 func_clear_free(fp, FALSE);
1876 if (did_save_redo)
1877 restoreRedobuff(&save_redo);
1878 restore_search_patterns();
1879 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001880 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001882}
1883
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001884static funccal_entry_T *funccal_stack = NULL;
1885
1886/*
1887 * Save the current function call pointer, and set it to NULL.
1888 * Used when executing autocommands and for ":source".
1889 */
1890 void
1891save_funccal(funccal_entry_T *entry)
1892{
1893 entry->top_funccal = current_funccal;
1894 entry->next = funccal_stack;
1895 funccal_stack = entry;
1896 current_funccal = NULL;
1897}
1898
1899 void
1900restore_funccal(void)
1901{
1902 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001903 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001904 else
1905 {
1906 current_funccal = funccal_stack->top_funccal;
1907 funccal_stack = funccal_stack->next;
1908 }
1909}
1910
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001911 funccall_T *
1912get_current_funccal(void)
1913{
1914 return current_funccal;
1915}
1916
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001917/*
1918 * Mark all functions of script "sid" as deleted.
1919 */
1920 void
1921delete_script_functions(int sid)
1922{
1923 hashitem_T *hi;
1924 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001925 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001926 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001927 size_t len;
1928
1929 buf[0] = K_SPECIAL;
1930 buf[1] = KS_EXTRA;
1931 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001932 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001933 len = STRLEN(buf);
1934
Bram Moolenaarce658352020-07-31 23:47:12 +02001935 while (todo > 0)
1936 {
1937 todo = func_hashtab.ht_used;
1938 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1939 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001940 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001941 fp = HI2UF(hi);
1942 if (STRNCMP(fp->uf_name, buf, len) == 0)
1943 {
1944 int changed = func_hashtab.ht_changed;
1945
1946 fp->uf_flags |= FC_DEAD;
1947 func_clear(fp, TRUE);
1948 // When clearing a function another function can be cleared
1949 // as a side effect. When that happens start over.
1950 if (changed != func_hashtab.ht_changed)
1951 break;
1952 }
1953 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001954 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001955 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001956}
1957
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958#if defined(EXITFREE) || defined(PROTO)
1959 void
1960free_all_functions(void)
1961{
1962 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001963 ufunc_T *fp;
1964 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001965 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001966 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967
Bram Moolenaare38eab22019-12-05 21:50:01 +01001968 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001969 while (current_funccal != NULL)
1970 {
1971 clear_tv(current_funccal->rettv);
1972 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001973 if (current_funccal == NULL && funccal_stack != NULL)
1974 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001975 }
1976
Bram Moolenaare38eab22019-12-05 21:50:01 +01001977 // First clear what the functions contain. Since this may lower the
1978 // reference count of a function, it may also free a function and change
1979 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001980 while (todo > 0)
1981 {
1982 todo = func_hashtab.ht_used;
1983 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1984 if (!HASHITEM_EMPTY(hi))
1985 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001986 // clear the def function index now
1987 fp = HI2UF(hi);
1988 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001989 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001990
Bram Moolenaare38eab22019-12-05 21:50:01 +01001991 // Only free functions that are not refcounted, those are
1992 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001993 if (func_name_refcount(fp->uf_name))
1994 ++skipped;
1995 else
1996 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001997 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001998 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001999 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002000 {
2001 skipped = 0;
2002 break;
2003 }
2004 }
2005 --todo;
2006 }
2007 }
2008
Bram Moolenaare38eab22019-12-05 21:50:01 +01002009 // Now actually free the functions. Need to start all over every time,
2010 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002011 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002012 while (func_hashtab.ht_used > skipped)
2013 {
2014 todo = func_hashtab.ht_used;
2015 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 if (!HASHITEM_EMPTY(hi))
2017 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002018 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002019 // Only free functions that are not refcounted, those are
2020 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002021 fp = HI2UF(hi);
2022 if (func_name_refcount(fp->uf_name))
2023 ++skipped;
2024 else
2025 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002026 if (func_free(fp, FALSE) == OK)
2027 {
2028 skipped = 0;
2029 break;
2030 }
2031 // did not actually free it
2032 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002033 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002034 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002035 }
2036 if (skipped == 0)
2037 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002038
2039 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002040}
2041#endif
2042
2043/*
2044 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002045 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002046 * "len" is the length of "name", or -1 for NUL terminated.
2047 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002048 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002049builtin_function(char_u *name, int len)
2050{
2051 char_u *p;
2052
Bram Moolenaara26b9702020-04-18 19:53:28 +02002053 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002054 return FALSE;
2055 p = vim_strchr(name, AUTOLOAD_CHAR);
2056 return p == NULL || (len > 0 && p > name + len);
2057}
2058
2059 int
2060func_call(
2061 char_u *name,
2062 typval_T *args,
2063 partial_T *partial,
2064 dict_T *selfdict,
2065 typval_T *rettv)
2066{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002067 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002068 listitem_T *item;
2069 typval_T argv[MAX_FUNC_ARGS + 1];
2070 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002071 int r = 0;
2072
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002073 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002074 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002075 {
2076 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2077 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002078 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002079 break;
2080 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002081 // Make a copy of each argument. This is needed to be able to set
2082 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002083 copy_tv(&item->li_tv, &argv[argc++]);
2084 }
2085
2086 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002087 {
2088 funcexe_T funcexe;
2089
Bram Moolenaara80faa82020-04-12 19:37:17 +02002090 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002091 funcexe.firstline = curwin->w_cursor.lnum;
2092 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002093 funcexe.evaluate = TRUE;
2094 funcexe.partial = partial;
2095 funcexe.selfdict = selfdict;
2096 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2097 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002098
Bram Moolenaare38eab22019-12-05 21:50:01 +01002099 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002100 while (argc > 0)
2101 clear_tv(&argv[--argc]);
2102
2103 return r;
2104}
2105
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002106static int callback_depth = 0;
2107
2108 int
2109get_callback_depth(void)
2110{
2111 return callback_depth;
2112}
2113
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002114/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002115 * Invoke call_func() with a callback.
2116 */
2117 int
2118call_callback(
2119 callback_T *callback,
2120 int len, // length of "name" or -1 to use strlen()
2121 typval_T *rettv, // return value goes here
2122 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002123 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002124 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002125{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002126 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002127 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002128
Bram Moolenaara80faa82020-04-12 19:37:17 +02002129 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002130 funcexe.evaluate = TRUE;
2131 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002132 ++callback_depth;
2133 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2134 --callback_depth;
2135 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002136}
2137
2138/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002139 * Give an error message for the result of a function.
2140 * Nothing if "error" is FCERR_NONE.
2141 */
2142 void
2143user_func_error(int error, char_u *name)
2144{
2145 switch (error)
2146 {
2147 case FCERR_UNKNOWN:
2148 emsg_funcname(e_unknownfunc, name);
2149 break;
2150 case FCERR_NOTMETHOD:
2151 emsg_funcname(
2152 N_("E276: Cannot use function as a method: %s"), name);
2153 break;
2154 case FCERR_DELETED:
2155 emsg_funcname(N_(e_func_deleted), name);
2156 break;
2157 case FCERR_TOOMANY:
2158 emsg_funcname((char *)e_toomanyarg, name);
2159 break;
2160 case FCERR_TOOFEW:
2161 emsg_funcname((char *)e_toofewarg, name);
2162 break;
2163 case FCERR_SCRIPT:
2164 emsg_funcname(
2165 N_("E120: Using <SID> not in a script context: %s"), name);
2166 break;
2167 case FCERR_DICT:
2168 emsg_funcname(
2169 N_("E725: Calling dict function without Dictionary: %s"),
2170 name);
2171 break;
2172 }
2173}
2174
2175/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002177 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002178 * Return FAIL when the function can't be called, OK otherwise.
2179 * Also returns OK when an error was encountered while executing the function.
2180 */
2181 int
2182call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002183 char_u *funcname, // name of the function
2184 int len, // length of "name" or -1 to use strlen()
2185 typval_T *rettv, // return value goes here
2186 int argcount_in, // number of "argvars"
2187 typval_T *argvars_in, // vars for arguments, must have "argcount"
2188 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002189 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002190{
2191 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002192 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002193 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002194 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195 char_u fname_buf[FLEN_FIXED + 1];
2196 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002197 char_u *fname = NULL;
2198 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002199 int argcount = argcount_in;
2200 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002201 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002202 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2203 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002205 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002206 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002207
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002208 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2209 // even when call_func() returns FAIL.
2210 rettv->v_type = VAR_UNKNOWN;
2211
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002212 if (partial != NULL)
2213 fp = partial->pt_func;
2214 if (fp == NULL)
2215 {
2216 // Make a copy of the name, if it comes from a funcref variable it
2217 // could be changed or deleted in the called function.
2218 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2219 if (name == NULL)
2220 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002221
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002222 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002224
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002225 if (funcexe->doesrange != NULL)
2226 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002227
2228 if (partial != NULL)
2229 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002230 // When the function has a partial with a dict and there is a dict
2231 // argument, use the dict argument. That is backwards compatible.
2232 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002233 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002234 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002235 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002236 {
2237 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002238 {
2239 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2240 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002241 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002242 goto theend;
2243 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002244 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002245 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002246 for (i = 0; i < argcount_in; ++i)
2247 argv[i + argv_clear] = argvars_in[i];
2248 argvars = argv;
2249 argcount = partial->pt_argc + argcount_in;
2250 }
2251 }
2252
Bram Moolenaaref140542019-12-31 21:27:13 +01002253 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002254 {
2255 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002256 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002257
Bram Moolenaar333894b2020-08-01 18:53:07 +02002258 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002259 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002260 {
2261 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002262 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002263 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002264
Bram Moolenaare38eab22019-12-05 21:50:01 +01002265 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002266 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002267 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002269 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002270 {
2271 /*
2272 * User defined function.
2273 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002274 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002275 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002276
Bram Moolenaare38eab22019-12-05 21:50:01 +01002277 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002278 if (fp == NULL
2279 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002280 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002281 && !aborting())
2282 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002283 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002284 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002286 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002287 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2288 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002289 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002290 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002291 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002292 if (fp == NULL)
2293 {
2294 char_u *p = untrans_function_name(rfname);
2295
2296 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002297 // Don't do this if the name starts with "s:".
2298 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002299 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002300 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002302 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002303 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002304#ifdef FEAT_LUA
2305 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2306 {
2307 cfunc_T cb = fp->uf_cb;
2308
2309 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2310 }
2311#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002312 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002313 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002314 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002315 // postponed filling in the arguments, do it now
2316 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002317 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002318
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002319 if (funcexe->basetv != NULL)
2320 {
2321 // Method call: base->Method()
2322 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2323 argv[0] = *funcexe->basetv;
2324 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002325 argvars = argv;
2326 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002327 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002328
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002329 error = call_user_func_check(fp, argcount, argvars, rettv,
2330 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331 }
2332 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002333 else if (funcexe->basetv != NULL)
2334 {
2335 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002336 * expr->method(): Find the method name in the table, call its
2337 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002338 */
2339 error = call_internal_method(fname, argcount, argvars, rettv,
2340 funcexe->basetv);
2341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002342 else
2343 {
2344 /*
2345 * Find the function name in the table, call its implementation.
2346 */
2347 error = call_internal_func(fname, argcount, argvars, rettv);
2348 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002349
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350 /*
2351 * The function call (or "FuncUndefined" autocommand sequence) might
2352 * have been aborted by an error, an interrupt, or an explicitly thrown
2353 * exception that has not been caught so far. This situation can be
2354 * tested for by calling aborting(). For an error in an internal
2355 * function or for the "E132" error in call_user_func(), however, the
2356 * throw point at which the "force_abort" flag (temporarily reset by
2357 * emsg()) is normally updated has not been reached yet. We need to
2358 * update that flag first to make aborting() reliable.
2359 */
2360 update_force_abort();
2361 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002362 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 ret = OK;
2364
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002365theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366 /*
2367 * Report an error unless the argument evaluation or function call has been
2368 * cancelled due to an aborting error, an interrupt, or an exception.
2369 */
2370 if (!aborting())
2371 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002372 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 }
2374
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002375 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002377 clear_tv(&argv[--argv_clear + argv_base]);
2378
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 vim_free(tofree);
2380 vim_free(name);
2381
2382 return ret;
2383}
2384
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002385 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002386printable_func_name(ufunc_T *fp)
2387{
2388 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2389}
2390
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002391/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002392 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 */
2394 static void
2395list_func_head(ufunc_T *fp, int indent)
2396{
2397 int j;
2398
2399 msg_start();
2400 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002401 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002402 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002403 msg_puts("def ");
2404 else
2405 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002406 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 msg_putchar('(');
2408 for (j = 0; j < fp->uf_args.ga_len; ++j)
2409 {
2410 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002411 msg_puts(", ");
2412 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002413 if (fp->uf_arg_types != NULL)
2414 {
2415 char *tofree;
2416
2417 msg_puts(": ");
2418 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2419 vim_free(tofree);
2420 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002421 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2422 {
2423 msg_puts(" = ");
2424 msg_puts(((char **)(fp->uf_def_args.ga_data))
2425 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2426 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002427 }
2428 if (fp->uf_varargs)
2429 {
2430 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002431 msg_puts(", ");
2432 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002434 if (fp->uf_va_name != NULL)
2435 {
2436 if (j)
2437 msg_puts(", ");
2438 msg_puts("...");
2439 msg_puts((char *)fp->uf_va_name);
2440 if (fp->uf_va_type)
2441 {
2442 char *tofree;
2443
2444 msg_puts(": ");
2445 msg_puts(type_name(fp->uf_va_type, &tofree));
2446 vim_free(tofree);
2447 }
2448 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002450
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002451 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002452 {
2453 if (fp->uf_ret_type != &t_void)
2454 {
2455 char *tofree;
2456
2457 msg_puts(": ");
2458 msg_puts(type_name(fp->uf_ret_type, &tofree));
2459 vim_free(tofree);
2460 }
2461 }
2462 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002463 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002465 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002467 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002468 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002469 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 msg_clr_eos();
2471 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002472 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473}
2474
2475/*
2476 * Get a function name, translating "<SID>" and "<SNR>".
2477 * Also handles a Funcref in a List or Dictionary.
2478 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002479 * Set "*is_global" to TRUE when the function must be global, unless
2480 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 * flags:
2482 * TFN_INT: internal function name OK
2483 * TFN_QUIET: be quiet
2484 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002485 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486 * Advances "pp" to just after the function name (if no error).
2487 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002488 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489trans_function_name(
2490 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002491 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002492 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002494 funcdict_T *fdp, // return: info about dictionary used
2495 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496{
2497 char_u *name = NULL;
2498 char_u *start;
2499 char_u *end;
2500 int lead;
2501 char_u sid_buf[20];
2502 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002503 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002505 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002506 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507
2508 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002509 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 start = *pp;
2511
Bram Moolenaare38eab22019-12-05 21:50:01 +01002512 // Check for hard coded <SNR>: already translated function ID (from a user
2513 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2515 && (*pp)[2] == (int)KE_SNR)
2516 {
2517 *pp += 3;
2518 len = get_id_len(pp) + 3;
2519 return vim_strnsave(start, len);
2520 }
2521
Bram Moolenaare38eab22019-12-05 21:50:01 +01002522 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2523 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 lead = eval_fname_script(start);
2525 if (lead > 2)
2526 start += lead;
2527
Bram Moolenaare38eab22019-12-05 21:50:01 +01002528 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002529 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 lead > 2 ? 0 : FNE_CHECK_START);
2531 if (end == start)
2532 {
2533 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002534 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 goto theend;
2536 }
2537 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2538 {
2539 /*
2540 * Report an invalid expression in braces, unless the expression
2541 * evaluation has been cancelled due to an aborting error, an
2542 * interrupt, or an exception.
2543 */
2544 if (!aborting())
2545 {
2546 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002547 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548 }
2549 else
2550 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2551 goto theend;
2552 }
2553
2554 if (lv.ll_tv != NULL)
2555 {
2556 if (fdp != NULL)
2557 {
2558 fdp->fd_dict = lv.ll_dict;
2559 fdp->fd_newkey = lv.ll_newkey;
2560 lv.ll_newkey = NULL;
2561 fdp->fd_di = lv.ll_di;
2562 }
2563 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2564 {
2565 name = vim_strsave(lv.ll_tv->vval.v_string);
2566 *pp = end;
2567 }
2568 else if (lv.ll_tv->v_type == VAR_PARTIAL
2569 && lv.ll_tv->vval.v_partial != NULL)
2570 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002571 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572 *pp = end;
2573 if (partial != NULL)
2574 *partial = lv.ll_tv->vval.v_partial;
2575 }
2576 else
2577 {
2578 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2579 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002580 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581 else
2582 *pp = end;
2583 name = NULL;
2584 }
2585 goto theend;
2586 }
2587
2588 if (lv.ll_name == NULL)
2589 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002590 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002591 *pp = end;
2592 goto theend;
2593 }
2594
Bram Moolenaare38eab22019-12-05 21:50:01 +01002595 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002596 if (lv.ll_exp_name != NULL)
2597 {
2598 len = (int)STRLEN(lv.ll_exp_name);
2599 name = deref_func_name(lv.ll_exp_name, &len, partial,
2600 flags & TFN_NO_AUTOLOAD);
2601 if (name == lv.ll_exp_name)
2602 name = NULL;
2603 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002604 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002605 {
2606 len = (int)(end - *pp);
2607 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2608 if (name == *pp)
2609 name = NULL;
2610 }
2611 if (name != NULL)
2612 {
2613 name = vim_strsave(name);
2614 *pp = end;
2615 if (STRNCMP(name, "<SNR>", 5) == 0)
2616 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002617 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 name[0] = K_SPECIAL;
2619 name[1] = KS_EXTRA;
2620 name[2] = (int)KE_SNR;
2621 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2622 }
2623 goto theend;
2624 }
2625
2626 if (lv.ll_exp_name != NULL)
2627 {
2628 len = (int)STRLEN(lv.ll_exp_name);
2629 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2630 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2631 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002632 // When there was "s:" already or the name expanded to get a
2633 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 lv.ll_name += 2;
2635 len -= 2;
2636 lead = 2;
2637 }
2638 }
2639 else
2640 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002641 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002643 {
2644 if (is_global != NULL && lv.ll_name[0] == 'g')
2645 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002647 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648 len = (int)(end - lv.ll_name);
2649 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002650 if (len <= 0)
2651 {
2652 if (!skip)
2653 emsg(_(e_function_name));
2654 goto theend;
2655 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002657 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002658 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002659
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660 /*
2661 * Copy the function name to allocated memory.
2662 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2663 * Accept <SNR>123_name() outside a script.
2664 */
2665 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002666 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002667 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002669 if (!vim9script)
2670 lead = 3;
2671 if (vim9script || (lv.ll_exp_name != NULL
2672 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 || eval_fname_sid(*pp))
2674 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002675 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002676 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002678 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 goto theend;
2680 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002681 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002682 if (vim9script)
2683 extra = 3 + (int)STRLEN(sid_buf);
2684 else
2685 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 }
2687 }
2688 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2689 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002690 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 start);
2692 goto theend;
2693 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002694 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 {
2696 char_u *cp = vim_strchr(lv.ll_name, ':');
2697
2698 if (cp != NULL && cp < end)
2699 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002700 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 goto theend;
2702 }
2703 }
2704
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002705 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 if (name != NULL)
2707 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002708 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 {
2710 name[0] = K_SPECIAL;
2711 name[1] = KS_EXTRA;
2712 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002713 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 STRCPY(name + 3, sid_buf);
2715 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002716 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2717 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 }
2719 *pp = end;
2720
2721theend:
2722 clear_lval(&lv);
2723 return name;
2724}
2725
2726/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002727 * Assuming "name" is the result of trans_function_name() and it was prefixed
2728 * to use the script-local name, return the unmodified name (points into
2729 * "name"). Otherwise return NULL.
2730 * This can be used to first search for a script-local function and fall back
2731 * to the global function if not found.
2732 */
2733 char_u *
2734untrans_function_name(char_u *name)
2735{
2736 char_u *p;
2737
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002738 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002739 {
2740 p = vim_strchr(name, '_');
2741 if (p != NULL)
2742 return p + 1;
2743 }
2744 return NULL;
2745}
2746
2747/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002748 * List functions. When "regmatch" is NULL all of then.
2749 * Otherwise functions matching "regmatch".
2750 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002751 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002752list_functions(regmatch_T *regmatch)
2753{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002754 int changed = func_hashtab.ht_changed;
2755 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002756 hashitem_T *hi;
2757
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002758 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002759 {
2760 if (!HASHITEM_EMPTY(hi))
2761 {
2762 ufunc_T *fp = HI2UF(hi);
2763
2764 --todo;
2765 if ((fp->uf_flags & FC_DEAD) == 0
2766 && (regmatch == NULL
2767 ? !message_filtered(fp->uf_name)
2768 && !func_name_refcount(fp->uf_name)
2769 : !isdigit(*fp->uf_name)
2770 && vim_regexec(regmatch, fp->uf_name, 0)))
2771 {
2772 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002773 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002774 {
2775 emsg(_("E454: function list was modified"));
2776 return;
2777 }
2778 }
2779 }
2780 }
2781}
2782
2783/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002784 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002785 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2786 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002787 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002789 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002790define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791{
2792 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002793 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 int j;
2795 int c;
2796 int saved_did_emsg;
2797 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002798 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002799 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 char_u *p;
2801 char_u *arg;
2802 char_u *line_arg = NULL;
2803 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002804 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002805 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 garray_T newlines;
2807 int varargs = FALSE;
2808 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002809 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002810 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002811 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 int indent;
2813 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002814#define MAX_FUNC_NESTING 50
2815 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 dictitem_T *v;
2817 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002818 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002821 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002822 linenr_T sourcing_lnum_off;
2823 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002824 int is_heredoc = FALSE;
2825 char_u *skip_until = NULL;
2826 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002827 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002828 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829
2830 /*
2831 * ":function" without argument: list functions.
2832 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002833 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 {
2835 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002836 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002838 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 }
2840
2841 /*
2842 * ":function /pat": list functions matching pattern.
2843 */
2844 if (*eap->arg == '/')
2845 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002846 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847 if (!eap->skip)
2848 {
2849 regmatch_T regmatch;
2850
2851 c = *p;
2852 *p = NUL;
2853 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2854 *p = c;
2855 if (regmatch.regprog != NULL)
2856 {
2857 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002858 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 vim_regfree(regmatch.regprog);
2860 }
2861 }
2862 if (*p == '/')
2863 ++p;
2864 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002865 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 }
2867
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002868 ga_init(&newargs);
2869 ga_init(&argtypes);
2870 ga_init(&default_args);
2871
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872 /*
2873 * Get the function name. There are these situations:
2874 * func normal function name
2875 * "name" == func, "fudi.fd_dict" == NULL
2876 * dict.func new dictionary entry
2877 * "name" == NULL, "fudi.fd_dict" set,
2878 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2879 * dict.func existing dict entry with a Funcref
2880 * "name" == func, "fudi.fd_dict" set,
2881 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2882 * dict.func existing dict entry that's not a Funcref
2883 * "name" == NULL, "fudi.fd_dict" set,
2884 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2885 * s:func script-local function name
2886 * g:func global function name, same as "func"
2887 */
2888 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002889 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002891 // nested function, argument is (args).
2892 paren = TRUE;
2893 CLEAR_FIELD(fudi);
2894 }
2895 else
2896 {
2897 name = trans_function_name(&p, &is_global, eap->skip,
2898 TFN_NO_AUTOLOAD, &fudi, NULL);
2899 paren = (vim_strchr(p, '(') != NULL);
2900 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002902 /*
2903 * Return on an invalid expression in braces, unless the expression
2904 * evaluation has been cancelled due to an aborting error, an
2905 * interrupt, or an exception.
2906 */
2907 if (!aborting())
2908 {
2909 if (!eap->skip && fudi.fd_newkey != NULL)
2910 semsg(_(e_dictkey), fudi.fd_newkey);
2911 vim_free(fudi.fd_newkey);
2912 return NULL;
2913 }
2914 else
2915 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 }
2918
Bram Moolenaare38eab22019-12-05 21:50:01 +01002919 // An error in a function call during evaluation of an expression in magic
2920 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921 saved_did_emsg = did_emsg;
2922 did_emsg = FALSE;
2923
2924 /*
2925 * ":function func" with only function name: list function.
2926 */
2927 if (!paren)
2928 {
2929 if (!ends_excmd(*skipwhite(p)))
2930 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002931 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 goto ret_free;
2933 }
2934 eap->nextcmd = check_nextcmd(p);
2935 if (eap->nextcmd != NULL)
2936 *p = NUL;
2937 if (!eap->skip && !got_int)
2938 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002939 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002940 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2941 {
2942 char_u *up = untrans_function_name(name);
2943
2944 // With Vim9 script the name was made script-local, if not
2945 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002946 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002947 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002948 }
2949
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950 if (fp != NULL)
2951 {
2952 list_func_head(fp, TRUE);
2953 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2954 {
2955 if (FUNCLINE(fp, j) == NULL)
2956 continue;
2957 msg_putchar('\n');
2958 msg_outnum((long)(j + 1));
2959 if (j < 9)
2960 msg_putchar(' ');
2961 if (j < 99)
2962 msg_putchar(' ');
2963 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002964 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 ui_breakcheck();
2966 }
2967 if (!got_int)
2968 {
2969 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002970 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002971 msg_puts(" enddef");
2972 else
2973 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002974 }
2975 }
2976 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002977 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 }
2979 goto ret_free;
2980 }
2981
2982 /*
2983 * ":function name(arg1, arg2)" Define function.
2984 */
2985 p = skipwhite(p);
2986 if (*p != '(')
2987 {
2988 if (!eap->skip)
2989 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002990 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 goto ret_free;
2992 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002993 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994 if (vim_strchr(p, '(') != NULL)
2995 p = vim_strchr(p, '(');
2996 }
2997 p = skipwhite(p + 1);
2998
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002999 // In Vim9 script only global functions can be redefined.
3000 if (vim9script && eap->forceit && !is_global)
3001 {
3002 emsg(_(e_nobang));
3003 goto ret_free;
3004 }
3005
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3007
Bram Moolenaar04b12692020-05-04 23:24:44 +02003008 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003010 // Check the name of the function. Unless it's a dictionary function
3011 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 if (name != NULL)
3013 arg = name;
3014 else
3015 arg = fudi.fd_newkey;
3016 if (arg != NULL && (fudi.fd_di == NULL
3017 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3018 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3019 {
3020 if (*arg == K_SPECIAL)
3021 j = 3;
3022 else
3023 j = 0;
3024 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3025 : eval_isnamec(arg[j])))
3026 ++j;
3027 if (arg[j] != NUL)
3028 emsg_funcname((char *)e_invarg2, arg);
3029 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003030 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003032 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 }
3034
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003035 // This may get more lines and make the pointers into the first line
3036 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003037 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003038 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003039 &varargs, &default_args, eap->skip,
3040 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 goto errret_2;
3042
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003043 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003045 // find the return type: :def Func(): type
3046 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003048 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003049 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003050 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003051 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003052 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003053 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003054 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003055 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003056 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003057 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003058 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003059 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003061 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003063 else
3064 // find extra arguments "range", "dict", "abort" and "closure"
3065 for (;;)
3066 {
3067 p = skipwhite(p);
3068 if (STRNCMP(p, "range", 5) == 0)
3069 {
3070 flags |= FC_RANGE;
3071 p += 5;
3072 }
3073 else if (STRNCMP(p, "dict", 4) == 0)
3074 {
3075 flags |= FC_DICT;
3076 p += 4;
3077 }
3078 else if (STRNCMP(p, "abort", 5) == 0)
3079 {
3080 flags |= FC_ABORT;
3081 p += 5;
3082 }
3083 else if (STRNCMP(p, "closure", 7) == 0)
3084 {
3085 flags |= FC_CLOSURE;
3086 p += 7;
3087 if (current_funccal == NULL)
3088 {
3089 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3090 name == NULL ? (char_u *)"" : name);
3091 goto erret;
3092 }
3093 }
3094 else
3095 break;
3096 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097
Bram Moolenaare38eab22019-12-05 21:50:01 +01003098 // When there is a line break use what follows for the function body.
3099 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003100 if (*p == '\n')
3101 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003102 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003103 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3104 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003105 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3106 && !eap->skip
3107 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003108 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109
3110 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003111 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3112 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 */
3114 if (KeyTyped)
3115 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003116 // Check if the function already exists, don't let the user type the
3117 // whole function before telling him it doesn't work! For a script we
3118 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 if (!eap->skip && !eap->forceit)
3120 {
3121 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003122 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003123 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124 emsg_funcname(e_funcexts, name);
3125 }
3126
3127 if (!eap->skip && did_emsg)
3128 goto erret;
3129
Bram Moolenaare38eab22019-12-05 21:50:01 +01003130 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 cmdline_row = msg_row;
3132 }
3133
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003134 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003135 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003136
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003137 // Detect having skipped over comment lines to find the return
3138 // type. Add NULL lines to keep the line count correct.
3139 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3140 if (SOURCING_LNUM < sourcing_lnum_off)
3141 {
3142 sourcing_lnum_off -= SOURCING_LNUM;
3143 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3144 goto erret;
3145 while (sourcing_lnum_off-- > 0)
3146 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3147 }
3148
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003149 indent = 2;
3150 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003151 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 for (;;)
3153 {
3154 if (KeyTyped)
3155 {
3156 msg_scroll = TRUE;
3157 saved_wait_return = FALSE;
3158 }
3159 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160
3161 if (line_arg != NULL)
3162 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003163 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 theline = line_arg;
3165 p = vim_strchr(theline, '\n');
3166 if (p == NULL)
3167 line_arg += STRLEN(line_arg);
3168 else
3169 {
3170 *p = NUL;
3171 line_arg = p + 1;
3172 }
3173 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003175 {
3176 vim_free(line_to_free);
3177 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003178 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003179 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003180 theline = eap->getline(':', eap->cookie, indent,
3181 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003182 line_to_free = theline;
3183 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 if (KeyTyped)
3185 lines_left = Rows - 1;
3186 if (theline == NULL)
3187 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003188 if (skip_until != NULL)
3189 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3190 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003191 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003192 else
3193 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 goto erret;
3195 }
3196
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003197 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003198 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003199 if (SOURCING_LNUM < sourcing_lnum_off)
3200 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 else
3202 sourcing_lnum_off = 0;
3203
3204 if (skip_until != NULL)
3205 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003207 // * ":append" and "."
3208 // * ":python <<EOF" and "EOF"
3209 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3210 if (heredoc_trimmed == NULL
3211 || (is_heredoc && skipwhite(theline) == theline)
3212 || STRNCMP(theline, heredoc_trimmed,
3213 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003214 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003215 if (heredoc_trimmed == NULL)
3216 p = theline;
3217 else if (is_heredoc)
3218 p = skipwhite(theline) == theline
3219 ? theline : theline + STRLEN(heredoc_trimmed);
3220 else
3221 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003222 if (STRCMP(p, skip_until) == 0)
3223 {
3224 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003225 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003226 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003227 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003228 }
3229 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 }
3231 else
3232 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003233 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003234 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 ;
3236
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003237 // Check for "endfunction" or "enddef".
3238 if (checkforcmd(&p, nesting_def[nesting]
3239 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003240 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003241 char_u *nextcmd = NULL;
3242
Bram Moolenaar663bb232017-06-22 19:12:10 +02003243 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003244 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003245 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003246 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003247 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 give_warning2(eap->cmdidx == CMD_def
3249 ? (char_u *)_("W1001: Text found after :enddef: %s")
3250 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003251 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003252 if (nextcmd != NULL)
3253 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003254 // Another command follows. If the line came from "eap" we
3255 // can simply point into it, otherwise we need to change
3256 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003257 eap->nextcmd = nextcmd;
3258 if (line_to_free != NULL)
3259 {
3260 vim_free(*eap->cmdlinep);
3261 *eap->cmdlinep = line_to_free;
3262 line_to_free = NULL;
3263 }
3264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 break;
3266 }
3267
Bram Moolenaare38eab22019-12-05 21:50:01 +01003268 // Increase indent inside "if", "while", "for" and "try", decrease
3269 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271 indent -= 2;
3272 else if (STRNCMP(p, "if", 2) == 0
3273 || STRNCMP(p, "wh", 2) == 0
3274 || STRNCMP(p, "for", 3) == 0
3275 || STRNCMP(p, "try", 3) == 0)
3276 indent += 2;
3277
Bram Moolenaare38eab22019-12-05 21:50:01 +01003278 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003279 // Only recognize "def" inside "def", not inside "function",
3280 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003281 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003282 if (checkforcmd(&p, "function", 2)
3283 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 {
3285 if (*p == '!')
3286 p = skipwhite(p + 1);
3287 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003288 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289 if (*skipwhite(p) == '(')
3290 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003291 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003292 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293 else
3294 {
3295 ++nesting;
3296 nesting_def[nesting] = (c == 'd');
3297 indent += 2;
3298 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 }
3300 }
3301
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003302 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003303 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003304 if (eap->cmdidx != CMD_def
3305 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003306 || (p[0] == 'c'
3307 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3308 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3309 && (STRNCMP(&p[3], "nge", 3) != 0
3310 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 || (p[0] == 'i'
3312 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003313 && (!ASCII_ISALPHA(p[2])
3314 || (p[2] == 's'
3315 && (!ASCII_ISALPHA(p[3])
3316 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317 skip_until = vim_strsave((char_u *)".");
3318
Bram Moolenaare38eab22019-12-05 21:50:01 +01003319 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 arg = skipwhite(skiptowhite(p));
3321 if (arg[0] == '<' && arg[1] =='<'
3322 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003323 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3324 || ((p[2] == '3' || p[2] == 'x')
3325 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003326 || (p[0] == 'p' && p[1] == 'e'
3327 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3328 || (p[0] == 't' && p[1] == 'c'
3329 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3330 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3331 && !ASCII_ISALPHA(p[3]))
3332 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3333 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3334 || (p[0] == 'm' && p[1] == 'z'
3335 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3336 ))
3337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003340 if (STRNCMP(p, "trim", 4) == 0)
3341 {
3342 // Ignore leading white space.
3343 p = skipwhite(p + 4);
3344 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003345 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 if (*p == NUL)
3348 skip_until = vim_strsave((char_u *)".");
3349 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003350 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003351 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003352 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003354
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003355 // Check for ":cmd v =<< [trim] EOF"
3356 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003357 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003358 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003359 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003360 if (*arg == '[')
3361 arg = vim_strchr(arg, ']');
3362 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003363 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003364 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3365 && arg[1] == '<' && arg[2] =='<');
3366
3367 if (!found)
3368 // skip over the argument after "cmd"
3369 arg = skipwhite(skiptowhite(arg));
3370 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003371 && (checkforcmd(&p, "let", 2)
3372 || checkforcmd(&p, "var", 3)
3373 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003374 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003375 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003376 p = skipwhite(arg + 3);
3377 if (STRNCMP(p, "trim", 4) == 0)
3378 {
3379 // Ignore leading white space.
3380 p = skipwhite(p + 4);
3381 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003382 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003383 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003384 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003385 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003386 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003387 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003388 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 }
3390
Bram Moolenaare38eab22019-12-05 21:50:01 +01003391 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394
Bram Moolenaare38eab22019-12-05 21:50:01 +01003395 // Copy the line to newly allocated memory. get_one_sourceline()
3396 // allocates 250 bytes per line, this saves 80% on average. The cost
3397 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003399 if (p == NULL)
3400 goto erret;
3401 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402
Bram Moolenaare38eab22019-12-05 21:50:01 +01003403 // Add NULL lines for continuation lines, so that the line count is
3404 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405 while (sourcing_lnum_off-- > 0)
3406 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3407
Bram Moolenaare38eab22019-12-05 21:50:01 +01003408 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 if (line_arg != NULL && *line_arg == NUL)
3410 line_arg = NULL;
3411 }
3412
Bram Moolenaare38eab22019-12-05 21:50:01 +01003413 // Don't define the function when skipping commands or when an error was
3414 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003415 if (eap->skip || did_emsg)
3416 goto erret;
3417
3418 /*
3419 * If there are no errors, add the function
3420 */
3421 if (fudi.fd_dict == NULL)
3422 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003423 hashtab_T *ht;
3424
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 v = find_var(name, &ht, FALSE);
3426 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3427 {
3428 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3429 name);
3430 goto erret;
3431 }
3432
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003433 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003434 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003436 char_u *uname = untrans_function_name(name);
3437
3438 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3439 }
3440
3441 if (fp != NULL || import != NULL)
3442 {
3443 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003444
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003445 // Function can be replaced with "function!" and when sourcing the
3446 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003447 // A name that is used by an import can not be overruled.
3448 if (import != NULL
3449 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003450 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003451 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003453 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003454 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003455 else
3456 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 goto erret;
3458 }
3459 if (fp->uf_calls > 0)
3460 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003461 emsg_funcname(
3462 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 name);
3464 goto erret;
3465 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003466 if (fp->uf_refcount > 1)
3467 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003468 // This function is referenced somewhere, don't redefine it but
3469 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003470 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003471 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003472 fp = NULL;
3473 overwrite = TRUE;
3474 }
3475 else
3476 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003477 char_u *exp_name = fp->uf_name_exp;
3478
3479 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003480 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003481 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003482 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003483 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003484 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003485#ifdef FEAT_PROFILE
3486 fp->uf_profiling = FALSE;
3487 fp->uf_prof_initialized = FALSE;
3488#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003489 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003490 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003491 }
3492 }
3493 else
3494 {
3495 char numbuf[20];
3496
3497 fp = NULL;
3498 if (fudi.fd_newkey == NULL && !eap->forceit)
3499 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003500 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 goto erret;
3502 }
3503 if (fudi.fd_di == NULL)
3504 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003505 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003506 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 goto erret;
3508 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003509 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003510 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 goto erret;
3512
Bram Moolenaare38eab22019-12-05 21:50:01 +01003513 // Give the function a sequential number. Can only be used with a
3514 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 vim_free(name);
3516 sprintf(numbuf, "%d", ++func_nr);
3517 name = vim_strsave((char_u *)numbuf);
3518 if (name == NULL)
3519 goto erret;
3520 }
3521
3522 if (fp == NULL)
3523 {
3524 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3525 {
3526 int slen, plen;
3527 char_u *scriptname;
3528
Bram Moolenaare38eab22019-12-05 21:50:01 +01003529 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003531 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 {
3533 scriptname = autoload_name(name);
3534 if (scriptname != NULL)
3535 {
3536 p = vim_strchr(scriptname, '/');
3537 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003538 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003540 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 j = OK;
3542 vim_free(scriptname);
3543 }
3544 }
3545 if (j == FAIL)
3546 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003547 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003548 goto erret;
3549 }
3550 }
3551
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003552 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 if (fp == NULL)
3554 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003555 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003556 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557
3558 if (fudi.fd_dict != NULL)
3559 {
3560 if (fudi.fd_di == NULL)
3561 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003562 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3564 if (fudi.fd_di == NULL)
3565 {
3566 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003567 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 goto erret;
3569 }
3570 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3571 {
3572 vim_free(fudi.fd_di);
3573 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003574 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 goto erret;
3576 }
3577 }
3578 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003579 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580 clear_tv(&fudi.fd_di->di_tv);
3581 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003582 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583
Bram Moolenaare38eab22019-12-05 21:50:01 +01003584 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 flags |= FC_DICT;
3586 }
3587
Bram Moolenaare38eab22019-12-05 21:50:01 +01003588 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003589 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003590 if (overwrite)
3591 {
3592 hi = hash_find(&func_hashtab, name);
3593 hi->hi_key = UF2HIKEY(fp);
3594 }
3595 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 {
3597 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003598 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 goto erret;
3600 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003601 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 }
3603 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003604 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003605 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003606 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003607
3608 if (eap->cmdidx == CMD_def)
3609 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003610 int lnum_save = SOURCING_LNUM;
3611 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003612
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003613 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003614
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003615 // error messages are for the first function line
3616 SOURCING_LNUM = sourcing_lnum_top;
3617
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003618 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003619 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003620 int count = cstack->cs_idx + 1;
3621 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003622
3623 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003624 // a block that is visible now but not when the function is called
3625 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003626 fp->uf_block_ids = ALLOC_MULT(int, count);
3627 if (fp->uf_block_ids != NULL)
3628 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003629 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003630 sizeof(int) * count);
3631 fp->uf_block_depth = count;
3632 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003633
3634 // Set flag in each block to indicate a function was defined. This
3635 // is used to keep the variable when leaving the block, see
3636 // hide_script_var().
3637 for (i = 0; i <= cstack->cs_idx; ++i)
3638 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003639 }
3640
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003641 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003642 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003643 SOURCING_LNUM = lnum_save;
3644 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003645 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003646 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003647
3648 // parse the return type, if any
3649 if (ret_type == NULL)
3650 fp->uf_ret_type = &t_void;
3651 else
3652 {
3653 p = ret_type;
3654 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3655 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003656 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003657 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003658 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003659 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003660
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003662 if ((flags & FC_CLOSURE) != 0)
3663 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003664 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003665 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003666 }
3667 else
3668 fp->uf_scoped = NULL;
3669
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 if (prof_def_func())
3672 func_do_profile(fp);
3673#endif
3674 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003675 if (sandbox)
3676 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003677 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003678 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 fp->uf_flags = flags;
3680 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003681 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003682 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003683 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003684 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003685 if (is_export)
3686 {
3687 fp->uf_flags |= FC_EXPORT;
3688 // let ex_export() know the export worked.
3689 is_export = FALSE;
3690 }
3691
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003692 if (eap->cmdidx == CMD_def)
3693 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003694 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3695 // :func does not use Vim9 script syntax, even in a Vim9 script file
3696 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003697
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 goto ret_free;
3699
3700erret:
3701 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003702 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703errret_2:
3704 ga_clear_strings(&newlines);
3705ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003706 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003708 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003710 if (name != name_arg)
3711 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003712 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 did_emsg |= saved_did_emsg;
3714 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003715
3716 return fp;
3717}
3718
3719/*
3720 * ":function"
3721 */
3722 void
3723ex_function(exarg_T *eap)
3724{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003725 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003726}
3727
3728/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003729 * :defcompile - compile all :def functions in the current script that need to
3730 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003731 */
3732 void
3733ex_defcompile(exarg_T *eap UNUSED)
3734{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003735 long todo = (long)func_hashtab.ht_used;
3736 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003737 hashitem_T *hi;
3738 ufunc_T *ufunc;
3739
3740 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3741 {
3742 if (!HASHITEM_EMPTY(hi))
3743 {
3744 --todo;
3745 ufunc = HI2UF(hi);
3746 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003747 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3748 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003749 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003750 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003751
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003752 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003753 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003754 // a function has been added or removed, need to start over
3755 todo = (long)func_hashtab.ht_used;
3756 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003757 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003758 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003759 }
3760 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003761 }
3762 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763}
3764
3765/*
3766 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3767 * Return 2 if "p" starts with "s:".
3768 * Return 0 otherwise.
3769 */
3770 int
3771eval_fname_script(char_u *p)
3772{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003773 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3774 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3776 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3777 return 5;
3778 if (p[0] == 's' && p[1] == ':')
3779 return 2;
3780 return 0;
3781}
3782
3783 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003784translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785{
3786 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003787 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003788 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003789}
3790
3791/*
3792 * Return TRUE when "ufunc" has old-style "..." varargs
3793 * or named varargs "...name: type".
3794 */
3795 int
3796has_varargs(ufunc_T *ufunc)
3797{
3798 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799}
3800
3801/*
3802 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003803 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 */
3805 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003806function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807{
3808 char_u *nm = name;
3809 char_u *p;
3810 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003811 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003812 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003814 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3815 if (no_deref)
3816 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003817 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 nm = skipwhite(nm);
3819
Bram Moolenaare38eab22019-12-05 21:50:01 +01003820 // Only accept "funcname", "funcname ", "funcname (..." and
3821 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003823 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 vim_free(p);
3825 return n;
3826}
3827
Bram Moolenaar113e1072019-01-20 15:30:40 +01003828#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 char_u *
3830get_expanded_name(char_u *name, int check)
3831{
3832 char_u *nm = name;
3833 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003834 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003836 p = trans_function_name(&nm, &is_global, FALSE,
3837 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003839 if (p != NULL && *nm == NUL
3840 && (!check || translated_function_exists(p, is_global)))
3841 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842
3843 vim_free(p);
3844 return NULL;
3845}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003846#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848/*
3849 * Function given to ExpandGeneric() to obtain the list of user defined
3850 * function names.
3851 */
3852 char_u *
3853get_user_func_name(expand_T *xp, int idx)
3854{
3855 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003856 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 static hashitem_T *hi;
3858 ufunc_T *fp;
3859
3860 if (idx == 0)
3861 {
3862 done = 0;
3863 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003864 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003866 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 {
3868 if (done++ > 0)
3869 ++hi;
3870 while (HASHITEM_EMPTY(hi))
3871 ++hi;
3872 fp = HI2UF(hi);
3873
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003874 // don't show dead, dict and lambda functions
3875 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003876 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003877 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878
3879 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003880 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881
3882 cat_func_name(IObuff, fp);
3883 if (xp->xp_context != EXPAND_USER_FUNC)
3884 {
3885 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003886 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 STRCAT(IObuff, ")");
3888 }
3889 return IObuff;
3890 }
3891 return NULL;
3892}
3893
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894/*
3895 * ":delfunction {name}"
3896 */
3897 void
3898ex_delfunction(exarg_T *eap)
3899{
3900 ufunc_T *fp = NULL;
3901 char_u *p;
3902 char_u *name;
3903 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003904 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905
3906 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003907 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908 vim_free(fudi.fd_newkey);
3909 if (name == NULL)
3910 {
3911 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003912 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913 return;
3914 }
3915 if (!ends_excmd(*skipwhite(p)))
3916 {
3917 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003918 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 return;
3920 }
3921 eap->nextcmd = check_nextcmd(p);
3922 if (eap->nextcmd != NULL)
3923 *p = NUL;
3924
3925 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003926 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 vim_free(name);
3928
3929 if (!eap->skip)
3930 {
3931 if (fp == NULL)
3932 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003933 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003934 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 return;
3936 }
3937 if (fp->uf_calls > 0)
3938 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003939 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940 return;
3941 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003942 if (fp->uf_flags & FC_VIM9)
3943 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003944 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003945 return;
3946 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947
3948 if (fudi.fd_dict != NULL)
3949 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003950 // Delete the dict item that refers to the function, it will
3951 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3953 }
3954 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003955 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003956 // A normal function (not a numbered function or lambda) has a
3957 // refcount of 1 for the entry in the hashtable. When deleting
3958 // it and the refcount is more than one, it should be kept.
3959 // A numbered function and lambda should be kept if the refcount is
3960 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003961 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003962 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003963 // Function is still referenced somewhere. Don't free it but
3964 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003965 if (func_remove(fp))
3966 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003967 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003968 }
3969 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003970 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003971 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003972 }
3973}
3974
3975/*
3976 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003977 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 */
3979 void
3980func_unref(char_u *name)
3981{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003982 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003984 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003986 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003987 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003990 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003992 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003994 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003996 // Only delete it when it's not being used. Otherwise it's done
3997 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003998 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003999 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004000 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004001}
4002
4003/*
4004 * Unreference a Function: decrement the reference count and free it when it
4005 * becomes zero.
4006 */
4007 void
4008func_ptr_unref(ufunc_T *fp)
4009{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004010 if (fp != NULL && --fp->uf_refcount <= 0)
4011 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004012 // Only delete it when it's not being used. Otherwise it's done
4013 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004014 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004015 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004016 }
4017}
4018
4019/*
4020 * Count a reference to a Function.
4021 */
4022 void
4023func_ref(char_u *name)
4024{
4025 ufunc_T *fp;
4026
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004027 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004029 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004030 if (fp != NULL)
4031 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004033 // Only give an error for a numbered function.
4034 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004035 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004036}
4037
4038/*
4039 * Count a reference to a Function.
4040 */
4041 void
4042func_ptr_ref(ufunc_T *fp)
4043{
4044 if (fp != NULL)
4045 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046}
4047
4048/*
4049 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4050 * referenced from anywhere that is in use.
4051 */
4052 static int
4053can_free_funccal(funccall_T *fc, int copyID)
4054{
4055 return (fc->l_varlist.lv_copyID != copyID
4056 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004057 && fc->l_avars.dv_copyID != copyID
4058 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059}
4060
4061/*
4062 * ":return [expr]"
4063 */
4064 void
4065ex_return(exarg_T *eap)
4066{
4067 char_u *arg = eap->arg;
4068 typval_T rettv;
4069 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004070 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071
4072 if (current_funccal == NULL)
4073 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004074 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 return;
4076 }
4077
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004078 CLEAR_FIELD(evalarg);
4079 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4080
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 if (eap->skip)
4082 ++emsg_skip;
4083
4084 eap->nextcmd = NULL;
4085 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004086 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087 {
4088 if (!eap->skip)
4089 returning = do_return(eap, FALSE, TRUE, &rettv);
4090 else
4091 clear_tv(&rettv);
4092 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004093 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094 else if (!eap->skip)
4095 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004096 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004097 update_force_abort();
4098
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099 /*
4100 * Return unless the expression evaluation has been cancelled due to an
4101 * aborting error, an interrupt, or an exception.
4102 */
4103 if (!aborting())
4104 returning = do_return(eap, FALSE, TRUE, NULL);
4105 }
4106
Bram Moolenaare38eab22019-12-05 21:50:01 +01004107 // When skipping or the return gets pending, advance to the next command
4108 // in this line (!returning). Otherwise, ignore the rest of the line.
4109 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 if (returning)
4111 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004112 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 eap->nextcmd = check_nextcmd(arg);
4114
4115 if (eap->skip)
4116 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004117 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118}
4119
4120/*
4121 * ":1,25call func(arg1, arg2)" function call.
4122 */
4123 void
4124ex_call(exarg_T *eap)
4125{
4126 char_u *arg = eap->arg;
4127 char_u *startarg;
4128 char_u *name;
4129 char_u *tofree;
4130 int len;
4131 typval_T rettv;
4132 linenr_T lnum;
4133 int doesrange;
4134 int failed = FALSE;
4135 funcdict_T fudi;
4136 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004137 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138
Bram Moolenaare6b53242020-07-01 17:28:33 +02004139 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 if (eap->skip)
4141 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004142 // trans_function_name() doesn't work well when skipping, use eval0()
4143 // instead to skip to any following command, e.g. for:
4144 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004146 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 clear_tv(&rettv);
4148 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004149 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 return;
4151 }
4152
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004153 tofree = trans_function_name(&arg, NULL, eap->skip,
4154 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004155 if (fudi.fd_newkey != NULL)
4156 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004157 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004158 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 vim_free(fudi.fd_newkey);
4160 }
4161 if (tofree == NULL)
4162 return;
4163
Bram Moolenaare38eab22019-12-05 21:50:01 +01004164 // Increase refcount on dictionary, it could get deleted when evaluating
4165 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166 if (fudi.fd_dict != NULL)
4167 ++fudi.fd_dict->dv_refcount;
4168
Bram Moolenaare38eab22019-12-05 21:50:01 +01004169 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4170 // contents. For VAR_PARTIAL get its partial, unless we already have one
4171 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 len = (int)STRLEN(tofree);
4173 name = deref_func_name(tofree, &len,
4174 partial != NULL ? NULL : &partial, FALSE);
4175
Bram Moolenaare38eab22019-12-05 21:50:01 +01004176 // Skip white space to allow ":call func ()". Not good, but required for
4177 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004179 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180
4181 if (*startarg != '(')
4182 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004183 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184 goto end;
4185 }
4186
4187 /*
4188 * When skipping, evaluate the function once, to find the end of the
4189 * arguments.
4190 * When the function takes a range, this is discovered after the first
4191 * call, and the loop is broken.
4192 */
4193 if (eap->skip)
4194 {
4195 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004196 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 }
4198 else
4199 lnum = eap->line1;
4200 for ( ; lnum <= eap->line2; ++lnum)
4201 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004202 funcexe_T funcexe;
4203
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 if (!eap->skip && eap->addr_count > 0)
4205 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004206 if (lnum > curbuf->b_ml.ml_line_count)
4207 {
4208 // If the function deleted lines or switched to another buffer
4209 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004210 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004211 break;
4212 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004213 curwin->w_cursor.lnum = lnum;
4214 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004216 }
4217 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004218
Bram Moolenaara80faa82020-04-12 19:37:17 +02004219 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004220 funcexe.firstline = eap->line1;
4221 funcexe.lastline = eap->line2;
4222 funcexe.doesrange = &doesrange;
4223 funcexe.evaluate = !eap->skip;
4224 funcexe.partial = partial;
4225 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004226 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 {
4228 failed = TRUE;
4229 break;
4230 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004231 if (has_watchexpr())
4232 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004233
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004234 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004235 if (handle_subscript(&arg, &rettv,
4236 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 {
4238 failed = TRUE;
4239 break;
4240 }
4241
4242 clear_tv(&rettv);
4243 if (doesrange || eap->skip)
4244 break;
4245
Bram Moolenaare38eab22019-12-05 21:50:01 +01004246 // Stop when immediately aborting on error, or when an interrupt
4247 // occurred or an exception was thrown but not caught.
4248 // get_func_tv() returned OK, so that the check for trailing
4249 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 if (aborting())
4251 break;
4252 }
4253 if (eap->skip)
4254 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004255 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256
Bram Moolenaare51bb172020-02-16 19:42:23 +01004257 // When inside :try we need to check for following "| catch".
4258 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004261 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004262 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004264 if (!failed)
4265 {
4266 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004267 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004268 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004269 }
4270 else
4271 eap->nextcmd = check_nextcmd(arg);
4272 }
4273
4274end:
4275 dict_unref(fudi.fd_dict);
4276 vim_free(tofree);
4277}
4278
4279/*
4280 * Return from a function. Possibly makes the return pending. Also called
4281 * for a pending return at the ":endtry" or after returning from an extra
4282 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4283 * when called due to a ":return" command. "rettv" may point to a typval_T
4284 * with the return rettv. Returns TRUE when the return can be carried out,
4285 * FALSE when the return gets pending.
4286 */
4287 int
4288do_return(
4289 exarg_T *eap,
4290 int reanimate,
4291 int is_cmd,
4292 void *rettv)
4293{
4294 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004295 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296
4297 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004298 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 current_funccal->returned = FALSE;
4300
4301 /*
4302 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4303 * not in its finally clause (which then is to be executed next) is found.
4304 * In this case, make the ":return" pending for execution at the ":endtry".
4305 * Otherwise, return normally.
4306 */
4307 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4308 if (idx >= 0)
4309 {
4310 cstack->cs_pending[idx] = CSTP_RETURN;
4311
4312 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004313 // A pending return again gets pending. "rettv" points to an
4314 // allocated variable with the rettv of the original ":return"'s
4315 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 cstack->cs_rettv[idx] = rettv;
4317 else
4318 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004319 // When undoing a return in order to make it pending, get the stored
4320 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 if (reanimate)
4322 rettv = current_funccal->rettv;
4323
4324 if (rettv != NULL)
4325 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004326 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4328 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4329 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004330 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331 }
4332 else
4333 cstack->cs_rettv[idx] = NULL;
4334
4335 if (reanimate)
4336 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004337 // The pending return value could be overwritten by a ":return"
4338 // without argument in a finally clause; reset the default
4339 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 current_funccal->rettv->v_type = VAR_NUMBER;
4341 current_funccal->rettv->vval.v_number = 0;
4342 }
4343 }
4344 report_make_pending(CSTP_RETURN, rettv);
4345 }
4346 else
4347 {
4348 current_funccal->returned = TRUE;
4349
Bram Moolenaare38eab22019-12-05 21:50:01 +01004350 // If the return is carried out now, store the return value. For
4351 // a return immediately after reanimation, the value is already
4352 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353 if (!reanimate && rettv != NULL)
4354 {
4355 clear_tv(current_funccal->rettv);
4356 *current_funccal->rettv = *(typval_T *)rettv;
4357 if (!is_cmd)
4358 vim_free(rettv);
4359 }
4360 }
4361
4362 return idx < 0;
4363}
4364
4365/*
4366 * Free the variable with a pending return value.
4367 */
4368 void
4369discard_pending_return(void *rettv)
4370{
4371 free_tv((typval_T *)rettv);
4372}
4373
4374/*
4375 * Generate a return command for producing the value of "rettv". The result
4376 * is an allocated string. Used by report_pending() for verbose messages.
4377 */
4378 char_u *
4379get_return_cmd(void *rettv)
4380{
4381 char_u *s = NULL;
4382 char_u *tofree = NULL;
4383 char_u numbuf[NUMBUFLEN];
4384
4385 if (rettv != NULL)
4386 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4387 if (s == NULL)
4388 s = (char_u *)"";
4389
4390 STRCPY(IObuff, ":return ");
4391 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4392 if (STRLEN(s) + 8 >= IOSIZE)
4393 STRCPY(IObuff + IOSIZE - 4, "...");
4394 vim_free(tofree);
4395 return vim_strsave(IObuff);
4396}
4397
4398/*
4399 * Get next function line.
4400 * Called by do_cmdline() to get the next line.
4401 * Returns allocated string, or NULL for end of function.
4402 */
4403 char_u *
4404get_func_line(
4405 int c UNUSED,
4406 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004407 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004408 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004409{
4410 funccall_T *fcp = (funccall_T *)cookie;
4411 ufunc_T *fp = fcp->func;
4412 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004413 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414
Bram Moolenaare38eab22019-12-05 21:50:01 +01004415 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 if (fcp->dbg_tick != debug_tick)
4417 {
4418 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004419 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 fcp->dbg_tick = debug_tick;
4421 }
4422#ifdef FEAT_PROFILE
4423 if (do_profiling == PROF_YES)
4424 func_line_end(cookie);
4425#endif
4426
4427 gap = &fp->uf_lines;
4428 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4429 || fcp->returned)
4430 retval = NULL;
4431 else
4432 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004433 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 while (fcp->linenr < gap->ga_len
4435 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4436 ++fcp->linenr;
4437 if (fcp->linenr >= gap->ga_len)
4438 retval = NULL;
4439 else
4440 {
4441 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004442 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443#ifdef FEAT_PROFILE
4444 if (do_profiling == PROF_YES)
4445 func_line_start(cookie);
4446#endif
4447 }
4448 }
4449
Bram Moolenaare38eab22019-12-05 21:50:01 +01004450 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004451 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004453 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004454 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004456 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 fcp->dbg_tick = debug_tick;
4458 }
4459
4460 return retval;
4461}
4462
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004463/*
4464 * Return TRUE if the currently active function should be ended, because a
4465 * return was encountered or an error occurred. Used inside a ":while".
4466 */
4467 int
4468func_has_ended(void *cookie)
4469{
4470 funccall_T *fcp = (funccall_T *)cookie;
4471
Bram Moolenaare38eab22019-12-05 21:50:01 +01004472 // Ignore the "abort" flag if the abortion behavior has been changed due to
4473 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4475 || fcp->returned);
4476}
4477
4478/*
4479 * return TRUE if cookie indicates a function which "abort"s on errors.
4480 */
4481 int
4482func_has_abort(
4483 void *cookie)
4484{
4485 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4486}
4487
4488
4489/*
4490 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4491 * Don't do this when "Func" is already a partial that was bound
4492 * explicitly (pt_auto is FALSE).
4493 * Changes "rettv" in-place.
4494 * Returns the updated "selfdict_in".
4495 */
4496 dict_T *
4497make_partial(dict_T *selfdict_in, typval_T *rettv)
4498{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004499 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 char_u *tofree = NULL;
4501 ufunc_T *fp;
4502 char_u fname_buf[FLEN_FIXED + 1];
4503 int error;
4504 dict_T *selfdict = selfdict_in;
4505
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004506 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4507 fp = rettv->vval.v_partial->pt_func;
4508 else
4509 {
4510 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4511 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004512 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004513 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004514 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004515 vim_free(tofree);
4516 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517
4518 if (fp != NULL && (fp->uf_flags & FC_DICT))
4519 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004520 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521
4522 if (pt != NULL)
4523 {
4524 pt->pt_refcount = 1;
4525 pt->pt_dict = selfdict;
4526 pt->pt_auto = TRUE;
4527 selfdict = NULL;
4528 if (rettv->v_type == VAR_FUNC)
4529 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004530 // Just a function: Take over the function name and use
4531 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532 pt->pt_name = rettv->vval.v_string;
4533 }
4534 else
4535 {
4536 partial_T *ret_pt = rettv->vval.v_partial;
4537 int i;
4538
Bram Moolenaare38eab22019-12-05 21:50:01 +01004539 // Partial: copy the function name, use selfdict and copy
4540 // args. Can't take over name or args, the partial might
4541 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004542 if (ret_pt->pt_name != NULL)
4543 {
4544 pt->pt_name = vim_strsave(ret_pt->pt_name);
4545 func_ref(pt->pt_name);
4546 }
4547 else
4548 {
4549 pt->pt_func = ret_pt->pt_func;
4550 func_ptr_ref(pt->pt_func);
4551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 if (ret_pt->pt_argc > 0)
4553 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004554 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004556 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 pt->pt_argc = 0;
4558 else
4559 {
4560 pt->pt_argc = ret_pt->pt_argc;
4561 for (i = 0; i < pt->pt_argc; i++)
4562 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4563 }
4564 }
4565 partial_unref(ret_pt);
4566 }
4567 rettv->v_type = VAR_PARTIAL;
4568 rettv->vval.v_partial = pt;
4569 }
4570 }
4571 return selfdict;
4572}
4573
4574/*
4575 * Return the name of the executed function.
4576 */
4577 char_u *
4578func_name(void *cookie)
4579{
4580 return ((funccall_T *)cookie)->func->uf_name;
4581}
4582
4583/*
4584 * Return the address holding the next breakpoint line for a funccall cookie.
4585 */
4586 linenr_T *
4587func_breakpoint(void *cookie)
4588{
4589 return &((funccall_T *)cookie)->breakpoint;
4590}
4591
4592/*
4593 * Return the address holding the debug tick for a funccall cookie.
4594 */
4595 int *
4596func_dbg_tick(void *cookie)
4597{
4598 return &((funccall_T *)cookie)->dbg_tick;
4599}
4600
4601/*
4602 * Return the nesting level for a funccall cookie.
4603 */
4604 int
4605func_level(void *cookie)
4606{
4607 return ((funccall_T *)cookie)->level;
4608}
4609
4610/*
4611 * Return TRUE when a function was ended by a ":return" command.
4612 */
4613 int
4614current_func_returned(void)
4615{
4616 return current_funccal->returned;
4617}
4618
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 int
4620free_unref_funccal(int copyID, int testing)
4621{
4622 int did_free = FALSE;
4623 int did_free_funccal = FALSE;
4624 funccall_T *fc, **pfc;
4625
4626 for (pfc = &previous_funccal; *pfc != NULL; )
4627 {
4628 if (can_free_funccal(*pfc, copyID))
4629 {
4630 fc = *pfc;
4631 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004632 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 did_free = TRUE;
4634 did_free_funccal = TRUE;
4635 }
4636 else
4637 pfc = &(*pfc)->caller;
4638 }
4639 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004640 // When a funccal was freed some more items might be garbage
4641 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 (void)garbage_collect(testing);
4643
4644 return did_free;
4645}
4646
4647/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004648 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649 */
4650 static funccall_T *
4651get_funccal(void)
4652{
4653 int i;
4654 funccall_T *funccal;
4655 funccall_T *temp_funccal;
4656
4657 funccal = current_funccal;
4658 if (debug_backtrace_level > 0)
4659 {
4660 for (i = 0; i < debug_backtrace_level; i++)
4661 {
4662 temp_funccal = funccal->caller;
4663 if (temp_funccal)
4664 funccal = temp_funccal;
4665 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004666 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 debug_backtrace_level = i;
4668 }
4669 }
4670 return funccal;
4671}
4672
4673/*
4674 * Return the hashtable used for local variables in the current funccal.
4675 * Return NULL if there is no current funccal.
4676 */
4677 hashtab_T *
4678get_funccal_local_ht()
4679{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004680 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 return NULL;
4682 return &get_funccal()->l_vars.dv_hashtab;
4683}
4684
4685/*
4686 * Return the l: scope variable.
4687 * Return NULL if there is no current funccal.
4688 */
4689 dictitem_T *
4690get_funccal_local_var()
4691{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004692 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 return NULL;
4694 return &get_funccal()->l_vars_var;
4695}
4696
4697/*
4698 * Return the hashtable used for argument in the current funccal.
4699 * Return NULL if there is no current funccal.
4700 */
4701 hashtab_T *
4702get_funccal_args_ht()
4703{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004704 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705 return NULL;
4706 return &get_funccal()->l_avars.dv_hashtab;
4707}
4708
4709/*
4710 * Return the a: scope variable.
4711 * Return NULL if there is no current funccal.
4712 */
4713 dictitem_T *
4714get_funccal_args_var()
4715{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004716 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004718 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719}
4720
4721/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722 * List function variables, if there is a function.
4723 */
4724 void
4725list_func_vars(int *first)
4726{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004727 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004729 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730}
4731
4732/*
4733 * If "ht" is the hashtable for local variables in the current funccal, return
4734 * the dict that contains it.
4735 * Otherwise return NULL.
4736 */
4737 dict_T *
4738get_current_funccal_dict(hashtab_T *ht)
4739{
4740 if (current_funccal != NULL
4741 && ht == &current_funccal->l_vars.dv_hashtab)
4742 return &current_funccal->l_vars;
4743 return NULL;
4744}
4745
4746/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004747 * Search hashitem in parent scope.
4748 */
4749 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004750find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004751{
4752 funccall_T *old_current_funccal = current_funccal;
4753 hashtab_T *ht;
4754 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004755 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004756
4757 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4758 return NULL;
4759
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004760 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004761 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004762 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004763 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004764 ht = find_var_ht(name, &varname);
4765 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004766 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004767 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004768 if (!HASHITEM_EMPTY(hi))
4769 {
4770 *pht = ht;
4771 break;
4772 }
4773 }
4774 if (current_funccal == current_funccal->func->uf_scoped)
4775 break;
4776 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004777 }
4778 current_funccal = old_current_funccal;
4779
4780 return hi;
4781}
4782
4783/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004784 * Search variable in parent scope.
4785 */
4786 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004787find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004788{
4789 dictitem_T *v = NULL;
4790 funccall_T *old_current_funccal = current_funccal;
4791 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004792 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004793
4794 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4795 return NULL;
4796
Bram Moolenaare38eab22019-12-05 21:50:01 +01004797 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004798 current_funccal = current_funccal->func->uf_scoped;
4799 while (current_funccal)
4800 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004801 ht = find_var_ht(name, &varname);
4802 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004803 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004804 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004805 if (v != NULL)
4806 break;
4807 }
4808 if (current_funccal == current_funccal->func->uf_scoped)
4809 break;
4810 current_funccal = current_funccal->func->uf_scoped;
4811 }
4812 current_funccal = old_current_funccal;
4813
4814 return v;
4815}
4816
4817/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818 * Set "copyID + 1" in previous_funccal and callers.
4819 */
4820 int
4821set_ref_in_previous_funccal(int copyID)
4822{
4823 int abort = FALSE;
4824 funccall_T *fc;
4825
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004826 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004828 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004829 abort = abort
4830 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4831 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004832 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 }
4834 return abort;
4835}
4836
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004837 static int
4838set_ref_in_funccal(funccall_T *fc, int copyID)
4839{
4840 int abort = FALSE;
4841
4842 if (fc->fc_copyID != copyID)
4843 {
4844 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004845 abort = abort
4846 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4847 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004848 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004849 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004850 }
4851 return abort;
4852}
4853
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854/*
4855 * Set "copyID" in all local vars and arguments in the call stack.
4856 */
4857 int
4858set_ref_in_call_stack(int copyID)
4859{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004860 int abort = FALSE;
4861 funccall_T *fc;
4862 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004864 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004865 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004866
4867 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004868 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4869 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004870 abort = abort || set_ref_in_funccal(fc, copyID);
4871
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004872 return abort;
4873}
4874
4875/*
4876 * Set "copyID" in all functions available by name.
4877 */
4878 int
4879set_ref_in_functions(int copyID)
4880{
4881 int todo;
4882 hashitem_T *hi = NULL;
4883 int abort = FALSE;
4884 ufunc_T *fp;
4885
4886 todo = (int)func_hashtab.ht_used;
4887 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004889 if (!HASHITEM_EMPTY(hi))
4890 {
4891 --todo;
4892 fp = HI2UF(hi);
4893 if (!func_name_refcount(fp->uf_name))
4894 abort = abort || set_ref_in_func(NULL, fp, copyID);
4895 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004896 }
4897 return abort;
4898}
4899
4900/*
4901 * Set "copyID" in all function arguments.
4902 */
4903 int
4904set_ref_in_func_args(int copyID)
4905{
4906 int i;
4907 int abort = FALSE;
4908
4909 for (i = 0; i < funcargs.ga_len; ++i)
4910 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4911 copyID, NULL, NULL);
4912 return abort;
4913}
4914
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004915/*
4916 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004917 * Returns TRUE if setting references failed somehow.
4918 */
4919 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004920set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004921{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004922 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004923 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004924 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004925 char_u fname_buf[FLEN_FIXED + 1];
4926 char_u *tofree = NULL;
4927 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004928 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004929
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004930 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004931 return FALSE;
4932
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004933 if (fp_in == NULL)
4934 {
4935 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004936 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004937 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004938 if (fp != NULL)
4939 {
4940 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004941 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004942 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004943
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004944 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004945 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004946}
4947
Bram Moolenaare38eab22019-12-05 21:50:01 +01004948#endif // FEAT_EVAL