blob: 6e780ea0118009a03db2d86e2b22b040b28c042f [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 Moolenaar6914c642017-04-01 21:21:30 +02001376
1377/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001378 * Call a user function.
1379 */
1380 static void
1381call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001382 ufunc_T *fp, // pointer to function
1383 int argcount, // nr of args
1384 typval_T *argvars, // arguments
1385 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001386 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001387 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001388{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001389 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001390 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001391 funccall_T *fc;
1392 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001393 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001394 static int depth = 0;
1395 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001396 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001397 int i;
1398 int ai;
1399 int islambda = FALSE;
1400 char_u numbuf[NUMBUFLEN];
1401 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001402#ifdef FEAT_PROFILE
1403 proftime_T wait_start;
1404 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001405 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001407 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408
Bram Moolenaare38eab22019-12-05 21:50:01 +01001409 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001410 if (depth >= p_mfd)
1411 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001412 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001413 rettv->v_type = VAR_NUMBER;
1414 rettv->vval.v_number = -1;
1415 return;
1416 }
1417 ++depth;
1418
Bram Moolenaare38eab22019-12-05 21:50:01 +01001419 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001421 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001422 if (fc == NULL)
1423 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001424 fc->caller = current_funccal;
1425 current_funccal = fc;
1426 fc->func = fp;
1427 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001428 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001429 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001430 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1431 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001432 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001433 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001434 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001436 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001437 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001438 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001439 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001440 --depth;
1441 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001442 free_funccal(fc);
1443 return;
1444 }
1445
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001446 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1447 islambda = TRUE;
1448
1449 /*
1450 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1451 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1452 * each argument variable and saves a lot of time.
1453 */
1454 /*
1455 * Init l: variables.
1456 */
1457 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1458 if (selfdict != NULL)
1459 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001460 // Set l:self to "selfdict". Use "name" to avoid a warning from
1461 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 v = &fc->fixvar[fixvar_idx++].var;
1463 name = v->di_key;
1464 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001465 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001466 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1467 v->di_tv.v_type = VAR_DICT;
1468 v->di_tv.v_lock = 0;
1469 v->di_tv.vval.v_dict = selfdict;
1470 ++selfdict->dv_refcount;
1471 }
1472
1473 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001474 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001475 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476 * Set a:000 to a list with room for the "..." arguments.
1477 */
1478 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001479 if ((fp->uf_flags & FC_NOARGS) == 0)
1480 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001481 (varnumber_T)(argcount >= fp->uf_args.ga_len
1482 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001483 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001484 if ((fp->uf_flags & FC_NOARGS) == 0)
1485 {
1486 // Use "name" to avoid a warning from some compiler that checks the
1487 // destination size.
1488 v = &fc->fixvar[fixvar_idx++].var;
1489 name = v->di_key;
1490 STRCPY(name, "000");
1491 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1492 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1493 v->di_tv.v_type = VAR_LIST;
1494 v->di_tv.v_lock = VAR_FIXED;
1495 v->di_tv.vval.v_list = &fc->l_varlist;
1496 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001497 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1499 fc->l_varlist.lv_lock = VAR_FIXED;
1500
1501 /*
1502 * Set a:firstline to "firstline" and a:lastline to "lastline".
1503 * Set a:name to named arguments.
1504 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001505 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001507 if ((fp->uf_flags & FC_NOARGS) == 0)
1508 {
1509 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001510 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001511 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001512 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001513 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001514 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 {
1516 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001517 typval_T def_rettv;
1518 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519
1520 ai = i - fp->uf_args.ga_len;
1521 if (ai < 0)
1522 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001523 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524 name = FUNCARG(fp, i);
1525 if (islambda)
1526 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001527
1528 // evaluate named argument default expression
1529 isdefault = ai + fp->uf_def_args.ga_len >= 0
1530 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1531 && argvars[i].vval.v_number == VVAL_NONE));
1532 if (isdefault)
1533 {
1534 char_u *default_expr = NULL;
1535 def_rettv.v_type = VAR_NUMBER;
1536 def_rettv.vval.v_number = -1;
1537
1538 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1539 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001540 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001541 {
1542 default_arg_err = 1;
1543 break;
1544 }
1545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001546 }
1547 else
1548 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001549 if ((fp->uf_flags & FC_NOARGS) != 0)
1550 // Bail out if no a: arguments used (in lambda).
1551 break;
1552
Bram Moolenaare38eab22019-12-05 21:50:01 +01001553 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554 sprintf((char *)numbuf, "%d", ai + 1);
1555 name = numbuf;
1556 }
1557 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1558 {
1559 v = &fc->fixvar[fixvar_idx++].var;
1560 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001561 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562 }
1563 else
1564 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001565 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 if (v == NULL)
1567 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001568 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001571 // Note: the values are copied directly to avoid alloc/free.
1572 // "argvars" must have VAR_FIXED for v_lock.
1573 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 v->di_tv.v_lock = VAR_FIXED;
1575
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 if (addlocal)
1577 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001578 // Named arguments should be accessed without the "a:" prefix in
1579 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001580 copy_tv(&v->di_tv, &v->di_tv);
1581 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001583 else
1584 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585
1586 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1587 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001588 listitem_T *li = &fc->l_listitems[ai];
1589
1590 li->li_tv = argvars[i];
1591 li->li_tv.v_lock = VAR_FIXED;
1592 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593 }
1594 }
1595
Bram Moolenaare38eab22019-12-05 21:50:01 +01001596 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001598
1599 if (fp->uf_flags & FC_SANDBOX)
1600 {
1601 using_sandbox = TRUE;
1602 ++sandbox;
1603 }
1604
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001605 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001606 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001607 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001609 ++no_wait_return;
1610 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001612 smsg(_("calling %s"), SOURCING_NAME);
1613 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001615 char_u buf[MSG_BUF_LEN];
1616 char_u numbuf2[NUMBUFLEN];
1617 char_u *tofree;
1618 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001620 msg_puts("(");
1621 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001623 if (i > 0)
1624 msg_puts(", ");
1625 if (argvars[i].v_type == VAR_NUMBER)
1626 msg_outnum((long)argvars[i].vval.v_number);
1627 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001629 // Do not want errors such as E724 here.
1630 ++emsg_off;
1631 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1632 --emsg_off;
1633 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001635 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001637 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1638 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001640 msg_puts((char *)s);
1641 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 }
1643 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001645 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001646 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001647 msg_puts("\n"); // don't overwrite this either
1648
1649 verbose_leave_scroll();
1650 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001651 }
1652#ifdef FEAT_PROFILE
1653 if (do_profiling == PROF_YES)
1654 {
1655 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001656 {
1657 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001659 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 if (fp->uf_profiling
1661 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1662 {
1663 ++fp->uf_tm_count;
1664 profile_start(&call_start);
1665 profile_zero(&fp->uf_tm_children);
1666 }
1667 script_prof_save(&wait_start);
1668 }
1669#endif
1670
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001671 save_current_sctx = current_sctx;
1672 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001673 save_did_emsg = did_emsg;
1674 did_emsg = FALSE;
1675
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001676 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1677 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001678 else if (islambda)
1679 {
1680 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1681
1682 // A Lambda always has the command "return {expr}". It is much faster
1683 // to evaluate {expr} directly.
1684 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001685 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001686 --ex_nesting_level;
1687 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001688 else
1689 // call do_cmdline() to execute the lines
1690 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1692
1693 --RedrawingDisabled;
1694
Bram Moolenaare38eab22019-12-05 21:50:01 +01001695 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1697 {
1698 clear_tv(rettv);
1699 rettv->v_type = VAR_NUMBER;
1700 rettv->vval.v_number = -1;
1701 }
1702
1703#ifdef FEAT_PROFILE
1704 if (do_profiling == PROF_YES && (fp->uf_profiling
1705 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1706 {
1707 profile_end(&call_start);
1708 profile_sub_wait(&wait_start, &call_start);
1709 profile_add(&fp->uf_tm_total, &call_start);
1710 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1711 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1712 {
1713 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1714 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1715 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001716 if (started_profiling)
1717 // make a ":profdel func" stop profiling the function
1718 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 }
1720#endif
1721
Bram Moolenaare38eab22019-12-05 21:50:01 +01001722 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723 if (p_verbose >= 12)
1724 {
1725 ++no_wait_return;
1726 verbose_enter_scroll();
1727
1728 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001729 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001731 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 (long)fc->rettv->vval.v_number);
1733 else
1734 {
1735 char_u buf[MSG_BUF_LEN];
1736 char_u numbuf2[NUMBUFLEN];
1737 char_u *tofree;
1738 char_u *s;
1739
Bram Moolenaare38eab22019-12-05 21:50:01 +01001740 // The value may be very long. Skip the middle part, so that we
1741 // have some idea how it starts and ends. smsg() would always
1742 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 ++emsg_off;
1744 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1745 --emsg_off;
1746 if (s != NULL)
1747 {
1748 if (vim_strsize(s) > MSG_BUF_CLEN)
1749 {
1750 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1751 s = buf;
1752 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001753 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 vim_free(tofree);
1755 }
1756 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001757 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758
1759 verbose_leave_scroll();
1760 --no_wait_return;
1761 }
1762
Bram Moolenaare31ee862020-01-07 20:59:34 +01001763 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001764 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001765 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001766#ifdef FEAT_PROFILE
1767 if (do_profiling == PROF_YES)
1768 script_prof_restore(&wait_start);
1769#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001770 if (using_sandbox)
1771 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001772
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001773 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774 {
1775 ++no_wait_return;
1776 verbose_enter_scroll();
1777
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001778 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001779 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780
1781 verbose_leave_scroll();
1782 --no_wait_return;
1783 }
1784
1785 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001786 --depth;
1787
Bram Moolenaar6914c642017-04-01 21:21:30 +02001788 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789}
1790
1791/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001792 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001793 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001794 int
1795call_user_func_check(
1796 ufunc_T *fp,
1797 int argcount,
1798 typval_T *argvars,
1799 typval_T *rettv,
1800 funcexe_T *funcexe,
1801 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001802{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001803 int error;
1804 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001805
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001806 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1807 *funcexe->doesrange = TRUE;
1808 if (argcount < regular_args - fp->uf_def_args.ga_len)
1809 error = FCERR_TOOFEW;
1810 else if (!has_varargs(fp) && argcount > regular_args)
1811 error = FCERR_TOOMANY;
1812 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1813 error = FCERR_DICT;
1814 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001815 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001816 int did_save_redo = FALSE;
1817 save_redo_T save_redo;
1818
1819 /*
1820 * Call the user function.
1821 * Save and restore search patterns, script variables and
1822 * redo buffer.
1823 */
1824 save_search_patterns();
1825 if (!ins_compl_active())
1826 {
1827 saveRedobuff(&save_redo);
1828 did_save_redo = TRUE;
1829 }
1830 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001831 call_user_func(fp, argcount, argvars, rettv, funcexe,
1832 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001833 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1834 // Function was unreferenced while being used, free it now.
1835 func_clear_free(fp, FALSE);
1836 if (did_save_redo)
1837 restoreRedobuff(&save_redo);
1838 restore_search_patterns();
1839 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001840 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001841 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001842}
1843
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001844static funccal_entry_T *funccal_stack = NULL;
1845
1846/*
1847 * Save the current function call pointer, and set it to NULL.
1848 * Used when executing autocommands and for ":source".
1849 */
1850 void
1851save_funccal(funccal_entry_T *entry)
1852{
1853 entry->top_funccal = current_funccal;
1854 entry->next = funccal_stack;
1855 funccal_stack = entry;
1856 current_funccal = NULL;
1857}
1858
1859 void
1860restore_funccal(void)
1861{
1862 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001863 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001864 else
1865 {
1866 current_funccal = funccal_stack->top_funccal;
1867 funccal_stack = funccal_stack->next;
1868 }
1869}
1870
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001871 funccall_T *
1872get_current_funccal(void)
1873{
1874 return current_funccal;
1875}
1876
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001877/*
1878 * Mark all functions of script "sid" as deleted.
1879 */
1880 void
1881delete_script_functions(int sid)
1882{
1883 hashitem_T *hi;
1884 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001885 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001886 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001887 size_t len;
1888
1889 buf[0] = K_SPECIAL;
1890 buf[1] = KS_EXTRA;
1891 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001892 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001893 len = STRLEN(buf);
1894
Bram Moolenaarce658352020-07-31 23:47:12 +02001895 while (todo > 0)
1896 {
1897 todo = func_hashtab.ht_used;
1898 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1899 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001900 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001901 fp = HI2UF(hi);
1902 if (STRNCMP(fp->uf_name, buf, len) == 0)
1903 {
1904 int changed = func_hashtab.ht_changed;
1905
1906 fp->uf_flags |= FC_DEAD;
1907 func_clear(fp, TRUE);
1908 // When clearing a function another function can be cleared
1909 // as a side effect. When that happens start over.
1910 if (changed != func_hashtab.ht_changed)
1911 break;
1912 }
1913 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001914 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001915 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001916}
1917
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918#if defined(EXITFREE) || defined(PROTO)
1919 void
1920free_all_functions(void)
1921{
1922 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001923 ufunc_T *fp;
1924 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001925 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001926 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927
Bram Moolenaare38eab22019-12-05 21:50:01 +01001928 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001929 while (current_funccal != NULL)
1930 {
1931 clear_tv(current_funccal->rettv);
1932 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001933 if (current_funccal == NULL && funccal_stack != NULL)
1934 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001935 }
1936
Bram Moolenaare38eab22019-12-05 21:50:01 +01001937 // First clear what the functions contain. Since this may lower the
1938 // reference count of a function, it may also free a function and change
1939 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001940 while (todo > 0)
1941 {
1942 todo = func_hashtab.ht_used;
1943 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1944 if (!HASHITEM_EMPTY(hi))
1945 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001946 // clear the def function index now
1947 fp = HI2UF(hi);
1948 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001949 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001950
Bram Moolenaare38eab22019-12-05 21:50:01 +01001951 // Only free functions that are not refcounted, those are
1952 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001953 if (func_name_refcount(fp->uf_name))
1954 ++skipped;
1955 else
1956 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001957 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001958 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001959 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001960 {
1961 skipped = 0;
1962 break;
1963 }
1964 }
1965 --todo;
1966 }
1967 }
1968
Bram Moolenaare38eab22019-12-05 21:50:01 +01001969 // Now actually free the functions. Need to start all over every time,
1970 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001971 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001972 while (func_hashtab.ht_used > skipped)
1973 {
1974 todo = func_hashtab.ht_used;
1975 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001976 if (!HASHITEM_EMPTY(hi))
1977 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001978 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001979 // Only free functions that are not refcounted, those are
1980 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001981 fp = HI2UF(hi);
1982 if (func_name_refcount(fp->uf_name))
1983 ++skipped;
1984 else
1985 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02001986 if (func_free(fp, FALSE) == OK)
1987 {
1988 skipped = 0;
1989 break;
1990 }
1991 // did not actually free it
1992 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001993 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001994 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001995 }
1996 if (skipped == 0)
1997 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998
1999 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002000}
2001#endif
2002
2003/*
2004 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002005 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002006 * "len" is the length of "name", or -1 for NUL terminated.
2007 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002008 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002009builtin_function(char_u *name, int len)
2010{
2011 char_u *p;
2012
Bram Moolenaara26b9702020-04-18 19:53:28 +02002013 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 return FALSE;
2015 p = vim_strchr(name, AUTOLOAD_CHAR);
2016 return p == NULL || (len > 0 && p > name + len);
2017}
2018
2019 int
2020func_call(
2021 char_u *name,
2022 typval_T *args,
2023 partial_T *partial,
2024 dict_T *selfdict,
2025 typval_T *rettv)
2026{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002027 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 listitem_T *item;
2029 typval_T argv[MAX_FUNC_ARGS + 1];
2030 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002031 int r = 0;
2032
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002033 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002034 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002035 {
2036 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2037 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002038 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 break;
2040 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002041 // Make a copy of each argument. This is needed to be able to set
2042 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002043 copy_tv(&item->li_tv, &argv[argc++]);
2044 }
2045
2046 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002047 {
2048 funcexe_T funcexe;
2049
Bram Moolenaara80faa82020-04-12 19:37:17 +02002050 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002051 funcexe.firstline = curwin->w_cursor.lnum;
2052 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002053 funcexe.evaluate = TRUE;
2054 funcexe.partial = partial;
2055 funcexe.selfdict = selfdict;
2056 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2057 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058
Bram Moolenaare38eab22019-12-05 21:50:01 +01002059 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002060 while (argc > 0)
2061 clear_tv(&argv[--argc]);
2062
2063 return r;
2064}
2065
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002066static int callback_depth = 0;
2067
2068 int
2069get_callback_depth(void)
2070{
2071 return callback_depth;
2072}
2073
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002074/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002075 * Invoke call_func() with a callback.
2076 */
2077 int
2078call_callback(
2079 callback_T *callback,
2080 int len, // length of "name" or -1 to use strlen()
2081 typval_T *rettv, // return value goes here
2082 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002083 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002084 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002085{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002086 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002087 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002088
Bram Moolenaara80faa82020-04-12 19:37:17 +02002089 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002090 funcexe.evaluate = TRUE;
2091 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002092 ++callback_depth;
2093 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2094 --callback_depth;
2095 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002096}
2097
2098/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002099 * Give an error message for the result of a function.
2100 * Nothing if "error" is FCERR_NONE.
2101 */
2102 void
2103user_func_error(int error, char_u *name)
2104{
2105 switch (error)
2106 {
2107 case FCERR_UNKNOWN:
2108 emsg_funcname(e_unknownfunc, name);
2109 break;
2110 case FCERR_NOTMETHOD:
2111 emsg_funcname(
2112 N_("E276: Cannot use function as a method: %s"), name);
2113 break;
2114 case FCERR_DELETED:
2115 emsg_funcname(N_(e_func_deleted), name);
2116 break;
2117 case FCERR_TOOMANY:
2118 emsg_funcname((char *)e_toomanyarg, name);
2119 break;
2120 case FCERR_TOOFEW:
2121 emsg_funcname((char *)e_toofewarg, name);
2122 break;
2123 case FCERR_SCRIPT:
2124 emsg_funcname(
2125 N_("E120: Using <SID> not in a script context: %s"), name);
2126 break;
2127 case FCERR_DICT:
2128 emsg_funcname(
2129 N_("E725: Calling dict function without Dictionary: %s"),
2130 name);
2131 break;
2132 }
2133}
2134
2135/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002136 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002137 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002138 * Return FAIL when the function can't be called, OK otherwise.
2139 * Also returns OK when an error was encountered while executing the function.
2140 */
2141 int
2142call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002143 char_u *funcname, // name of the function
2144 int len, // length of "name" or -1 to use strlen()
2145 typval_T *rettv, // return value goes here
2146 int argcount_in, // number of "argvars"
2147 typval_T *argvars_in, // vars for arguments, must have "argcount"
2148 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002149 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002150{
2151 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002152 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002154 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002155 char_u fname_buf[FLEN_FIXED + 1];
2156 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002157 char_u *fname = NULL;
2158 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159 int argcount = argcount_in;
2160 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002161 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002162 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2163 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002164 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002165 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002166 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002167
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002168 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2169 // even when call_func() returns FAIL.
2170 rettv->v_type = VAR_UNKNOWN;
2171
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002172 if (partial != NULL)
2173 fp = partial->pt_func;
2174 if (fp == NULL)
2175 {
2176 // Make a copy of the name, if it comes from a funcref variable it
2177 // could be changed or deleted in the called function.
2178 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2179 if (name == NULL)
2180 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002181
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002182 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2183 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002185 if (funcexe->doesrange != NULL)
2186 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002187
2188 if (partial != NULL)
2189 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002190 // When the function has a partial with a dict and there is a dict
2191 // argument, use the dict argument. That is backwards compatible.
2192 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002193 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002195 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002196 {
2197 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002198 {
2199 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2200 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002201 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002202 goto theend;
2203 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002205 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206 for (i = 0; i < argcount_in; ++i)
2207 argv[i + argv_clear] = argvars_in[i];
2208 argvars = argv;
2209 argcount = partial->pt_argc + argcount_in;
2210 }
2211 }
2212
Bram Moolenaaref140542019-12-31 21:27:13 +01002213 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 {
2215 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002216 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217
Bram Moolenaar333894b2020-08-01 18:53:07 +02002218 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002219 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002220 {
2221 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002222 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002224
Bram Moolenaare38eab22019-12-05 21:50:01 +01002225 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002227 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002229 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002230 {
2231 /*
2232 * User defined function.
2233 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002234 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002235 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002236
Bram Moolenaare38eab22019-12-05 21:50:01 +01002237 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002238 if (fp == NULL
2239 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002240 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 && !aborting())
2242 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002243 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002244 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002245 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002246 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2248 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002249 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002250 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002251 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002252 if (fp == NULL)
2253 {
2254 char_u *p = untrans_function_name(rfname);
2255
2256 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002257 // Don't do this if the name starts with "s:".
2258 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002259 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002260 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002261
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002262 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002263 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002264#ifdef FEAT_LUA
2265 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2266 {
2267 cfunc_T cb = fp->uf_cb;
2268
2269 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2270 }
2271#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002272 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002273 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002274 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002275 // postponed filling in the arguments, do it now
2276 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002277 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002278
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002279 if (funcexe->basetv != NULL)
2280 {
2281 // Method call: base->Method()
2282 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2283 argv[0] = *funcexe->basetv;
2284 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002285 argvars = argv;
2286 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002287 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002288
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002289 error = call_user_func_check(fp, argcount, argvars, rettv,
2290 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002291 }
2292 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002293 else if (funcexe->basetv != NULL)
2294 {
2295 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002296 * expr->method(): Find the method name in the table, call its
2297 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002298 */
2299 error = call_internal_method(fname, argcount, argvars, rettv,
2300 funcexe->basetv);
2301 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002302 else
2303 {
2304 /*
2305 * Find the function name in the table, call its implementation.
2306 */
2307 error = call_internal_func(fname, argcount, argvars, rettv);
2308 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002309
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002310 /*
2311 * The function call (or "FuncUndefined" autocommand sequence) might
2312 * have been aborted by an error, an interrupt, or an explicitly thrown
2313 * exception that has not been caught so far. This situation can be
2314 * tested for by calling aborting(). For an error in an internal
2315 * function or for the "E132" error in call_user_func(), however, the
2316 * throw point at which the "force_abort" flag (temporarily reset by
2317 * emsg()) is normally updated has not been reached yet. We need to
2318 * update that flag first to make aborting() reliable.
2319 */
2320 update_force_abort();
2321 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002322 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002323 ret = OK;
2324
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002325theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326 /*
2327 * Report an error unless the argument evaluation or function call has been
2328 * cancelled due to an aborting error, an interrupt, or an exception.
2329 */
2330 if (!aborting())
2331 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002332 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 }
2334
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002335 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002337 clear_tv(&argv[--argv_clear + argv_base]);
2338
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002339 vim_free(tofree);
2340 vim_free(name);
2341
2342 return ret;
2343}
2344
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002345 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002346printable_func_name(ufunc_T *fp)
2347{
2348 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2349}
2350
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002352 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 */
2354 static void
2355list_func_head(ufunc_T *fp, int indent)
2356{
2357 int j;
2358
2359 msg_start();
2360 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002361 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002362 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002363 msg_puts("def ");
2364 else
2365 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002366 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 msg_putchar('(');
2368 for (j = 0; j < fp->uf_args.ga_len; ++j)
2369 {
2370 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002371 msg_puts(", ");
2372 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002373 if (fp->uf_arg_types != NULL)
2374 {
2375 char *tofree;
2376
2377 msg_puts(": ");
2378 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2379 vim_free(tofree);
2380 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002381 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2382 {
2383 msg_puts(" = ");
2384 msg_puts(((char **)(fp->uf_def_args.ga_data))
2385 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2386 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387 }
2388 if (fp->uf_varargs)
2389 {
2390 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002391 msg_puts(", ");
2392 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002394 if (fp->uf_va_name != NULL)
2395 {
2396 if (j)
2397 msg_puts(", ");
2398 msg_puts("...");
2399 msg_puts((char *)fp->uf_va_name);
2400 if (fp->uf_va_type)
2401 {
2402 char *tofree;
2403
2404 msg_puts(": ");
2405 msg_puts(type_name(fp->uf_va_type, &tofree));
2406 vim_free(tofree);
2407 }
2408 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002410
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002411 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002412 {
2413 if (fp->uf_ret_type != &t_void)
2414 {
2415 char *tofree;
2416
2417 msg_puts(": ");
2418 msg_puts(type_name(fp->uf_ret_type, &tofree));
2419 vim_free(tofree);
2420 }
2421 }
2422 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002423 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002425 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002427 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002428 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002429 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 msg_clr_eos();
2431 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002432 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433}
2434
2435/*
2436 * Get a function name, translating "<SID>" and "<SNR>".
2437 * Also handles a Funcref in a List or Dictionary.
2438 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002439 * Set "*is_global" to TRUE when the function must be global, unless
2440 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002441 * flags:
2442 * TFN_INT: internal function name OK
2443 * TFN_QUIET: be quiet
2444 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002445 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 * Advances "pp" to just after the function name (if no error).
2447 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002448 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449trans_function_name(
2450 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002451 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002452 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002454 funcdict_T *fdp, // return: info about dictionary used
2455 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002456{
2457 char_u *name = NULL;
2458 char_u *start;
2459 char_u *end;
2460 int lead;
2461 char_u sid_buf[20];
2462 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002463 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002465 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002466 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467
2468 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002469 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 start = *pp;
2471
Bram Moolenaare38eab22019-12-05 21:50:01 +01002472 // Check for hard coded <SNR>: already translated function ID (from a user
2473 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2475 && (*pp)[2] == (int)KE_SNR)
2476 {
2477 *pp += 3;
2478 len = get_id_len(pp) + 3;
2479 return vim_strnsave(start, len);
2480 }
2481
Bram Moolenaare38eab22019-12-05 21:50:01 +01002482 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2483 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 lead = eval_fname_script(start);
2485 if (lead > 2)
2486 start += lead;
2487
Bram Moolenaare38eab22019-12-05 21:50:01 +01002488 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002489 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 lead > 2 ? 0 : FNE_CHECK_START);
2491 if (end == start)
2492 {
2493 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002494 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 goto theend;
2496 }
2497 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2498 {
2499 /*
2500 * Report an invalid expression in braces, unless the expression
2501 * evaluation has been cancelled due to an aborting error, an
2502 * interrupt, or an exception.
2503 */
2504 if (!aborting())
2505 {
2506 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002507 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002508 }
2509 else
2510 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2511 goto theend;
2512 }
2513
2514 if (lv.ll_tv != NULL)
2515 {
2516 if (fdp != NULL)
2517 {
2518 fdp->fd_dict = lv.ll_dict;
2519 fdp->fd_newkey = lv.ll_newkey;
2520 lv.ll_newkey = NULL;
2521 fdp->fd_di = lv.ll_di;
2522 }
2523 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2524 {
2525 name = vim_strsave(lv.ll_tv->vval.v_string);
2526 *pp = end;
2527 }
2528 else if (lv.ll_tv->v_type == VAR_PARTIAL
2529 && lv.ll_tv->vval.v_partial != NULL)
2530 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002531 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532 *pp = end;
2533 if (partial != NULL)
2534 *partial = lv.ll_tv->vval.v_partial;
2535 }
2536 else
2537 {
2538 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2539 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002540 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 else
2542 *pp = end;
2543 name = NULL;
2544 }
2545 goto theend;
2546 }
2547
2548 if (lv.ll_name == NULL)
2549 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002550 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551 *pp = end;
2552 goto theend;
2553 }
2554
Bram Moolenaare38eab22019-12-05 21:50:01 +01002555 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 if (lv.ll_exp_name != NULL)
2557 {
2558 len = (int)STRLEN(lv.ll_exp_name);
2559 name = deref_func_name(lv.ll_exp_name, &len, partial,
2560 flags & TFN_NO_AUTOLOAD);
2561 if (name == lv.ll_exp_name)
2562 name = NULL;
2563 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002564 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002565 {
2566 len = (int)(end - *pp);
2567 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2568 if (name == *pp)
2569 name = NULL;
2570 }
2571 if (name != NULL)
2572 {
2573 name = vim_strsave(name);
2574 *pp = end;
2575 if (STRNCMP(name, "<SNR>", 5) == 0)
2576 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002577 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 name[0] = K_SPECIAL;
2579 name[1] = KS_EXTRA;
2580 name[2] = (int)KE_SNR;
2581 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2582 }
2583 goto theend;
2584 }
2585
2586 if (lv.ll_exp_name != NULL)
2587 {
2588 len = (int)STRLEN(lv.ll_exp_name);
2589 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2590 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2591 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002592 // When there was "s:" already or the name expanded to get a
2593 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002594 lv.ll_name += 2;
2595 len -= 2;
2596 lead = 2;
2597 }
2598 }
2599 else
2600 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002601 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002603 {
2604 if (is_global != NULL && lv.ll_name[0] == 'g')
2605 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002606 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002607 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 len = (int)(end - lv.ll_name);
2609 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002610 if (len <= 0)
2611 {
2612 if (!skip)
2613 emsg(_(e_function_name));
2614 goto theend;
2615 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002617 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002618 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002619
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002620 /*
2621 * Copy the function name to allocated memory.
2622 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2623 * Accept <SNR>123_name() outside a script.
2624 */
2625 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002626 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002627 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002629 if (!vim9script)
2630 lead = 3;
2631 if (vim9script || (lv.ll_exp_name != NULL
2632 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 || eval_fname_sid(*pp))
2634 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002635 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002636 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002638 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 goto theend;
2640 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002641 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002642 if (vim9script)
2643 extra = 3 + (int)STRLEN(sid_buf);
2644 else
2645 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 }
2647 }
2648 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2649 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002650 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 start);
2652 goto theend;
2653 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002654 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 {
2656 char_u *cp = vim_strchr(lv.ll_name, ':');
2657
2658 if (cp != NULL && cp < end)
2659 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002660 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 goto theend;
2662 }
2663 }
2664
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002665 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 if (name != NULL)
2667 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002668 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669 {
2670 name[0] = K_SPECIAL;
2671 name[1] = KS_EXTRA;
2672 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002673 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 STRCPY(name + 3, sid_buf);
2675 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002676 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2677 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678 }
2679 *pp = end;
2680
2681theend:
2682 clear_lval(&lv);
2683 return name;
2684}
2685
2686/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002687 * Assuming "name" is the result of trans_function_name() and it was prefixed
2688 * to use the script-local name, return the unmodified name (points into
2689 * "name"). Otherwise return NULL.
2690 * This can be used to first search for a script-local function and fall back
2691 * to the global function if not found.
2692 */
2693 char_u *
2694untrans_function_name(char_u *name)
2695{
2696 char_u *p;
2697
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002698 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002699 {
2700 p = vim_strchr(name, '_');
2701 if (p != NULL)
2702 return p + 1;
2703 }
2704 return NULL;
2705}
2706
2707/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002708 * List functions. When "regmatch" is NULL all of then.
2709 * Otherwise functions matching "regmatch".
2710 */
2711 static void
2712list_functions(regmatch_T *regmatch)
2713{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002714 int changed = func_hashtab.ht_changed;
2715 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002716 hashitem_T *hi;
2717
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002718 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002719 {
2720 if (!HASHITEM_EMPTY(hi))
2721 {
2722 ufunc_T *fp = HI2UF(hi);
2723
2724 --todo;
2725 if ((fp->uf_flags & FC_DEAD) == 0
2726 && (regmatch == NULL
2727 ? !message_filtered(fp->uf_name)
2728 && !func_name_refcount(fp->uf_name)
2729 : !isdigit(*fp->uf_name)
2730 && vim_regexec(regmatch, fp->uf_name, 0)))
2731 {
2732 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002733 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002734 {
2735 emsg(_("E454: function list was modified"));
2736 return;
2737 }
2738 }
2739 }
2740 }
2741}
2742
2743/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002744 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002745 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2746 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002747 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002749 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002750define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751{
2752 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002753 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 int j;
2755 int c;
2756 int saved_did_emsg;
2757 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002758 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002759 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 char_u *p;
2761 char_u *arg;
2762 char_u *line_arg = NULL;
2763 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002764 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002765 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 garray_T newlines;
2767 int varargs = FALSE;
2768 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002769 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002770 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002771 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 int indent;
2773 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002774#define MAX_FUNC_NESTING 50
2775 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 dictitem_T *v;
2777 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002778 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002781 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002782 linenr_T sourcing_lnum_off;
2783 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002784 int is_heredoc = FALSE;
2785 char_u *skip_until = NULL;
2786 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002787 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002788 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789
2790 /*
2791 * ":function" without argument: list functions.
2792 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002793 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 {
2795 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002796 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002798 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 }
2800
2801 /*
2802 * ":function /pat": list functions matching pattern.
2803 */
2804 if (*eap->arg == '/')
2805 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002806 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 if (!eap->skip)
2808 {
2809 regmatch_T regmatch;
2810
2811 c = *p;
2812 *p = NUL;
2813 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2814 *p = c;
2815 if (regmatch.regprog != NULL)
2816 {
2817 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002818 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 vim_regfree(regmatch.regprog);
2820 }
2821 }
2822 if (*p == '/')
2823 ++p;
2824 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002825 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 }
2827
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002828 ga_init(&newargs);
2829 ga_init(&argtypes);
2830 ga_init(&default_args);
2831
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 /*
2833 * Get the function name. There are these situations:
2834 * func normal function name
2835 * "name" == func, "fudi.fd_dict" == NULL
2836 * dict.func new dictionary entry
2837 * "name" == NULL, "fudi.fd_dict" set,
2838 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2839 * dict.func existing dict entry with a Funcref
2840 * "name" == func, "fudi.fd_dict" set,
2841 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2842 * dict.func existing dict entry that's not a Funcref
2843 * "name" == NULL, "fudi.fd_dict" set,
2844 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2845 * s:func script-local function name
2846 * g:func global function name, same as "func"
2847 */
2848 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002849 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002851 // nested function, argument is (args).
2852 paren = TRUE;
2853 CLEAR_FIELD(fudi);
2854 }
2855 else
2856 {
2857 name = trans_function_name(&p, &is_global, eap->skip,
2858 TFN_NO_AUTOLOAD, &fudi, NULL);
2859 paren = (vim_strchr(p, '(') != NULL);
2860 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002862 /*
2863 * Return on an invalid expression in braces, unless the expression
2864 * evaluation has been cancelled due to an aborting error, an
2865 * interrupt, or an exception.
2866 */
2867 if (!aborting())
2868 {
2869 if (!eap->skip && fudi.fd_newkey != NULL)
2870 semsg(_(e_dictkey), fudi.fd_newkey);
2871 vim_free(fudi.fd_newkey);
2872 return NULL;
2873 }
2874 else
2875 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002877 }
2878
Bram Moolenaare38eab22019-12-05 21:50:01 +01002879 // An error in a function call during evaluation of an expression in magic
2880 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881 saved_did_emsg = did_emsg;
2882 did_emsg = FALSE;
2883
2884 /*
2885 * ":function func" with only function name: list function.
2886 */
2887 if (!paren)
2888 {
2889 if (!ends_excmd(*skipwhite(p)))
2890 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002891 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892 goto ret_free;
2893 }
2894 eap->nextcmd = check_nextcmd(p);
2895 if (eap->nextcmd != NULL)
2896 *p = NUL;
2897 if (!eap->skip && !got_int)
2898 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002899 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002900 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2901 {
2902 char_u *up = untrans_function_name(name);
2903
2904 // With Vim9 script the name was made script-local, if not
2905 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002906 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002907 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002908 }
2909
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002910 if (fp != NULL)
2911 {
2912 list_func_head(fp, TRUE);
2913 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2914 {
2915 if (FUNCLINE(fp, j) == NULL)
2916 continue;
2917 msg_putchar('\n');
2918 msg_outnum((long)(j + 1));
2919 if (j < 9)
2920 msg_putchar(' ');
2921 if (j < 99)
2922 msg_putchar(' ');
2923 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002924 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002925 ui_breakcheck();
2926 }
2927 if (!got_int)
2928 {
2929 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002930 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002931 msg_puts(" enddef");
2932 else
2933 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002934 }
2935 }
2936 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002937 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 }
2939 goto ret_free;
2940 }
2941
2942 /*
2943 * ":function name(arg1, arg2)" Define function.
2944 */
2945 p = skipwhite(p);
2946 if (*p != '(')
2947 {
2948 if (!eap->skip)
2949 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002950 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 goto ret_free;
2952 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002953 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954 if (vim_strchr(p, '(') != NULL)
2955 p = vim_strchr(p, '(');
2956 }
2957 p = skipwhite(p + 1);
2958
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002959 // In Vim9 script only global functions can be redefined.
2960 if (vim9script && eap->forceit && !is_global)
2961 {
2962 emsg(_(e_nobang));
2963 goto ret_free;
2964 }
2965
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2967
Bram Moolenaar04b12692020-05-04 23:24:44 +02002968 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002970 // Check the name of the function. Unless it's a dictionary function
2971 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 if (name != NULL)
2973 arg = name;
2974 else
2975 arg = fudi.fd_newkey;
2976 if (arg != NULL && (fudi.fd_di == NULL
2977 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2978 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2979 {
2980 if (*arg == K_SPECIAL)
2981 j = 3;
2982 else
2983 j = 0;
2984 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2985 : eval_isnamec(arg[j])))
2986 ++j;
2987 if (arg[j] != NUL)
2988 emsg_funcname((char *)e_invarg2, arg);
2989 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002990 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002992 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993 }
2994
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002995 // This may get more lines and make the pointers into the first line
2996 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002997 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01002998 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002999 &varargs, &default_args, eap->skip,
3000 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 goto errret_2;
3002
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003003 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003005 // find the return type: :def Func(): type
3006 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003008 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003009 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003010 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003011 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003012 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003013 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003014 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003015 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003016 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003017 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003018 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003019 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003021 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 else
3024 // find extra arguments "range", "dict", "abort" and "closure"
3025 for (;;)
3026 {
3027 p = skipwhite(p);
3028 if (STRNCMP(p, "range", 5) == 0)
3029 {
3030 flags |= FC_RANGE;
3031 p += 5;
3032 }
3033 else if (STRNCMP(p, "dict", 4) == 0)
3034 {
3035 flags |= FC_DICT;
3036 p += 4;
3037 }
3038 else if (STRNCMP(p, "abort", 5) == 0)
3039 {
3040 flags |= FC_ABORT;
3041 p += 5;
3042 }
3043 else if (STRNCMP(p, "closure", 7) == 0)
3044 {
3045 flags |= FC_CLOSURE;
3046 p += 7;
3047 if (current_funccal == NULL)
3048 {
3049 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3050 name == NULL ? (char_u *)"" : name);
3051 goto erret;
3052 }
3053 }
3054 else
3055 break;
3056 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057
Bram Moolenaare38eab22019-12-05 21:50:01 +01003058 // When there is a line break use what follows for the function body.
3059 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 if (*p == '\n')
3061 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003062 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003063 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3064 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003065 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3066 && !eap->skip
3067 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003068 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003069
3070 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3072 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073 */
3074 if (KeyTyped)
3075 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003076 // Check if the function already exists, don't let the user type the
3077 // whole function before telling him it doesn't work! For a script we
3078 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079 if (!eap->skip && !eap->forceit)
3080 {
3081 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003082 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003083 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084 emsg_funcname(e_funcexts, name);
3085 }
3086
3087 if (!eap->skip && did_emsg)
3088 goto erret;
3089
Bram Moolenaare38eab22019-12-05 21:50:01 +01003090 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 cmdline_row = msg_row;
3092 }
3093
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003094 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003095 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003096
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003097 // Detect having skipped over comment lines to find the return
3098 // type. Add NULL lines to keep the line count correct.
3099 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3100 if (SOURCING_LNUM < sourcing_lnum_off)
3101 {
3102 sourcing_lnum_off -= SOURCING_LNUM;
3103 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3104 goto erret;
3105 while (sourcing_lnum_off-- > 0)
3106 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3107 }
3108
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 indent = 2;
3110 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003111 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 for (;;)
3113 {
3114 if (KeyTyped)
3115 {
3116 msg_scroll = TRUE;
3117 saved_wait_return = FALSE;
3118 }
3119 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120
3121 if (line_arg != NULL)
3122 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003123 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124 theline = line_arg;
3125 p = vim_strchr(theline, '\n');
3126 if (p == NULL)
3127 line_arg += STRLEN(line_arg);
3128 else
3129 {
3130 *p = NUL;
3131 line_arg = p + 1;
3132 }
3133 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003135 {
3136 vim_free(line_to_free);
3137 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003138 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003139 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003140 theline = eap->getline(':', eap->cookie, indent,
3141 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003142 line_to_free = theline;
3143 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 if (KeyTyped)
3145 lines_left = Rows - 1;
3146 if (theline == NULL)
3147 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003148 if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003149 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003150 else
3151 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 goto erret;
3153 }
3154
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003155 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003156 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003157 if (SOURCING_LNUM < sourcing_lnum_off)
3158 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159 else
3160 sourcing_lnum_off = 0;
3161
3162 if (skip_until != NULL)
3163 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003164 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003165 // * ":append" and "."
3166 // * ":python <<EOF" and "EOF"
3167 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3168 if (heredoc_trimmed == NULL
3169 || (is_heredoc && skipwhite(theline) == theline)
3170 || STRNCMP(theline, heredoc_trimmed,
3171 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003172 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003173 if (heredoc_trimmed == NULL)
3174 p = theline;
3175 else if (is_heredoc)
3176 p = skipwhite(theline) == theline
3177 ? theline : theline + STRLEN(heredoc_trimmed);
3178 else
3179 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003180 if (STRCMP(p, skip_until) == 0)
3181 {
3182 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003183 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003184 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003185 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003186 }
3187 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003188 }
3189 else
3190 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003191 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003192 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003193 ;
3194
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003195 // Check for "endfunction" or "enddef".
3196 if (checkforcmd(&p, nesting_def[nesting]
3197 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003199 char_u *nextcmd = NULL;
3200
Bram Moolenaar663bb232017-06-22 19:12:10 +02003201 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003202 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003203 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003204 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003205 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 give_warning2(eap->cmdidx == CMD_def
3207 ? (char_u *)_("W1001: Text found after :enddef: %s")
3208 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003209 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003210 if (nextcmd != NULL)
3211 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003212 // Another command follows. If the line came from "eap" we
3213 // can simply point into it, otherwise we need to change
3214 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003215 eap->nextcmd = nextcmd;
3216 if (line_to_free != NULL)
3217 {
3218 vim_free(*eap->cmdlinep);
3219 *eap->cmdlinep = line_to_free;
3220 line_to_free = NULL;
3221 }
3222 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 break;
3224 }
3225
Bram Moolenaare38eab22019-12-05 21:50:01 +01003226 // Increase indent inside "if", "while", "for" and "try", decrease
3227 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003228 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 indent -= 2;
3230 else if (STRNCMP(p, "if", 2) == 0
3231 || STRNCMP(p, "wh", 2) == 0
3232 || STRNCMP(p, "for", 3) == 0
3233 || STRNCMP(p, "try", 3) == 0)
3234 indent += 2;
3235
Bram Moolenaare38eab22019-12-05 21:50:01 +01003236 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003237 // Only recognize "def" inside "def", not inside "function",
3238 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003239 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003240 if (checkforcmd(&p, "function", 2)
3241 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242 {
3243 if (*p == '!')
3244 p = skipwhite(p + 1);
3245 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003246 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247 if (*skipwhite(p) == '(')
3248 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003249 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003250 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251 else
3252 {
3253 ++nesting;
3254 nesting_def[nesting] = (c == 'd');
3255 indent += 2;
3256 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003257 }
3258 }
3259
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003260 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003261 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003262 if (eap->cmdidx != CMD_def
3263 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003264 || (p[0] == 'c'
3265 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3266 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3267 && (STRNCMP(&p[3], "nge", 3) != 0
3268 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 || (p[0] == 'i'
3270 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003271 && (!ASCII_ISALPHA(p[2])
3272 || (p[2] == 's'
3273 && (!ASCII_ISALPHA(p[3])
3274 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 skip_until = vim_strsave((char_u *)".");
3276
Bram Moolenaare38eab22019-12-05 21:50:01 +01003277 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 arg = skipwhite(skiptowhite(p));
3279 if (arg[0] == '<' && arg[1] =='<'
3280 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003281 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3282 || ((p[2] == '3' || p[2] == 'x')
3283 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 || (p[0] == 'p' && p[1] == 'e'
3285 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3286 || (p[0] == 't' && p[1] == 'c'
3287 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3288 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3289 && !ASCII_ISALPHA(p[3]))
3290 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3291 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3292 || (p[0] == 'm' && p[1] == 'z'
3293 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3294 ))
3295 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003296 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003298 if (STRNCMP(p, "trim", 4) == 0)
3299 {
3300 // Ignore leading white space.
3301 p = skipwhite(p + 4);
3302 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003303 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003304 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003305 if (*p == NUL)
3306 skip_until = vim_strsave((char_u *)".");
3307 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003308 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003309 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003310 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003312
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003313 // Check for ":cmd v =<< [trim] EOF"
3314 // and ":cmd [a, b] =<< [trim] EOF"
3315 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003316 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003317 if (*arg == '[')
3318 arg = vim_strchr(arg, ']');
3319 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003320 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003321 arg = skipwhite(skiptowhite(arg));
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003322 if (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3323 && (checkforcmd(&p, "let", 2)
3324 || checkforcmd(&p, "var", 3)
3325 || checkforcmd(&p, "final", 5)
3326 || checkforcmd(&p, "const", 5)))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003327 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003328 p = skipwhite(arg + 3);
3329 if (STRNCMP(p, "trim", 4) == 0)
3330 {
3331 // Ignore leading white space.
3332 p = skipwhite(p + 4);
3333 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003334 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003335 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003336 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003337 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003338 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003339 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003340 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 }
3342
Bram Moolenaare38eab22019-12-05 21:50:01 +01003343 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346
Bram Moolenaare38eab22019-12-05 21:50:01 +01003347 // Copy the line to newly allocated memory. get_one_sourceline()
3348 // allocates 250 bytes per line, this saves 80% on average. The cost
3349 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003351 if (p == NULL)
3352 goto erret;
3353 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
Bram Moolenaare38eab22019-12-05 21:50:01 +01003355 // Add NULL lines for continuation lines, so that the line count is
3356 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 while (sourcing_lnum_off-- > 0)
3358 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3359
Bram Moolenaare38eab22019-12-05 21:50:01 +01003360 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003361 if (line_arg != NULL && *line_arg == NUL)
3362 line_arg = NULL;
3363 }
3364
Bram Moolenaare38eab22019-12-05 21:50:01 +01003365 // Don't define the function when skipping commands or when an error was
3366 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 if (eap->skip || did_emsg)
3368 goto erret;
3369
3370 /*
3371 * If there are no errors, add the function
3372 */
3373 if (fudi.fd_dict == NULL)
3374 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003375 hashtab_T *ht;
3376
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 v = find_var(name, &ht, FALSE);
3378 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3379 {
3380 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3381 name);
3382 goto erret;
3383 }
3384
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003385 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003386 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003388 char_u *uname = untrans_function_name(name);
3389
3390 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3391 }
3392
3393 if (fp != NULL || import != NULL)
3394 {
3395 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003397 // Function can be replaced with "function!" and when sourcing the
3398 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003399 // A name that is used by an import can not be overruled.
3400 if (import != NULL
3401 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003402 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003403 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003405 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003406 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003407 else
3408 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 goto erret;
3410 }
3411 if (fp->uf_calls > 0)
3412 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003413 emsg_funcname(
3414 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003415 name);
3416 goto erret;
3417 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003418 if (fp->uf_refcount > 1)
3419 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003420 // This function is referenced somewhere, don't redefine it but
3421 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003422 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003423 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003424 fp = NULL;
3425 overwrite = TRUE;
3426 }
3427 else
3428 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003429 char_u *exp_name = fp->uf_name_exp;
3430
3431 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003432 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003433 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003434 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003435 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003436 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003437#ifdef FEAT_PROFILE
3438 fp->uf_profiling = FALSE;
3439 fp->uf_prof_initialized = FALSE;
3440#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003441 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003442 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 }
3444 }
3445 else
3446 {
3447 char numbuf[20];
3448
3449 fp = NULL;
3450 if (fudi.fd_newkey == NULL && !eap->forceit)
3451 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003452 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 goto erret;
3454 }
3455 if (fudi.fd_di == NULL)
3456 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003457 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003458 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003459 goto erret;
3460 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003461 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003462 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 goto erret;
3464
Bram Moolenaare38eab22019-12-05 21:50:01 +01003465 // Give the function a sequential number. Can only be used with a
3466 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467 vim_free(name);
3468 sprintf(numbuf, "%d", ++func_nr);
3469 name = vim_strsave((char_u *)numbuf);
3470 if (name == NULL)
3471 goto erret;
3472 }
3473
3474 if (fp == NULL)
3475 {
3476 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3477 {
3478 int slen, plen;
3479 char_u *scriptname;
3480
Bram Moolenaare38eab22019-12-05 21:50:01 +01003481 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003483 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 {
3485 scriptname = autoload_name(name);
3486 if (scriptname != NULL)
3487 {
3488 p = vim_strchr(scriptname, '/');
3489 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003490 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003491 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003492 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 j = OK;
3494 vim_free(scriptname);
3495 }
3496 }
3497 if (j == FAIL)
3498 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003499 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003500 goto erret;
3501 }
3502 }
3503
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003504 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 if (fp == NULL)
3506 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003507 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003508 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509
3510 if (fudi.fd_dict != NULL)
3511 {
3512 if (fudi.fd_di == NULL)
3513 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003514 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3516 if (fudi.fd_di == NULL)
3517 {
3518 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003519 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 goto erret;
3521 }
3522 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3523 {
3524 vim_free(fudi.fd_di);
3525 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003526 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003527 goto erret;
3528 }
3529 }
3530 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003531 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 clear_tv(&fudi.fd_di->di_tv);
3533 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535
Bram Moolenaare38eab22019-12-05 21:50:01 +01003536 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537 flags |= FC_DICT;
3538 }
3539
Bram Moolenaare38eab22019-12-05 21:50:01 +01003540 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003541 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003542 if (overwrite)
3543 {
3544 hi = hash_find(&func_hashtab, name);
3545 hi->hi_key = UF2HIKEY(fp);
3546 }
3547 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003548 {
3549 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003550 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 goto erret;
3552 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003553 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 }
3555 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003556 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003557 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003558 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003559
3560 if (eap->cmdidx == CMD_def)
3561 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003562 int lnum_save = SOURCING_LNUM;
3563 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003564
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003565 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003566
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003567 // error messages are for the first function line
3568 SOURCING_LNUM = sourcing_lnum_top;
3569
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003570 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003571 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003572 int count = cstack->cs_idx + 1;
3573 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003574
3575 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003576 // a block that is visible now but not when the function is called
3577 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003578 fp->uf_block_ids = ALLOC_MULT(int, count);
3579 if (fp->uf_block_ids != NULL)
3580 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003581 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003582 sizeof(int) * count);
3583 fp->uf_block_depth = count;
3584 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003585
3586 // Set flag in each block to indicate a function was defined. This
3587 // is used to keep the variable when leaving the block, see
3588 // hide_script_var().
3589 for (i = 0; i <= cstack->cs_idx; ++i)
3590 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003591 }
3592
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003593 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003594 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003595 SOURCING_LNUM = lnum_save;
3596 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003597 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003598 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003599
3600 // parse the return type, if any
3601 if (ret_type == NULL)
3602 fp->uf_ret_type = &t_void;
3603 else
3604 {
3605 p = ret_type;
3606 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3607 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003608 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003609 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003610 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003611 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003612
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003614 if ((flags & FC_CLOSURE) != 0)
3615 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003616 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003617 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003618 }
3619 else
3620 fp->uf_scoped = NULL;
3621
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003623 if (prof_def_func())
3624 func_do_profile(fp);
3625#endif
3626 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003627 if (sandbox)
3628 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003629 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003630 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 fp->uf_flags = flags;
3632 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003633 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003634 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003635 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003636 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003637 if (is_export)
3638 {
3639 fp->uf_flags |= FC_EXPORT;
3640 // let ex_export() know the export worked.
3641 is_export = FALSE;
3642 }
3643
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003644 if (eap->cmdidx == CMD_def)
3645 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003646 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3647 // :func does not use Vim9 script syntax, even in a Vim9 script file
3648 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003649
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 goto ret_free;
3651
3652erret:
3653 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003654 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655errret_2:
3656 ga_clear_strings(&newlines);
3657ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003658 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003660 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003662 if (name != name_arg)
3663 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003664 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 did_emsg |= saved_did_emsg;
3666 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003667
3668 return fp;
3669}
3670
3671/*
3672 * ":function"
3673 */
3674 void
3675ex_function(exarg_T *eap)
3676{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003677 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003678}
3679
3680/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003681 * :defcompile - compile all :def functions in the current script that need to
3682 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003683 */
3684 void
3685ex_defcompile(exarg_T *eap UNUSED)
3686{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003687 long todo = (long)func_hashtab.ht_used;
3688 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003689 hashitem_T *hi;
3690 ufunc_T *ufunc;
3691
3692 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3693 {
3694 if (!HASHITEM_EMPTY(hi))
3695 {
3696 --todo;
3697 ufunc = HI2UF(hi);
3698 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003699 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3700 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003701 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003702 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003703
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003704 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003705 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003706 // a function has been added or removed, need to start over
3707 todo = (long)func_hashtab.ht_used;
3708 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003709 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003710 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003711 }
3712 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003713 }
3714 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715}
3716
3717/*
3718 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3719 * Return 2 if "p" starts with "s:".
3720 * Return 0 otherwise.
3721 */
3722 int
3723eval_fname_script(char_u *p)
3724{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003725 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3726 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3728 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3729 return 5;
3730 if (p[0] == 's' && p[1] == ':')
3731 return 2;
3732 return 0;
3733}
3734
3735 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003736translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737{
3738 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003739 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003740 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003741}
3742
3743/*
3744 * Return TRUE when "ufunc" has old-style "..." varargs
3745 * or named varargs "...name: type".
3746 */
3747 int
3748has_varargs(ufunc_T *ufunc)
3749{
3750 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751}
3752
3753/*
3754 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003755 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 */
3757 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003758function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759{
3760 char_u *nm = name;
3761 char_u *p;
3762 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003763 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003764 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003766 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3767 if (no_deref)
3768 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003769 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003770 nm = skipwhite(nm);
3771
Bram Moolenaare38eab22019-12-05 21:50:01 +01003772 // Only accept "funcname", "funcname ", "funcname (..." and
3773 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003775 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 vim_free(p);
3777 return n;
3778}
3779
Bram Moolenaar113e1072019-01-20 15:30:40 +01003780#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 char_u *
3782get_expanded_name(char_u *name, int check)
3783{
3784 char_u *nm = name;
3785 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003786 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003788 p = trans_function_name(&nm, &is_global, FALSE,
3789 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003791 if (p != NULL && *nm == NUL
3792 && (!check || translated_function_exists(p, is_global)))
3793 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794
3795 vim_free(p);
3796 return NULL;
3797}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003798#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800/*
3801 * Function given to ExpandGeneric() to obtain the list of user defined
3802 * function names.
3803 */
3804 char_u *
3805get_user_func_name(expand_T *xp, int idx)
3806{
3807 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003808 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 static hashitem_T *hi;
3810 ufunc_T *fp;
3811
3812 if (idx == 0)
3813 {
3814 done = 0;
3815 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003816 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003818 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 {
3820 if (done++ > 0)
3821 ++hi;
3822 while (HASHITEM_EMPTY(hi))
3823 ++hi;
3824 fp = HI2UF(hi);
3825
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003826 // don't show dead, dict and lambda functions
3827 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003828 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003829 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830
3831 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003832 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833
3834 cat_func_name(IObuff, fp);
3835 if (xp->xp_context != EXPAND_USER_FUNC)
3836 {
3837 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003838 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003839 STRCAT(IObuff, ")");
3840 }
3841 return IObuff;
3842 }
3843 return NULL;
3844}
3845
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846/*
3847 * ":delfunction {name}"
3848 */
3849 void
3850ex_delfunction(exarg_T *eap)
3851{
3852 ufunc_T *fp = NULL;
3853 char_u *p;
3854 char_u *name;
3855 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003856 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857
3858 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003859 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003860 vim_free(fudi.fd_newkey);
3861 if (name == NULL)
3862 {
3863 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003864 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865 return;
3866 }
3867 if (!ends_excmd(*skipwhite(p)))
3868 {
3869 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003870 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 return;
3872 }
3873 eap->nextcmd = check_nextcmd(p);
3874 if (eap->nextcmd != NULL)
3875 *p = NUL;
3876
3877 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003878 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 vim_free(name);
3880
3881 if (!eap->skip)
3882 {
3883 if (fp == NULL)
3884 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003885 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003886 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 return;
3888 }
3889 if (fp->uf_calls > 0)
3890 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003891 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 return;
3893 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003894 if (fp->uf_flags & FC_VIM9)
3895 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003896 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003897 return;
3898 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899
3900 if (fudi.fd_dict != NULL)
3901 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003902 // Delete the dict item that refers to the function, it will
3903 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003904 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3905 }
3906 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003907 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003908 // A normal function (not a numbered function or lambda) has a
3909 // refcount of 1 for the entry in the hashtable. When deleting
3910 // it and the refcount is more than one, it should be kept.
3911 // A numbered function and lambda should be kept if the refcount is
3912 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003913 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003914 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003915 // Function is still referenced somewhere. Don't free it but
3916 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003917 if (func_remove(fp))
3918 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003919 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003920 }
3921 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003922 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003923 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924 }
3925}
3926
3927/*
3928 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003929 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 */
3931 void
3932func_unref(char_u *name)
3933{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003934 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003936 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003938 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003939 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003942 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003944 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003946 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003948 // Only delete it when it's not being used. Otherwise it's done
3949 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003950 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003951 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003952 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003953}
3954
3955/*
3956 * Unreference a Function: decrement the reference count and free it when it
3957 * becomes zero.
3958 */
3959 void
3960func_ptr_unref(ufunc_T *fp)
3961{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003962 if (fp != NULL && --fp->uf_refcount <= 0)
3963 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003964 // Only delete it when it's not being used. Otherwise it's done
3965 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003966 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003967 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 }
3969}
3970
3971/*
3972 * Count a reference to a Function.
3973 */
3974 void
3975func_ref(char_u *name)
3976{
3977 ufunc_T *fp;
3978
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003979 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003981 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003982 if (fp != NULL)
3983 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003985 // Only give an error for a numbered function.
3986 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003987 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003988}
3989
3990/*
3991 * Count a reference to a Function.
3992 */
3993 void
3994func_ptr_ref(ufunc_T *fp)
3995{
3996 if (fp != NULL)
3997 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998}
3999
4000/*
4001 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4002 * referenced from anywhere that is in use.
4003 */
4004 static int
4005can_free_funccal(funccall_T *fc, int copyID)
4006{
4007 return (fc->l_varlist.lv_copyID != copyID
4008 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004009 && fc->l_avars.dv_copyID != copyID
4010 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011}
4012
4013/*
4014 * ":return [expr]"
4015 */
4016 void
4017ex_return(exarg_T *eap)
4018{
4019 char_u *arg = eap->arg;
4020 typval_T rettv;
4021 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004022 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023
4024 if (current_funccal == NULL)
4025 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004026 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 return;
4028 }
4029
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004030 CLEAR_FIELD(evalarg);
4031 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4032
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 if (eap->skip)
4034 ++emsg_skip;
4035
4036 eap->nextcmd = NULL;
4037 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004038 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 {
4040 if (!eap->skip)
4041 returning = do_return(eap, FALSE, TRUE, &rettv);
4042 else
4043 clear_tv(&rettv);
4044 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004045 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 else if (!eap->skip)
4047 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004048 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004049 update_force_abort();
4050
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 /*
4052 * Return unless the expression evaluation has been cancelled due to an
4053 * aborting error, an interrupt, or an exception.
4054 */
4055 if (!aborting())
4056 returning = do_return(eap, FALSE, TRUE, NULL);
4057 }
4058
Bram Moolenaare38eab22019-12-05 21:50:01 +01004059 // When skipping or the return gets pending, advance to the next command
4060 // in this line (!returning). Otherwise, ignore the rest of the line.
4061 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 if (returning)
4063 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004064 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 eap->nextcmd = check_nextcmd(arg);
4066
4067 if (eap->skip)
4068 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004069 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070}
4071
4072/*
4073 * ":1,25call func(arg1, arg2)" function call.
4074 */
4075 void
4076ex_call(exarg_T *eap)
4077{
4078 char_u *arg = eap->arg;
4079 char_u *startarg;
4080 char_u *name;
4081 char_u *tofree;
4082 int len;
4083 typval_T rettv;
4084 linenr_T lnum;
4085 int doesrange;
4086 int failed = FALSE;
4087 funcdict_T fudi;
4088 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004089 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090
Bram Moolenaare6b53242020-07-01 17:28:33 +02004091 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 if (eap->skip)
4093 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004094 // trans_function_name() doesn't work well when skipping, use eval0()
4095 // instead to skip to any following command, e.g. for:
4096 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004098 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099 clear_tv(&rettv);
4100 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004101 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 return;
4103 }
4104
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004105 tofree = trans_function_name(&arg, NULL, eap->skip,
4106 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 if (fudi.fd_newkey != NULL)
4108 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004109 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004110 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 vim_free(fudi.fd_newkey);
4112 }
4113 if (tofree == NULL)
4114 return;
4115
Bram Moolenaare38eab22019-12-05 21:50:01 +01004116 // Increase refcount on dictionary, it could get deleted when evaluating
4117 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 if (fudi.fd_dict != NULL)
4119 ++fudi.fd_dict->dv_refcount;
4120
Bram Moolenaare38eab22019-12-05 21:50:01 +01004121 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4122 // contents. For VAR_PARTIAL get its partial, unless we already have one
4123 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 len = (int)STRLEN(tofree);
4125 name = deref_func_name(tofree, &len,
4126 partial != NULL ? NULL : &partial, FALSE);
4127
Bram Moolenaare38eab22019-12-05 21:50:01 +01004128 // Skip white space to allow ":call func ()". Not good, but required for
4129 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004131 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132
4133 if (*startarg != '(')
4134 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 goto end;
4137 }
4138
4139 /*
4140 * When skipping, evaluate the function once, to find the end of the
4141 * arguments.
4142 * When the function takes a range, this is discovered after the first
4143 * call, and the loop is broken.
4144 */
4145 if (eap->skip)
4146 {
4147 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004148 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004149 }
4150 else
4151 lnum = eap->line1;
4152 for ( ; lnum <= eap->line2; ++lnum)
4153 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004154 funcexe_T funcexe;
4155
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 if (!eap->skip && eap->addr_count > 0)
4157 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004158 if (lnum > curbuf->b_ml.ml_line_count)
4159 {
4160 // If the function deleted lines or switched to another buffer
4161 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004162 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004163 break;
4164 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 curwin->w_cursor.lnum = lnum;
4166 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004168 }
4169 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004170
Bram Moolenaara80faa82020-04-12 19:37:17 +02004171 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004172 funcexe.firstline = eap->line1;
4173 funcexe.lastline = eap->line2;
4174 funcexe.doesrange = &doesrange;
4175 funcexe.evaluate = !eap->skip;
4176 funcexe.partial = partial;
4177 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004178 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 {
4180 failed = TRUE;
4181 break;
4182 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004183 if (has_watchexpr())
4184 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004186 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004187 if (handle_subscript(&arg, &rettv,
4188 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 {
4190 failed = TRUE;
4191 break;
4192 }
4193
4194 clear_tv(&rettv);
4195 if (doesrange || eap->skip)
4196 break;
4197
Bram Moolenaare38eab22019-12-05 21:50:01 +01004198 // Stop when immediately aborting on error, or when an interrupt
4199 // occurred or an exception was thrown but not caught.
4200 // get_func_tv() returned OK, so that the check for trailing
4201 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 if (aborting())
4203 break;
4204 }
4205 if (eap->skip)
4206 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004207 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208
Bram Moolenaare51bb172020-02-16 19:42:23 +01004209 // When inside :try we need to check for following "| catch".
4210 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004212 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004213 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004214 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004216 if (!failed)
4217 {
4218 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004219 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004220 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 }
4222 else
4223 eap->nextcmd = check_nextcmd(arg);
4224 }
4225
4226end:
4227 dict_unref(fudi.fd_dict);
4228 vim_free(tofree);
4229}
4230
4231/*
4232 * Return from a function. Possibly makes the return pending. Also called
4233 * for a pending return at the ":endtry" or after returning from an extra
4234 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4235 * when called due to a ":return" command. "rettv" may point to a typval_T
4236 * with the return rettv. Returns TRUE when the return can be carried out,
4237 * FALSE when the return gets pending.
4238 */
4239 int
4240do_return(
4241 exarg_T *eap,
4242 int reanimate,
4243 int is_cmd,
4244 void *rettv)
4245{
4246 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004247 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248
4249 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004250 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004251 current_funccal->returned = FALSE;
4252
4253 /*
4254 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4255 * not in its finally clause (which then is to be executed next) is found.
4256 * In this case, make the ":return" pending for execution at the ":endtry".
4257 * Otherwise, return normally.
4258 */
4259 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4260 if (idx >= 0)
4261 {
4262 cstack->cs_pending[idx] = CSTP_RETURN;
4263
4264 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004265 // A pending return again gets pending. "rettv" points to an
4266 // allocated variable with the rettv of the original ":return"'s
4267 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 cstack->cs_rettv[idx] = rettv;
4269 else
4270 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004271 // When undoing a return in order to make it pending, get the stored
4272 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 if (reanimate)
4274 rettv = current_funccal->rettv;
4275
4276 if (rettv != NULL)
4277 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004278 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4280 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4281 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004282 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283 }
4284 else
4285 cstack->cs_rettv[idx] = NULL;
4286
4287 if (reanimate)
4288 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004289 // The pending return value could be overwritten by a ":return"
4290 // without argument in a finally clause; reset the default
4291 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 current_funccal->rettv->v_type = VAR_NUMBER;
4293 current_funccal->rettv->vval.v_number = 0;
4294 }
4295 }
4296 report_make_pending(CSTP_RETURN, rettv);
4297 }
4298 else
4299 {
4300 current_funccal->returned = TRUE;
4301
Bram Moolenaare38eab22019-12-05 21:50:01 +01004302 // If the return is carried out now, store the return value. For
4303 // a return immediately after reanimation, the value is already
4304 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004305 if (!reanimate && rettv != NULL)
4306 {
4307 clear_tv(current_funccal->rettv);
4308 *current_funccal->rettv = *(typval_T *)rettv;
4309 if (!is_cmd)
4310 vim_free(rettv);
4311 }
4312 }
4313
4314 return idx < 0;
4315}
4316
4317/*
4318 * Free the variable with a pending return value.
4319 */
4320 void
4321discard_pending_return(void *rettv)
4322{
4323 free_tv((typval_T *)rettv);
4324}
4325
4326/*
4327 * Generate a return command for producing the value of "rettv". The result
4328 * is an allocated string. Used by report_pending() for verbose messages.
4329 */
4330 char_u *
4331get_return_cmd(void *rettv)
4332{
4333 char_u *s = NULL;
4334 char_u *tofree = NULL;
4335 char_u numbuf[NUMBUFLEN];
4336
4337 if (rettv != NULL)
4338 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4339 if (s == NULL)
4340 s = (char_u *)"";
4341
4342 STRCPY(IObuff, ":return ");
4343 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4344 if (STRLEN(s) + 8 >= IOSIZE)
4345 STRCPY(IObuff + IOSIZE - 4, "...");
4346 vim_free(tofree);
4347 return vim_strsave(IObuff);
4348}
4349
4350/*
4351 * Get next function line.
4352 * Called by do_cmdline() to get the next line.
4353 * Returns allocated string, or NULL for end of function.
4354 */
4355 char_u *
4356get_func_line(
4357 int c UNUSED,
4358 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004359 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004360 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361{
4362 funccall_T *fcp = (funccall_T *)cookie;
4363 ufunc_T *fp = fcp->func;
4364 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004365 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366
Bram Moolenaare38eab22019-12-05 21:50:01 +01004367 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 if (fcp->dbg_tick != debug_tick)
4369 {
4370 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004371 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372 fcp->dbg_tick = debug_tick;
4373 }
4374#ifdef FEAT_PROFILE
4375 if (do_profiling == PROF_YES)
4376 func_line_end(cookie);
4377#endif
4378
4379 gap = &fp->uf_lines;
4380 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4381 || fcp->returned)
4382 retval = NULL;
4383 else
4384 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004385 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 while (fcp->linenr < gap->ga_len
4387 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4388 ++fcp->linenr;
4389 if (fcp->linenr >= gap->ga_len)
4390 retval = NULL;
4391 else
4392 {
4393 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004394 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395#ifdef FEAT_PROFILE
4396 if (do_profiling == PROF_YES)
4397 func_line_start(cookie);
4398#endif
4399 }
4400 }
4401
Bram Moolenaare38eab22019-12-05 21:50:01 +01004402 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004403 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004405 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004406 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004408 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004409 fcp->dbg_tick = debug_tick;
4410 }
4411
4412 return retval;
4413}
4414
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415/*
4416 * Return TRUE if the currently active function should be ended, because a
4417 * return was encountered or an error occurred. Used inside a ":while".
4418 */
4419 int
4420func_has_ended(void *cookie)
4421{
4422 funccall_T *fcp = (funccall_T *)cookie;
4423
Bram Moolenaare38eab22019-12-05 21:50:01 +01004424 // Ignore the "abort" flag if the abortion behavior has been changed due to
4425 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4427 || fcp->returned);
4428}
4429
4430/*
4431 * return TRUE if cookie indicates a function which "abort"s on errors.
4432 */
4433 int
4434func_has_abort(
4435 void *cookie)
4436{
4437 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4438}
4439
4440
4441/*
4442 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4443 * Don't do this when "Func" is already a partial that was bound
4444 * explicitly (pt_auto is FALSE).
4445 * Changes "rettv" in-place.
4446 * Returns the updated "selfdict_in".
4447 */
4448 dict_T *
4449make_partial(dict_T *selfdict_in, typval_T *rettv)
4450{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004451 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 char_u *tofree = NULL;
4453 ufunc_T *fp;
4454 char_u fname_buf[FLEN_FIXED + 1];
4455 int error;
4456 dict_T *selfdict = selfdict_in;
4457
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004458 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4459 fp = rettv->vval.v_partial->pt_func;
4460 else
4461 {
4462 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4463 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004464 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004465 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004466 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004467 vim_free(tofree);
4468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469
4470 if (fp != NULL && (fp->uf_flags & FC_DICT))
4471 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004472 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473
4474 if (pt != NULL)
4475 {
4476 pt->pt_refcount = 1;
4477 pt->pt_dict = selfdict;
4478 pt->pt_auto = TRUE;
4479 selfdict = NULL;
4480 if (rettv->v_type == VAR_FUNC)
4481 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004482 // Just a function: Take over the function name and use
4483 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484 pt->pt_name = rettv->vval.v_string;
4485 }
4486 else
4487 {
4488 partial_T *ret_pt = rettv->vval.v_partial;
4489 int i;
4490
Bram Moolenaare38eab22019-12-05 21:50:01 +01004491 // Partial: copy the function name, use selfdict and copy
4492 // args. Can't take over name or args, the partial might
4493 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004494 if (ret_pt->pt_name != NULL)
4495 {
4496 pt->pt_name = vim_strsave(ret_pt->pt_name);
4497 func_ref(pt->pt_name);
4498 }
4499 else
4500 {
4501 pt->pt_func = ret_pt->pt_func;
4502 func_ptr_ref(pt->pt_func);
4503 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 if (ret_pt->pt_argc > 0)
4505 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004506 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004508 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 pt->pt_argc = 0;
4510 else
4511 {
4512 pt->pt_argc = ret_pt->pt_argc;
4513 for (i = 0; i < pt->pt_argc; i++)
4514 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4515 }
4516 }
4517 partial_unref(ret_pt);
4518 }
4519 rettv->v_type = VAR_PARTIAL;
4520 rettv->vval.v_partial = pt;
4521 }
4522 }
4523 return selfdict;
4524}
4525
4526/*
4527 * Return the name of the executed function.
4528 */
4529 char_u *
4530func_name(void *cookie)
4531{
4532 return ((funccall_T *)cookie)->func->uf_name;
4533}
4534
4535/*
4536 * Return the address holding the next breakpoint line for a funccall cookie.
4537 */
4538 linenr_T *
4539func_breakpoint(void *cookie)
4540{
4541 return &((funccall_T *)cookie)->breakpoint;
4542}
4543
4544/*
4545 * Return the address holding the debug tick for a funccall cookie.
4546 */
4547 int *
4548func_dbg_tick(void *cookie)
4549{
4550 return &((funccall_T *)cookie)->dbg_tick;
4551}
4552
4553/*
4554 * Return the nesting level for a funccall cookie.
4555 */
4556 int
4557func_level(void *cookie)
4558{
4559 return ((funccall_T *)cookie)->level;
4560}
4561
4562/*
4563 * Return TRUE when a function was ended by a ":return" command.
4564 */
4565 int
4566current_func_returned(void)
4567{
4568 return current_funccal->returned;
4569}
4570
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 int
4572free_unref_funccal(int copyID, int testing)
4573{
4574 int did_free = FALSE;
4575 int did_free_funccal = FALSE;
4576 funccall_T *fc, **pfc;
4577
4578 for (pfc = &previous_funccal; *pfc != NULL; )
4579 {
4580 if (can_free_funccal(*pfc, copyID))
4581 {
4582 fc = *pfc;
4583 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004584 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 did_free = TRUE;
4586 did_free_funccal = TRUE;
4587 }
4588 else
4589 pfc = &(*pfc)->caller;
4590 }
4591 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004592 // When a funccal was freed some more items might be garbage
4593 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594 (void)garbage_collect(testing);
4595
4596 return did_free;
4597}
4598
4599/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004600 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601 */
4602 static funccall_T *
4603get_funccal(void)
4604{
4605 int i;
4606 funccall_T *funccal;
4607 funccall_T *temp_funccal;
4608
4609 funccal = current_funccal;
4610 if (debug_backtrace_level > 0)
4611 {
4612 for (i = 0; i < debug_backtrace_level; i++)
4613 {
4614 temp_funccal = funccal->caller;
4615 if (temp_funccal)
4616 funccal = temp_funccal;
4617 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004618 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 debug_backtrace_level = i;
4620 }
4621 }
4622 return funccal;
4623}
4624
4625/*
4626 * Return the hashtable used for local variables in the current funccal.
4627 * Return NULL if there is no current funccal.
4628 */
4629 hashtab_T *
4630get_funccal_local_ht()
4631{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004632 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 return NULL;
4634 return &get_funccal()->l_vars.dv_hashtab;
4635}
4636
4637/*
4638 * Return the l: scope variable.
4639 * Return NULL if there is no current funccal.
4640 */
4641 dictitem_T *
4642get_funccal_local_var()
4643{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004644 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 return NULL;
4646 return &get_funccal()->l_vars_var;
4647}
4648
4649/*
4650 * Return the hashtable used for argument in the current funccal.
4651 * Return NULL if there is no current funccal.
4652 */
4653 hashtab_T *
4654get_funccal_args_ht()
4655{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004656 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004657 return NULL;
4658 return &get_funccal()->l_avars.dv_hashtab;
4659}
4660
4661/*
4662 * Return the a: scope variable.
4663 * Return NULL if there is no current funccal.
4664 */
4665 dictitem_T *
4666get_funccal_args_var()
4667{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004668 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004670 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671}
4672
4673/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 * List function variables, if there is a function.
4675 */
4676 void
4677list_func_vars(int *first)
4678{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004679 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004681 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682}
4683
4684/*
4685 * If "ht" is the hashtable for local variables in the current funccal, return
4686 * the dict that contains it.
4687 * Otherwise return NULL.
4688 */
4689 dict_T *
4690get_current_funccal_dict(hashtab_T *ht)
4691{
4692 if (current_funccal != NULL
4693 && ht == &current_funccal->l_vars.dv_hashtab)
4694 return &current_funccal->l_vars;
4695 return NULL;
4696}
4697
4698/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004699 * Search hashitem in parent scope.
4700 */
4701 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004702find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004703{
4704 funccall_T *old_current_funccal = current_funccal;
4705 hashtab_T *ht;
4706 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004707 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004708
4709 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4710 return NULL;
4711
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004712 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004713 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004714 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004715 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004716 ht = find_var_ht(name, &varname);
4717 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004718 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004719 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004720 if (!HASHITEM_EMPTY(hi))
4721 {
4722 *pht = ht;
4723 break;
4724 }
4725 }
4726 if (current_funccal == current_funccal->func->uf_scoped)
4727 break;
4728 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004729 }
4730 current_funccal = old_current_funccal;
4731
4732 return hi;
4733}
4734
4735/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004736 * Search variable in parent scope.
4737 */
4738 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004739find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004740{
4741 dictitem_T *v = NULL;
4742 funccall_T *old_current_funccal = current_funccal;
4743 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004744 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004745
4746 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4747 return NULL;
4748
Bram Moolenaare38eab22019-12-05 21:50:01 +01004749 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004750 current_funccal = current_funccal->func->uf_scoped;
4751 while (current_funccal)
4752 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004753 ht = find_var_ht(name, &varname);
4754 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004755 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004756 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004757 if (v != NULL)
4758 break;
4759 }
4760 if (current_funccal == current_funccal->func->uf_scoped)
4761 break;
4762 current_funccal = current_funccal->func->uf_scoped;
4763 }
4764 current_funccal = old_current_funccal;
4765
4766 return v;
4767}
4768
4769/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770 * Set "copyID + 1" in previous_funccal and callers.
4771 */
4772 int
4773set_ref_in_previous_funccal(int copyID)
4774{
4775 int abort = FALSE;
4776 funccall_T *fc;
4777
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004778 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004779 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004780 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004781 abort = abort
4782 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4783 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004784 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785 }
4786 return abort;
4787}
4788
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004789 static int
4790set_ref_in_funccal(funccall_T *fc, int copyID)
4791{
4792 int abort = FALSE;
4793
4794 if (fc->fc_copyID != copyID)
4795 {
4796 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004797 abort = abort
4798 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4799 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004800 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004801 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004802 }
4803 return abort;
4804}
4805
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806/*
4807 * Set "copyID" in all local vars and arguments in the call stack.
4808 */
4809 int
4810set_ref_in_call_stack(int copyID)
4811{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004812 int abort = FALSE;
4813 funccall_T *fc;
4814 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004816 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004817 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004818
4819 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004820 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4821 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004822 abort = abort || set_ref_in_funccal(fc, copyID);
4823
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004824 return abort;
4825}
4826
4827/*
4828 * Set "copyID" in all functions available by name.
4829 */
4830 int
4831set_ref_in_functions(int copyID)
4832{
4833 int todo;
4834 hashitem_T *hi = NULL;
4835 int abort = FALSE;
4836 ufunc_T *fp;
4837
4838 todo = (int)func_hashtab.ht_used;
4839 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004841 if (!HASHITEM_EMPTY(hi))
4842 {
4843 --todo;
4844 fp = HI2UF(hi);
4845 if (!func_name_refcount(fp->uf_name))
4846 abort = abort || set_ref_in_func(NULL, fp, copyID);
4847 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 }
4849 return abort;
4850}
4851
4852/*
4853 * Set "copyID" in all function arguments.
4854 */
4855 int
4856set_ref_in_func_args(int copyID)
4857{
4858 int i;
4859 int abort = FALSE;
4860
4861 for (i = 0; i < funcargs.ga_len; ++i)
4862 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4863 copyID, NULL, NULL);
4864 return abort;
4865}
4866
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004867/*
4868 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004869 * Returns TRUE if setting references failed somehow.
4870 */
4871 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004872set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004873{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004874 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004875 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004876 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004877 char_u fname_buf[FLEN_FIXED + 1];
4878 char_u *tofree = NULL;
4879 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004880 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004881
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004882 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004883 return FALSE;
4884
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004885 if (fp_in == NULL)
4886 {
4887 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004888 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004889 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004890 if (fp != NULL)
4891 {
4892 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004893 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004894 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004895
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004896 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004897 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004898}
4899
Bram Moolenaare38eab22019-12-05 21:50:01 +01004900#endif // FEAT_EVAL