blob: b9fb644f1d3a5fad0931612af04709f19595c7e0 [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 Moolenaarf112f302020-12-20 17:47:52 +01001228 partial_unref(fp->uf_partial);
1229 fp->uf_partial = NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001230
1231#ifdef FEAT_LUA
1232 if (fp->uf_cb_free != NULL)
1233 {
1234 fp->uf_cb_free(fp->uf_cb_state);
1235 fp->uf_cb_free = NULL;
1236 }
1237
1238 fp->uf_cb_state = NULL;
1239 fp->uf_cb = NULL;
1240#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001241#ifdef FEAT_PROFILE
1242 VIM_CLEAR(fp->uf_tml_count);
1243 VIM_CLEAR(fp->uf_tml_total);
1244 VIM_CLEAR(fp->uf_tml_self);
1245#endif
1246}
1247
1248/*
1249 * Free all things that a function contains. Does not free the function
1250 * itself, use func_free() for that.
1251 * When "force" is TRUE we are exiting.
1252 */
1253 static void
1254func_clear(ufunc_T *fp, int force)
1255{
1256 if (fp->uf_cleared)
1257 return;
1258 fp->uf_cleared = TRUE;
1259
1260 // clear this function
1261 func_clear_items(fp);
1262 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001263 if ((fp->uf_flags & FC_COPY) == 0)
1264 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001265}
1266
1267/*
1268 * Free a function and remove it from the list of functions. Does not free
1269 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001270 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001271 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001272 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001273 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001274func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001275{
1276 // Only remove it when not done already, otherwise we would remove a newer
1277 // version of the function with the same name.
1278 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1279 func_remove(fp);
1280
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001281 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001282 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001283 if (fp->uf_dfunc_idx > 0)
1284 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001285 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001286 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001287 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001288 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001289 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001290}
1291
1292/*
1293 * Free all things that a function contains and free the function itself.
1294 * When "force" is TRUE we are exiting.
1295 */
1296 static void
1297func_clear_free(ufunc_T *fp, int force)
1298{
1299 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001300 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1301 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001302 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001303 else
1304 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001305}
1306
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001307/*
1308 * Copy already defined function "lambda" to a new function with name "global".
1309 * This is for when a compiled function defines a global function.
Bram Moolenaarf112f302020-12-20 17:47:52 +01001310 * Caller should take care of adding a partial for a closure.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001311 */
Bram Moolenaarf112f302020-12-20 17:47:52 +01001312 ufunc_T *
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001313copy_func(char_u *lambda, char_u *global)
1314{
1315 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001316 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001317
1318 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001319 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001320 else
1321 {
1322 // TODO: handle ! to overwrite
1323 fp = find_func(global, TRUE, NULL);
1324 if (fp != NULL)
1325 {
1326 semsg(_(e_funcexts), global);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001327 return NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001328 }
1329
1330 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1331 if (fp == NULL)
Bram Moolenaarf112f302020-12-20 17:47:52 +01001332 return NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001333
1334 fp->uf_varargs = ufunc->uf_varargs;
1335 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1336 fp->uf_def_status = ufunc->uf_def_status;
1337 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001338 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1339 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001340 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001341 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001342 goto failed;
1343
1344 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1345 : vim_strsave(ufunc->uf_name_exp);
1346 if (ufunc->uf_arg_types != NULL)
1347 {
1348 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1349 if (fp->uf_arg_types == NULL)
1350 goto failed;
1351 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1352 sizeof(type_T *) * fp->uf_args.ga_len);
1353 }
1354 if (ufunc->uf_def_arg_idx != NULL)
1355 {
1356 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1357 if (fp->uf_def_arg_idx == NULL)
1358 goto failed;
1359 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1360 sizeof(int) * fp->uf_def_args.ga_len + 1);
1361 }
1362 if (ufunc->uf_va_name != NULL)
1363 {
1364 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1365 if (fp->uf_va_name == NULL)
1366 goto failed;
1367 }
Bram Moolenaarf112f302020-12-20 17:47:52 +01001368 fp->uf_ret_type = ufunc->uf_ret_type;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001369
1370 fp->uf_refcount = 1;
1371 STRCPY(fp->uf_name, global);
1372 hash_add(&func_hashtab, UF2HIKEY(fp));
1373 }
Bram Moolenaarf112f302020-12-20 17:47:52 +01001374 return fp;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001375
1376failed:
1377 func_clear_free(fp, TRUE);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001378 return NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001379}
1380
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001381static int funcdepth = 0;
1382
1383/*
1384 * Increment the function call depth count.
1385 * Return FAIL when going over 'maxfuncdepth'.
1386 * Otherwise return OK, must call funcdepth_decrement() later!
1387 */
1388 int
1389funcdepth_increment(void)
1390{
1391 if (funcdepth >= p_mfd)
1392 {
1393 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1394 return FAIL;
1395 }
1396 ++funcdepth;
1397 return OK;
1398}
1399
1400 void
1401funcdepth_decrement(void)
1402{
1403 --funcdepth;
1404}
1405
1406/*
1407 * Get the current function call depth.
1408 */
1409 int
1410funcdepth_get(void)
1411{
1412 return funcdepth;
1413}
1414
1415/*
1416 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001417 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001418 * times as funcdepth_increment().
1419 */
1420 void
1421funcdepth_restore(int depth)
1422{
1423 funcdepth = depth;
1424}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001425
1426/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001427 * Call a user function.
1428 */
1429 static void
1430call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001431 ufunc_T *fp, // pointer to function
1432 int argcount, // nr of args
1433 typval_T *argvars, // arguments
1434 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001435 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001436 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001437{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001438 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001439 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 funccall_T *fc;
1441 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001442 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001443 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001444 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001445 int i;
1446 int ai;
1447 int islambda = FALSE;
1448 char_u numbuf[NUMBUFLEN];
1449 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450#ifdef FEAT_PROFILE
1451 proftime_T wait_start;
1452 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001453 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001455 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001457 // If depth of calling is getting too high, don't execute the function.
1458 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001459 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 rettv->v_type = VAR_NUMBER;
1461 rettv->vval.v_number = -1;
1462 return;
1463 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001464
Bram Moolenaare38eab22019-12-05 21:50:01 +01001465 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001466
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001467 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001468 if (fc == NULL)
1469 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001470 fc->caller = current_funccal;
1471 current_funccal = fc;
1472 fc->func = fp;
1473 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001475 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1477 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001478 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001479 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001480 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001482 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001483 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001484 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001485 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001486 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001487 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001488 free_funccal(fc);
1489 return;
1490 }
1491
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1493 islambda = TRUE;
1494
1495 /*
1496 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1497 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1498 * each argument variable and saves a lot of time.
1499 */
1500 /*
1501 * Init l: variables.
1502 */
1503 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1504 if (selfdict != NULL)
1505 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001506 // Set l:self to "selfdict". Use "name" to avoid a warning from
1507 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508 v = &fc->fixvar[fixvar_idx++].var;
1509 name = v->di_key;
1510 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001511 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001512 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1513 v->di_tv.v_type = VAR_DICT;
1514 v->di_tv.v_lock = 0;
1515 v->di_tv.vval.v_dict = selfdict;
1516 ++selfdict->dv_refcount;
1517 }
1518
1519 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001520 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001521 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 * Set a:000 to a list with room for the "..." arguments.
1523 */
1524 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001525 if ((fp->uf_flags & FC_NOARGS) == 0)
1526 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001527 (varnumber_T)(argcount >= fp->uf_args.ga_len
1528 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001529 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001530 if ((fp->uf_flags & FC_NOARGS) == 0)
1531 {
1532 // Use "name" to avoid a warning from some compiler that checks the
1533 // destination size.
1534 v = &fc->fixvar[fixvar_idx++].var;
1535 name = v->di_key;
1536 STRCPY(name, "000");
1537 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1538 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1539 v->di_tv.v_type = VAR_LIST;
1540 v->di_tv.v_lock = VAR_FIXED;
1541 v->di_tv.vval.v_list = &fc->l_varlist;
1542 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001543 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1545 fc->l_varlist.lv_lock = VAR_FIXED;
1546
1547 /*
1548 * Set a:firstline to "firstline" and a:lastline to "lastline".
1549 * Set a:name to named arguments.
1550 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001551 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001553 if ((fp->uf_flags & FC_NOARGS) == 0)
1554 {
1555 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001556 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001557 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001558 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001559 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001560 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 {
1562 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001563 typval_T def_rettv;
1564 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565
1566 ai = i - fp->uf_args.ga_len;
1567 if (ai < 0)
1568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001569 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570 name = FUNCARG(fp, i);
1571 if (islambda)
1572 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001573
1574 // evaluate named argument default expression
1575 isdefault = ai + fp->uf_def_args.ga_len >= 0
1576 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1577 && argvars[i].vval.v_number == VVAL_NONE));
1578 if (isdefault)
1579 {
1580 char_u *default_expr = NULL;
1581 def_rettv.v_type = VAR_NUMBER;
1582 def_rettv.vval.v_number = -1;
1583
1584 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1585 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001586 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001587 {
1588 default_arg_err = 1;
1589 break;
1590 }
1591 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001592 }
1593 else
1594 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001595 if ((fp->uf_flags & FC_NOARGS) != 0)
1596 // Bail out if no a: arguments used (in lambda).
1597 break;
1598
Bram Moolenaare38eab22019-12-05 21:50:01 +01001599 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 sprintf((char *)numbuf, "%d", ai + 1);
1601 name = numbuf;
1602 }
1603 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1604 {
1605 v = &fc->fixvar[fixvar_idx++].var;
1606 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001607 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 }
1609 else
1610 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001611 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 if (v == NULL)
1613 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001614 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001616
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001617 // Note: the values are copied directly to avoid alloc/free.
1618 // "argvars" must have VAR_FIXED for v_lock.
1619 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620 v->di_tv.v_lock = VAR_FIXED;
1621
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 if (addlocal)
1623 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001624 // Named arguments should be accessed without the "a:" prefix in
1625 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001626 copy_tv(&v->di_tv, &v->di_tv);
1627 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001629 else
1630 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001631
1632 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1633 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001634 listitem_T *li = &fc->l_listitems[ai];
1635
1636 li->li_tv = argvars[i];
1637 li->li_tv.v_lock = VAR_FIXED;
1638 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 }
1640 }
1641
Bram Moolenaare38eab22019-12-05 21:50:01 +01001642 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001644
1645 if (fp->uf_flags & FC_SANDBOX)
1646 {
1647 using_sandbox = TRUE;
1648 ++sandbox;
1649 }
1650
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001651 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001652 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001653 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001655 ++no_wait_return;
1656 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001658 smsg(_("calling %s"), SOURCING_NAME);
1659 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001661 char_u buf[MSG_BUF_LEN];
1662 char_u numbuf2[NUMBUFLEN];
1663 char_u *tofree;
1664 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001666 msg_puts("(");
1667 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001668 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001669 if (i > 0)
1670 msg_puts(", ");
1671 if (argvars[i].v_type == VAR_NUMBER)
1672 msg_outnum((long)argvars[i].vval.v_number);
1673 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001674 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001675 // Do not want errors such as E724 here.
1676 ++emsg_off;
1677 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1678 --emsg_off;
1679 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001681 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001683 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1684 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001686 msg_puts((char *)s);
1687 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 }
1689 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001691 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001693 msg_puts("\n"); // don't overwrite this either
1694
1695 verbose_leave_scroll();
1696 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 }
1698#ifdef FEAT_PROFILE
1699 if (do_profiling == PROF_YES)
1700 {
1701 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001702 {
1703 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001704 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001705 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001706 if (fp->uf_profiling
1707 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1708 {
1709 ++fp->uf_tm_count;
1710 profile_start(&call_start);
1711 profile_zero(&fp->uf_tm_children);
1712 }
1713 script_prof_save(&wait_start);
1714 }
1715#endif
1716
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001717 save_current_sctx = current_sctx;
1718 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 save_did_emsg = did_emsg;
1720 did_emsg = FALSE;
1721
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001722 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1723 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001724 else if (islambda)
1725 {
1726 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1727
1728 // A Lambda always has the command "return {expr}". It is much faster
1729 // to evaluate {expr} directly.
1730 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001731 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001732 --ex_nesting_level;
1733 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001734 else
1735 // call do_cmdline() to execute the lines
1736 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001737 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1738
1739 --RedrawingDisabled;
1740
Bram Moolenaare38eab22019-12-05 21:50:01 +01001741 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1743 {
1744 clear_tv(rettv);
1745 rettv->v_type = VAR_NUMBER;
1746 rettv->vval.v_number = -1;
1747 }
1748
1749#ifdef FEAT_PROFILE
1750 if (do_profiling == PROF_YES && (fp->uf_profiling
1751 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1752 {
1753 profile_end(&call_start);
1754 profile_sub_wait(&wait_start, &call_start);
1755 profile_add(&fp->uf_tm_total, &call_start);
1756 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1757 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1758 {
1759 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1760 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1761 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001762 if (started_profiling)
1763 // make a ":profdel func" stop profiling the function
1764 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 }
1766#endif
1767
Bram Moolenaare38eab22019-12-05 21:50:01 +01001768 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 if (p_verbose >= 12)
1770 {
1771 ++no_wait_return;
1772 verbose_enter_scroll();
1773
1774 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001775 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001777 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 (long)fc->rettv->vval.v_number);
1779 else
1780 {
1781 char_u buf[MSG_BUF_LEN];
1782 char_u numbuf2[NUMBUFLEN];
1783 char_u *tofree;
1784 char_u *s;
1785
Bram Moolenaare38eab22019-12-05 21:50:01 +01001786 // The value may be very long. Skip the middle part, so that we
1787 // have some idea how it starts and ends. smsg() would always
1788 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789 ++emsg_off;
1790 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1791 --emsg_off;
1792 if (s != NULL)
1793 {
1794 if (vim_strsize(s) > MSG_BUF_CLEN)
1795 {
1796 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1797 s = buf;
1798 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001799 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800 vim_free(tofree);
1801 }
1802 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001803 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804
1805 verbose_leave_scroll();
1806 --no_wait_return;
1807 }
1808
Bram Moolenaare31ee862020-01-07 20:59:34 +01001809 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001810 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001811 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001812#ifdef FEAT_PROFILE
1813 if (do_profiling == PROF_YES)
1814 script_prof_restore(&wait_start);
1815#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001816 if (using_sandbox)
1817 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001819 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 {
1821 ++no_wait_return;
1822 verbose_enter_scroll();
1823
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001824 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001825 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826
1827 verbose_leave_scroll();
1828 --no_wait_return;
1829 }
1830
1831 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001832 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001833 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834}
1835
1836/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001837 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001838 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001839 int
1840call_user_func_check(
1841 ufunc_T *fp,
1842 int argcount,
1843 typval_T *argvars,
1844 typval_T *rettv,
1845 funcexe_T *funcexe,
1846 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001847{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001848 int error;
1849 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001850
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001851 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1852 *funcexe->doesrange = TRUE;
1853 if (argcount < regular_args - fp->uf_def_args.ga_len)
1854 error = FCERR_TOOFEW;
1855 else if (!has_varargs(fp) && argcount > regular_args)
1856 error = FCERR_TOOMANY;
1857 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1858 error = FCERR_DICT;
1859 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001860 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001861 int did_save_redo = FALSE;
1862 save_redo_T save_redo;
1863
1864 /*
1865 * Call the user function.
1866 * Save and restore search patterns, script variables and
1867 * redo buffer.
1868 */
1869 save_search_patterns();
1870 if (!ins_compl_active())
1871 {
1872 saveRedobuff(&save_redo);
1873 did_save_redo = TRUE;
1874 }
1875 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001876 call_user_func(fp, argcount, argvars, rettv, funcexe,
1877 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001878 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1879 // Function was unreferenced while being used, free it now.
1880 func_clear_free(fp, FALSE);
1881 if (did_save_redo)
1882 restoreRedobuff(&save_redo);
1883 restore_search_patterns();
1884 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001885 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001886 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001887}
1888
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001889static funccal_entry_T *funccal_stack = NULL;
1890
1891/*
1892 * Save the current function call pointer, and set it to NULL.
1893 * Used when executing autocommands and for ":source".
1894 */
1895 void
1896save_funccal(funccal_entry_T *entry)
1897{
1898 entry->top_funccal = current_funccal;
1899 entry->next = funccal_stack;
1900 funccal_stack = entry;
1901 current_funccal = NULL;
1902}
1903
1904 void
1905restore_funccal(void)
1906{
1907 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001908 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001909 else
1910 {
1911 current_funccal = funccal_stack->top_funccal;
1912 funccal_stack = funccal_stack->next;
1913 }
1914}
1915
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001916 funccall_T *
1917get_current_funccal(void)
1918{
1919 return current_funccal;
1920}
1921
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001922/*
1923 * Mark all functions of script "sid" as deleted.
1924 */
1925 void
1926delete_script_functions(int sid)
1927{
1928 hashitem_T *hi;
1929 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001930 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001931 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001932 size_t len;
1933
1934 buf[0] = K_SPECIAL;
1935 buf[1] = KS_EXTRA;
1936 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001937 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001938 len = STRLEN(buf);
1939
Bram Moolenaarce658352020-07-31 23:47:12 +02001940 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))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001945 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001946 fp = HI2UF(hi);
1947 if (STRNCMP(fp->uf_name, buf, len) == 0)
1948 {
1949 int changed = func_hashtab.ht_changed;
1950
1951 fp->uf_flags |= FC_DEAD;
1952 func_clear(fp, TRUE);
1953 // When clearing a function another function can be cleared
1954 // as a side effect. When that happens start over.
1955 if (changed != func_hashtab.ht_changed)
1956 break;
1957 }
1958 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001959 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001960 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001961}
1962
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001963#if defined(EXITFREE) || defined(PROTO)
1964 void
1965free_all_functions(void)
1966{
1967 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001968 ufunc_T *fp;
1969 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001970 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001971 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001972
Bram Moolenaare38eab22019-12-05 21:50:01 +01001973 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001974 while (current_funccal != NULL)
1975 {
1976 clear_tv(current_funccal->rettv);
1977 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001978 if (current_funccal == NULL && funccal_stack != NULL)
1979 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001980 }
1981
Bram Moolenaare38eab22019-12-05 21:50:01 +01001982 // First clear what the functions contain. Since this may lower the
1983 // reference count of a function, it may also free a function and change
1984 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001985 while (todo > 0)
1986 {
1987 todo = func_hashtab.ht_used;
1988 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1989 if (!HASHITEM_EMPTY(hi))
1990 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001991 // clear the def function index now
1992 fp = HI2UF(hi);
1993 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001994 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001995
Bram Moolenaare38eab22019-12-05 21:50:01 +01001996 // Only free functions that are not refcounted, those are
1997 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001998 if (func_name_refcount(fp->uf_name))
1999 ++skipped;
2000 else
2001 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002002 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002003 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002004 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002005 {
2006 skipped = 0;
2007 break;
2008 }
2009 }
2010 --todo;
2011 }
2012 }
2013
Bram Moolenaare38eab22019-12-05 21:50:01 +01002014 // Now actually free the functions. Need to start all over every time,
2015 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002016 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002017 while (func_hashtab.ht_used > skipped)
2018 {
2019 todo = func_hashtab.ht_used;
2020 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002021 if (!HASHITEM_EMPTY(hi))
2022 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002023 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002024 // Only free functions that are not refcounted, those are
2025 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002026 fp = HI2UF(hi);
2027 if (func_name_refcount(fp->uf_name))
2028 ++skipped;
2029 else
2030 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002031 if (func_free(fp, FALSE) == OK)
2032 {
2033 skipped = 0;
2034 break;
2035 }
2036 // did not actually free it
2037 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002038 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002040 }
2041 if (skipped == 0)
2042 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002043
2044 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002045}
2046#endif
2047
2048/*
2049 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002050 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002051 * "len" is the length of "name", or -1 for NUL terminated.
2052 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002054builtin_function(char_u *name, int len)
2055{
2056 char_u *p;
2057
Bram Moolenaara26b9702020-04-18 19:53:28 +02002058 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002059 return FALSE;
2060 p = vim_strchr(name, AUTOLOAD_CHAR);
2061 return p == NULL || (len > 0 && p > name + len);
2062}
2063
2064 int
2065func_call(
2066 char_u *name,
2067 typval_T *args,
2068 partial_T *partial,
2069 dict_T *selfdict,
2070 typval_T *rettv)
2071{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002072 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002073 listitem_T *item;
2074 typval_T argv[MAX_FUNC_ARGS + 1];
2075 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002076 int r = 0;
2077
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002078 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002079 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002080 {
2081 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2082 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002083 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002084 break;
2085 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002086 // Make a copy of each argument. This is needed to be able to set
2087 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002088 copy_tv(&item->li_tv, &argv[argc++]);
2089 }
2090
2091 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002092 {
2093 funcexe_T funcexe;
2094
Bram Moolenaara80faa82020-04-12 19:37:17 +02002095 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002096 funcexe.firstline = curwin->w_cursor.lnum;
2097 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002098 funcexe.evaluate = TRUE;
2099 funcexe.partial = partial;
2100 funcexe.selfdict = selfdict;
2101 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2102 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002103
Bram Moolenaare38eab22019-12-05 21:50:01 +01002104 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002105 while (argc > 0)
2106 clear_tv(&argv[--argc]);
2107
2108 return r;
2109}
2110
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002111static int callback_depth = 0;
2112
2113 int
2114get_callback_depth(void)
2115{
2116 return callback_depth;
2117}
2118
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002119/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002120 * Invoke call_func() with a callback.
2121 */
2122 int
2123call_callback(
2124 callback_T *callback,
2125 int len, // length of "name" or -1 to use strlen()
2126 typval_T *rettv, // return value goes here
2127 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002128 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002129 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002130{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002131 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002132 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002133
Bram Moolenaara80faa82020-04-12 19:37:17 +02002134 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002135 funcexe.evaluate = TRUE;
2136 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002137 ++callback_depth;
2138 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2139 --callback_depth;
2140 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002141}
2142
2143/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002144 * Give an error message for the result of a function.
2145 * Nothing if "error" is FCERR_NONE.
2146 */
2147 void
2148user_func_error(int error, char_u *name)
2149{
2150 switch (error)
2151 {
2152 case FCERR_UNKNOWN:
2153 emsg_funcname(e_unknownfunc, name);
2154 break;
2155 case FCERR_NOTMETHOD:
2156 emsg_funcname(
2157 N_("E276: Cannot use function as a method: %s"), name);
2158 break;
2159 case FCERR_DELETED:
2160 emsg_funcname(N_(e_func_deleted), name);
2161 break;
2162 case FCERR_TOOMANY:
2163 emsg_funcname((char *)e_toomanyarg, name);
2164 break;
2165 case FCERR_TOOFEW:
2166 emsg_funcname((char *)e_toofewarg, name);
2167 break;
2168 case FCERR_SCRIPT:
2169 emsg_funcname(
2170 N_("E120: Using <SID> not in a script context: %s"), name);
2171 break;
2172 case FCERR_DICT:
2173 emsg_funcname(
2174 N_("E725: Calling dict function without Dictionary: %s"),
2175 name);
2176 break;
2177 }
2178}
2179
2180/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002181 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002182 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 * Return FAIL when the function can't be called, OK otherwise.
2184 * Also returns OK when an error was encountered while executing the function.
2185 */
2186 int
2187call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002188 char_u *funcname, // name of the function
2189 int len, // length of "name" or -1 to use strlen()
2190 typval_T *rettv, // return value goes here
2191 int argcount_in, // number of "argvars"
2192 typval_T *argvars_in, // vars for arguments, must have "argcount"
2193 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002194 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195{
2196 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002197 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002199 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002200 char_u fname_buf[FLEN_FIXED + 1];
2201 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002202 char_u *fname = NULL;
2203 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 int argcount = argcount_in;
2205 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002206 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002207 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2208 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002210 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002211 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002213 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2214 // even when call_func() returns FAIL.
2215 rettv->v_type = VAR_UNKNOWN;
2216
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002217 if (partial != NULL)
2218 fp = partial->pt_func;
2219 if (fp == NULL)
2220 {
2221 // Make a copy of the name, if it comes from a funcref variable it
2222 // could be changed or deleted in the called function.
2223 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2224 if (name == NULL)
2225 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002227 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2228 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002230 if (funcexe->doesrange != NULL)
2231 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232
2233 if (partial != NULL)
2234 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002235 // When the function has a partial with a dict and there is a dict
2236 // argument, use the dict argument. That is backwards compatible.
2237 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002238 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002239 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002240 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 {
2242 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002243 {
2244 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2245 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002246 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002247 goto theend;
2248 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002249 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002250 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002251 for (i = 0; i < argcount_in; ++i)
2252 argv[i + argv_clear] = argvars_in[i];
2253 argvars = argv;
2254 argcount = partial->pt_argc + argcount_in;
2255 }
2256 }
2257
Bram Moolenaaref140542019-12-31 21:27:13 +01002258 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002259 {
2260 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002261 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002262
Bram Moolenaar333894b2020-08-01 18:53:07 +02002263 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002264 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002265 {
2266 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002267 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002268 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269
Bram Moolenaare38eab22019-12-05 21:50:01 +01002270 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002271 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002272 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002273
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002274 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002275 {
2276 /*
2277 * User defined function.
2278 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002279 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002280 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002281
Bram Moolenaare38eab22019-12-05 21:50:01 +01002282 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283 if (fp == NULL
2284 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002285 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 && !aborting())
2287 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002288 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002289 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002291 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002292 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2293 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002294 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002295 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002296 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002297 if (fp == NULL)
2298 {
2299 char_u *p = untrans_function_name(rfname);
2300
2301 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002302 // Don't do this if the name starts with "s:".
2303 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002304 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002305 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002307 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002308 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002309#ifdef FEAT_LUA
2310 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2311 {
2312 cfunc_T cb = fp->uf_cb;
2313
2314 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2315 }
2316#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002317 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002318 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002319 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002320 // postponed filling in the arguments, do it now
2321 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002322 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002323
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002324 if (funcexe->basetv != NULL)
2325 {
2326 // Method call: base->Method()
2327 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2328 argv[0] = *funcexe->basetv;
2329 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002330 argvars = argv;
2331 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002332 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002333
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334 error = call_user_func_check(fp, argcount, argvars, rettv,
2335 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 }
2337 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002338 else if (funcexe->basetv != NULL)
2339 {
2340 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002341 * expr->method(): Find the method name in the table, call its
2342 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002343 */
2344 error = call_internal_method(fname, argcount, argvars, rettv,
2345 funcexe->basetv);
2346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 else
2348 {
2349 /*
2350 * Find the function name in the table, call its implementation.
2351 */
2352 error = call_internal_func(fname, argcount, argvars, rettv);
2353 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002354
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 /*
2356 * The function call (or "FuncUndefined" autocommand sequence) might
2357 * have been aborted by an error, an interrupt, or an explicitly thrown
2358 * exception that has not been caught so far. This situation can be
2359 * tested for by calling aborting(). For an error in an internal
2360 * function or for the "E132" error in call_user_func(), however, the
2361 * throw point at which the "force_abort" flag (temporarily reset by
2362 * emsg()) is normally updated has not been reached yet. We need to
2363 * update that flag first to make aborting() reliable.
2364 */
2365 update_force_abort();
2366 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002367 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002368 ret = OK;
2369
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002370theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 /*
2372 * Report an error unless the argument evaluation or function call has been
2373 * cancelled due to an aborting error, an interrupt, or an exception.
2374 */
2375 if (!aborting())
2376 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002377 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378 }
2379
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002380 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002382 clear_tv(&argv[--argv_clear + argv_base]);
2383
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384 vim_free(tofree);
2385 vim_free(name);
2386
2387 return ret;
2388}
2389
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002390 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002391printable_func_name(ufunc_T *fp)
2392{
2393 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2394}
2395
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002397 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 */
2399 static void
2400list_func_head(ufunc_T *fp, int indent)
2401{
2402 int j;
2403
2404 msg_start();
2405 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002406 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002407 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002408 msg_puts("def ");
2409 else
2410 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002411 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 msg_putchar('(');
2413 for (j = 0; j < fp->uf_args.ga_len; ++j)
2414 {
2415 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002416 msg_puts(", ");
2417 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002418 if (fp->uf_arg_types != NULL)
2419 {
2420 char *tofree;
2421
2422 msg_puts(": ");
2423 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2424 vim_free(tofree);
2425 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002426 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2427 {
2428 msg_puts(" = ");
2429 msg_puts(((char **)(fp->uf_def_args.ga_data))
2430 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432 }
2433 if (fp->uf_varargs)
2434 {
2435 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002436 msg_puts(", ");
2437 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002439 if (fp->uf_va_name != NULL)
2440 {
2441 if (j)
2442 msg_puts(", ");
2443 msg_puts("...");
2444 msg_puts((char *)fp->uf_va_name);
2445 if (fp->uf_va_type)
2446 {
2447 char *tofree;
2448
2449 msg_puts(": ");
2450 msg_puts(type_name(fp->uf_va_type, &tofree));
2451 vim_free(tofree);
2452 }
2453 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002455
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002456 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002457 {
2458 if (fp->uf_ret_type != &t_void)
2459 {
2460 char *tofree;
2461
2462 msg_puts(": ");
2463 msg_puts(type_name(fp->uf_ret_type, &tofree));
2464 vim_free(tofree);
2465 }
2466 }
2467 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002468 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002470 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002472 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002473 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002474 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 msg_clr_eos();
2476 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002477 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002478}
2479
2480/*
2481 * Get a function name, translating "<SID>" and "<SNR>".
2482 * Also handles a Funcref in a List or Dictionary.
2483 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002484 * Set "*is_global" to TRUE when the function must be global, unless
2485 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486 * flags:
2487 * TFN_INT: internal function name OK
2488 * TFN_QUIET: be quiet
2489 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002490 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 * Advances "pp" to just after the function name (if no error).
2492 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002493 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494trans_function_name(
2495 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002496 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002497 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002499 funcdict_T *fdp, // return: info about dictionary used
2500 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501{
2502 char_u *name = NULL;
2503 char_u *start;
2504 char_u *end;
2505 int lead;
2506 char_u sid_buf[20];
2507 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002508 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002511 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512
2513 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002514 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515 start = *pp;
2516
Bram Moolenaare38eab22019-12-05 21:50:01 +01002517 // Check for hard coded <SNR>: already translated function ID (from a user
2518 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002519 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2520 && (*pp)[2] == (int)KE_SNR)
2521 {
2522 *pp += 3;
2523 len = get_id_len(pp) + 3;
2524 return vim_strnsave(start, len);
2525 }
2526
Bram Moolenaare38eab22019-12-05 21:50:01 +01002527 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2528 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 lead = eval_fname_script(start);
2530 if (lead > 2)
2531 start += lead;
2532
Bram Moolenaare38eab22019-12-05 21:50:01 +01002533 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002534 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 lead > 2 ? 0 : FNE_CHECK_START);
2536 if (end == start)
2537 {
2538 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002539 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 goto theend;
2541 }
2542 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2543 {
2544 /*
2545 * Report an invalid expression in braces, unless the expression
2546 * evaluation has been cancelled due to an aborting error, an
2547 * interrupt, or an exception.
2548 */
2549 if (!aborting())
2550 {
2551 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002552 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 }
2554 else
2555 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2556 goto theend;
2557 }
2558
2559 if (lv.ll_tv != NULL)
2560 {
2561 if (fdp != NULL)
2562 {
2563 fdp->fd_dict = lv.ll_dict;
2564 fdp->fd_newkey = lv.ll_newkey;
2565 lv.ll_newkey = NULL;
2566 fdp->fd_di = lv.ll_di;
2567 }
2568 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2569 {
2570 name = vim_strsave(lv.ll_tv->vval.v_string);
2571 *pp = end;
2572 }
2573 else if (lv.ll_tv->v_type == VAR_PARTIAL
2574 && lv.ll_tv->vval.v_partial != NULL)
2575 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002576 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002577 *pp = end;
2578 if (partial != NULL)
2579 *partial = lv.ll_tv->vval.v_partial;
2580 }
2581 else
2582 {
2583 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2584 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002585 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586 else
2587 *pp = end;
2588 name = NULL;
2589 }
2590 goto theend;
2591 }
2592
2593 if (lv.ll_name == NULL)
2594 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002595 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002596 *pp = end;
2597 goto theend;
2598 }
2599
Bram Moolenaare38eab22019-12-05 21:50:01 +01002600 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 if (lv.ll_exp_name != NULL)
2602 {
2603 len = (int)STRLEN(lv.ll_exp_name);
2604 name = deref_func_name(lv.ll_exp_name, &len, partial,
2605 flags & TFN_NO_AUTOLOAD);
2606 if (name == lv.ll_exp_name)
2607 name = NULL;
2608 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002609 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 {
2611 len = (int)(end - *pp);
2612 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2613 if (name == *pp)
2614 name = NULL;
2615 }
2616 if (name != NULL)
2617 {
2618 name = vim_strsave(name);
2619 *pp = end;
2620 if (STRNCMP(name, "<SNR>", 5) == 0)
2621 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002622 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 name[0] = K_SPECIAL;
2624 name[1] = KS_EXTRA;
2625 name[2] = (int)KE_SNR;
2626 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2627 }
2628 goto theend;
2629 }
2630
2631 if (lv.ll_exp_name != NULL)
2632 {
2633 len = (int)STRLEN(lv.ll_exp_name);
2634 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2635 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2636 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002637 // When there was "s:" already or the name expanded to get a
2638 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 lv.ll_name += 2;
2640 len -= 2;
2641 lead = 2;
2642 }
2643 }
2644 else
2645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002648 {
2649 if (is_global != NULL && lv.ll_name[0] == 'g')
2650 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002652 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653 len = (int)(end - lv.ll_name);
2654 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002655 if (len <= 0)
2656 {
2657 if (!skip)
2658 emsg(_(e_function_name));
2659 goto theend;
2660 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002662 // In Vim9 script a user function is script-local by default, unless it
2663 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002664 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002665 if (vim9script)
2666 {
2667 char_u *p;
2668
2669 // SomeScript#func() is a global function.
2670 for (p = start; *p != NUL && *p != '('; ++p)
2671 if (*p == AUTOLOAD_CHAR)
2672 vim9script = FALSE;
2673 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002674
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 /*
2676 * Copy the function name to allocated memory.
2677 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2678 * Accept <SNR>123_name() outside a script.
2679 */
2680 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002681 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002682 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002684 if (!vim9script)
2685 lead = 3;
2686 if (vim9script || (lv.ll_exp_name != NULL
2687 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688 || eval_fname_sid(*pp))
2689 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002690 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002691 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002693 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694 goto theend;
2695 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002696 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002697 if (vim9script)
2698 extra = 3 + (int)STRLEN(sid_buf);
2699 else
2700 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 }
2702 }
2703 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2704 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002705 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 start);
2707 goto theend;
2708 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002709 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 {
2711 char_u *cp = vim_strchr(lv.ll_name, ':');
2712
2713 if (cp != NULL && cp < end)
2714 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002715 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 goto theend;
2717 }
2718 }
2719
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002720 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 if (name != NULL)
2722 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002723 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 {
2725 name[0] = K_SPECIAL;
2726 name[1] = KS_EXTRA;
2727 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002728 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002729 STRCPY(name + 3, sid_buf);
2730 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002731 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2732 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 }
2734 *pp = end;
2735
2736theend:
2737 clear_lval(&lv);
2738 return name;
2739}
2740
2741/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002742 * Assuming "name" is the result of trans_function_name() and it was prefixed
2743 * to use the script-local name, return the unmodified name (points into
2744 * "name"). Otherwise return NULL.
2745 * This can be used to first search for a script-local function and fall back
2746 * to the global function if not found.
2747 */
2748 char_u *
2749untrans_function_name(char_u *name)
2750{
2751 char_u *p;
2752
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002753 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002754 {
2755 p = vim_strchr(name, '_');
2756 if (p != NULL)
2757 return p + 1;
2758 }
2759 return NULL;
2760}
2761
2762/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002763 * List functions. When "regmatch" is NULL all of then.
2764 * Otherwise functions matching "regmatch".
2765 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002766 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002767list_functions(regmatch_T *regmatch)
2768{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002769 int changed = func_hashtab.ht_changed;
2770 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002771 hashitem_T *hi;
2772
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002773 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002774 {
2775 if (!HASHITEM_EMPTY(hi))
2776 {
2777 ufunc_T *fp = HI2UF(hi);
2778
2779 --todo;
2780 if ((fp->uf_flags & FC_DEAD) == 0
2781 && (regmatch == NULL
2782 ? !message_filtered(fp->uf_name)
2783 && !func_name_refcount(fp->uf_name)
2784 : !isdigit(*fp->uf_name)
2785 && vim_regexec(regmatch, fp->uf_name, 0)))
2786 {
2787 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002788 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002789 {
2790 emsg(_("E454: function list was modified"));
2791 return;
2792 }
2793 }
2794 }
2795 }
2796}
2797
2798/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002799 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002800 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2801 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002802 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002804 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002805define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806{
2807 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002808 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 int j;
2810 int c;
2811 int saved_did_emsg;
2812 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002813 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002814 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 char_u *p;
2816 char_u *arg;
2817 char_u *line_arg = NULL;
2818 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002819 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002820 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 garray_T newlines;
2822 int varargs = FALSE;
2823 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002824 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002825 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002826 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 int indent;
2828 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002829#define MAX_FUNC_NESTING 50
2830 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831 dictitem_T *v;
2832 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002833 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002836 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002837 linenr_T sourcing_lnum_off;
2838 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002839 int is_heredoc = FALSE;
2840 char_u *skip_until = NULL;
2841 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002842 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002843 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844
2845 /*
2846 * ":function" without argument: list functions.
2847 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002848 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 {
2850 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002851 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002853 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002854 }
2855
2856 /*
2857 * ":function /pat": list functions matching pattern.
2858 */
2859 if (*eap->arg == '/')
2860 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002861 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 if (!eap->skip)
2863 {
2864 regmatch_T regmatch;
2865
2866 c = *p;
2867 *p = NUL;
2868 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2869 *p = c;
2870 if (regmatch.regprog != NULL)
2871 {
2872 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002873 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 vim_regfree(regmatch.regprog);
2875 }
2876 }
2877 if (*p == '/')
2878 ++p;
2879 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002880 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881 }
2882
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002883 ga_init(&newargs);
2884 ga_init(&argtypes);
2885 ga_init(&default_args);
2886
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 /*
2888 * Get the function name. There are these situations:
2889 * func normal function name
2890 * "name" == func, "fudi.fd_dict" == NULL
2891 * dict.func new dictionary entry
2892 * "name" == NULL, "fudi.fd_dict" set,
2893 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2894 * dict.func existing dict entry with a Funcref
2895 * "name" == func, "fudi.fd_dict" set,
2896 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2897 * dict.func existing dict entry that's not a Funcref
2898 * "name" == NULL, "fudi.fd_dict" set,
2899 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2900 * s:func script-local function name
2901 * g:func global function name, same as "func"
2902 */
2903 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002904 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002906 // nested function, argument is (args).
2907 paren = TRUE;
2908 CLEAR_FIELD(fudi);
2909 }
2910 else
2911 {
2912 name = trans_function_name(&p, &is_global, eap->skip,
2913 TFN_NO_AUTOLOAD, &fudi, NULL);
2914 paren = (vim_strchr(p, '(') != NULL);
2915 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002916 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002917 /*
2918 * Return on an invalid expression in braces, unless the expression
2919 * evaluation has been cancelled due to an aborting error, an
2920 * interrupt, or an exception.
2921 */
2922 if (!aborting())
2923 {
2924 if (!eap->skip && fudi.fd_newkey != NULL)
2925 semsg(_(e_dictkey), fudi.fd_newkey);
2926 vim_free(fudi.fd_newkey);
2927 return NULL;
2928 }
2929 else
2930 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002931 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 }
2933
Bram Moolenaare38eab22019-12-05 21:50:01 +01002934 // An error in a function call during evaluation of an expression in magic
2935 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 saved_did_emsg = did_emsg;
2937 did_emsg = FALSE;
2938
2939 /*
2940 * ":function func" with only function name: list function.
2941 */
2942 if (!paren)
2943 {
2944 if (!ends_excmd(*skipwhite(p)))
2945 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002946 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002947 goto ret_free;
2948 }
2949 eap->nextcmd = check_nextcmd(p);
2950 if (eap->nextcmd != NULL)
2951 *p = NUL;
2952 if (!eap->skip && !got_int)
2953 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002954 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002955 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2956 {
2957 char_u *up = untrans_function_name(name);
2958
2959 // With Vim9 script the name was made script-local, if not
2960 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002961 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002962 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002963 }
2964
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 if (fp != NULL)
2966 {
2967 list_func_head(fp, TRUE);
2968 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2969 {
2970 if (FUNCLINE(fp, j) == NULL)
2971 continue;
2972 msg_putchar('\n');
2973 msg_outnum((long)(j + 1));
2974 if (j < 9)
2975 msg_putchar(' ');
2976 if (j < 99)
2977 msg_putchar(' ');
2978 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002979 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980 ui_breakcheck();
2981 }
2982 if (!got_int)
2983 {
2984 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002985 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002986 msg_puts(" enddef");
2987 else
2988 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 }
2990 }
2991 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002992 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993 }
2994 goto ret_free;
2995 }
2996
2997 /*
2998 * ":function name(arg1, arg2)" Define function.
2999 */
3000 p = skipwhite(p);
3001 if (*p != '(')
3002 {
3003 if (!eap->skip)
3004 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003005 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 goto ret_free;
3007 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003008 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009 if (vim_strchr(p, '(') != NULL)
3010 p = vim_strchr(p, '(');
3011 }
3012 p = skipwhite(p + 1);
3013
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003014 // In Vim9 script only global functions can be redefined.
3015 if (vim9script && eap->forceit && !is_global)
3016 {
3017 emsg(_(e_nobang));
3018 goto ret_free;
3019 }
3020
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3022
Bram Moolenaar04b12692020-05-04 23:24:44 +02003023 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003025 // Check the name of the function. Unless it's a dictionary function
3026 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027 if (name != NULL)
3028 arg = name;
3029 else
3030 arg = fudi.fd_newkey;
3031 if (arg != NULL && (fudi.fd_di == NULL
3032 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3033 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3034 {
3035 if (*arg == K_SPECIAL)
3036 j = 3;
3037 else
3038 j = 0;
3039 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3040 : eval_isnamec(arg[j])))
3041 ++j;
3042 if (arg[j] != NUL)
3043 emsg_funcname((char *)e_invarg2, arg);
3044 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003045 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003047 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048 }
3049
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003050 // This may get more lines and make the pointers into the first line
3051 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003052 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003053 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003054 &varargs, &default_args, eap->skip,
3055 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056 goto errret_2;
3057
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003058 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003060 // find the return type: :def Func(): type
3061 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003063 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003064 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003065 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003066 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003067 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003068 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003069 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003070 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003071 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003072 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003073 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003074 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003075 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003076 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003078 else
3079 // find extra arguments "range", "dict", "abort" and "closure"
3080 for (;;)
3081 {
3082 p = skipwhite(p);
3083 if (STRNCMP(p, "range", 5) == 0)
3084 {
3085 flags |= FC_RANGE;
3086 p += 5;
3087 }
3088 else if (STRNCMP(p, "dict", 4) == 0)
3089 {
3090 flags |= FC_DICT;
3091 p += 4;
3092 }
3093 else if (STRNCMP(p, "abort", 5) == 0)
3094 {
3095 flags |= FC_ABORT;
3096 p += 5;
3097 }
3098 else if (STRNCMP(p, "closure", 7) == 0)
3099 {
3100 flags |= FC_CLOSURE;
3101 p += 7;
3102 if (current_funccal == NULL)
3103 {
3104 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3105 name == NULL ? (char_u *)"" : name);
3106 goto erret;
3107 }
3108 }
3109 else
3110 break;
3111 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112
Bram Moolenaare38eab22019-12-05 21:50:01 +01003113 // When there is a line break use what follows for the function body.
3114 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 if (*p == '\n')
3116 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003117 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003118 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3119 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003120 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3121 && !eap->skip
3122 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003123 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124
3125 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003126 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3127 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 */
3129 if (KeyTyped)
3130 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003131 // Check if the function already exists, don't let the user type the
3132 // whole function before telling him it doesn't work! For a script we
3133 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 if (!eap->skip && !eap->forceit)
3135 {
3136 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003137 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003138 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 emsg_funcname(e_funcexts, name);
3140 }
3141
3142 if (!eap->skip && did_emsg)
3143 goto erret;
3144
Bram Moolenaare38eab22019-12-05 21:50:01 +01003145 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146 cmdline_row = msg_row;
3147 }
3148
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003149 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003150 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003151
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003152 // Detect having skipped over comment lines to find the return
3153 // type. Add NULL lines to keep the line count correct.
3154 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3155 if (SOURCING_LNUM < sourcing_lnum_off)
3156 {
3157 sourcing_lnum_off -= SOURCING_LNUM;
3158 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3159 goto erret;
3160 while (sourcing_lnum_off-- > 0)
3161 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3162 }
3163
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 indent = 2;
3165 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003166 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 for (;;)
3168 {
3169 if (KeyTyped)
3170 {
3171 msg_scroll = TRUE;
3172 saved_wait_return = FALSE;
3173 }
3174 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175
3176 if (line_arg != NULL)
3177 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003178 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179 theline = line_arg;
3180 p = vim_strchr(theline, '\n');
3181 if (p == NULL)
3182 line_arg += STRLEN(line_arg);
3183 else
3184 {
3185 *p = NUL;
3186 line_arg = p + 1;
3187 }
3188 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003189 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003190 {
3191 vim_free(line_to_free);
3192 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003193 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003194 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003195 theline = eap->getline(':', eap->cookie, indent,
3196 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003197 line_to_free = theline;
3198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199 if (KeyTyped)
3200 lines_left = Rows - 1;
3201 if (theline == NULL)
3202 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003203 if (skip_until != NULL)
3204 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3205 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003206 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003207 else
3208 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 goto erret;
3210 }
3211
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003212 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003213 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003214 if (SOURCING_LNUM < sourcing_lnum_off)
3215 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 else
3217 sourcing_lnum_off = 0;
3218
3219 if (skip_until != NULL)
3220 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003221 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003222 // * ":append" and "."
3223 // * ":python <<EOF" and "EOF"
3224 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3225 if (heredoc_trimmed == NULL
3226 || (is_heredoc && skipwhite(theline) == theline)
3227 || STRNCMP(theline, heredoc_trimmed,
3228 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003229 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003230 if (heredoc_trimmed == NULL)
3231 p = theline;
3232 else if (is_heredoc)
3233 p = skipwhite(theline) == theline
3234 ? theline : theline + STRLEN(heredoc_trimmed);
3235 else
3236 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003237 if (STRCMP(p, skip_until) == 0)
3238 {
3239 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003240 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003241 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003242 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003243 }
3244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 }
3246 else
3247 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003248 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003249 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 ;
3251
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003252 // Check for "endfunction" or "enddef".
3253 if (checkforcmd(&p, nesting_def[nesting]
3254 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003256 char_u *nextcmd = NULL;
3257
Bram Moolenaar663bb232017-06-22 19:12:10 +02003258 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003259 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003260 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003261 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003262 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003263 give_warning2(eap->cmdidx == CMD_def
3264 ? (char_u *)_("W1001: Text found after :enddef: %s")
3265 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003266 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003267 if (nextcmd != NULL)
3268 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003269 // Another command follows. If the line came from "eap" we
3270 // can simply point into it, otherwise we need to change
3271 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003272 eap->nextcmd = nextcmd;
3273 if (line_to_free != NULL)
3274 {
3275 vim_free(*eap->cmdlinep);
3276 *eap->cmdlinep = line_to_free;
3277 line_to_free = NULL;
3278 }
3279 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 break;
3281 }
3282
Bram Moolenaare38eab22019-12-05 21:50:01 +01003283 // Increase indent inside "if", "while", "for" and "try", decrease
3284 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 indent -= 2;
3287 else if (STRNCMP(p, "if", 2) == 0
3288 || STRNCMP(p, "wh", 2) == 0
3289 || STRNCMP(p, "for", 3) == 0
3290 || STRNCMP(p, "try", 3) == 0)
3291 indent += 2;
3292
Bram Moolenaare38eab22019-12-05 21:50:01 +01003293 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003294 // Only recognize "def" inside "def", not inside "function",
3295 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003296 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003297 if (checkforcmd(&p, "function", 2)
3298 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 {
3300 if (*p == '!')
3301 p = skipwhite(p + 1);
3302 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003303 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 if (*skipwhite(p) == '(')
3305 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003307 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003308 else
3309 {
3310 ++nesting;
3311 nesting_def[nesting] = (c == 'd');
3312 indent += 2;
3313 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314 }
3315 }
3316
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003317 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003318 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003319 if (eap->cmdidx != CMD_def
3320 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003321 || (p[0] == 'c'
3322 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3323 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3324 && (STRNCMP(&p[3], "nge", 3) != 0
3325 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003326 || (p[0] == 'i'
3327 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003328 && (!ASCII_ISALPHA(p[2])
3329 || (p[2] == 's'
3330 && (!ASCII_ISALPHA(p[3])
3331 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 skip_until = vim_strsave((char_u *)".");
3333
Bram Moolenaare38eab22019-12-05 21:50:01 +01003334 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 arg = skipwhite(skiptowhite(p));
3336 if (arg[0] == '<' && arg[1] =='<'
3337 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003338 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3339 || ((p[2] == '3' || p[2] == 'x')
3340 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 || (p[0] == 'p' && p[1] == 'e'
3342 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3343 || (p[0] == 't' && p[1] == 'c'
3344 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3345 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3346 && !ASCII_ISALPHA(p[3]))
3347 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3348 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3349 || (p[0] == 'm' && p[1] == 'z'
3350 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3351 ))
3352 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003355 if (STRNCMP(p, "trim", 4) == 0)
3356 {
3357 // Ignore leading white space.
3358 p = skipwhite(p + 4);
3359 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003360 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 if (*p == NUL)
3363 skip_until = vim_strsave((char_u *)".");
3364 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003365 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003366 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003367 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003369
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003370 // Check for ":cmd v =<< [trim] EOF"
3371 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003372 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003373 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003374 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003375 if (*arg == '[')
3376 arg = vim_strchr(arg, ']');
3377 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003378 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003379 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3380 && arg[1] == '<' && arg[2] =='<');
3381
3382 if (!found)
3383 // skip over the argument after "cmd"
3384 arg = skipwhite(skiptowhite(arg));
3385 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003386 && (checkforcmd(&p, "let", 2)
3387 || checkforcmd(&p, "var", 3)
3388 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003389 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003390 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003391 p = skipwhite(arg + 3);
3392 if (STRNCMP(p, "trim", 4) == 0)
3393 {
3394 // Ignore leading white space.
3395 p = skipwhite(p + 4);
3396 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003397 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003398 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003399 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003400 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003401 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003402 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 }
3405
Bram Moolenaare38eab22019-12-05 21:50:01 +01003406 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409
Bram Moolenaare38eab22019-12-05 21:50:01 +01003410 // Copy the line to newly allocated memory. get_one_sourceline()
3411 // allocates 250 bytes per line, this saves 80% on average. The cost
3412 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003414 if (p == NULL)
3415 goto erret;
3416 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417
Bram Moolenaare38eab22019-12-05 21:50:01 +01003418 // Add NULL lines for continuation lines, so that the line count is
3419 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 while (sourcing_lnum_off-- > 0)
3421 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3422
Bram Moolenaare38eab22019-12-05 21:50:01 +01003423 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 if (line_arg != NULL && *line_arg == NUL)
3425 line_arg = NULL;
3426 }
3427
Bram Moolenaare38eab22019-12-05 21:50:01 +01003428 // Don't define the function when skipping commands or when an error was
3429 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430 if (eap->skip || did_emsg)
3431 goto erret;
3432
3433 /*
3434 * If there are no errors, add the function
3435 */
3436 if (fudi.fd_dict == NULL)
3437 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003438 hashtab_T *ht;
3439
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 v = find_var(name, &ht, FALSE);
3441 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3442 {
3443 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3444 name);
3445 goto erret;
3446 }
3447
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003448 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003449 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003451 char_u *uname = untrans_function_name(name);
3452
3453 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3454 }
3455
3456 if (fp != NULL || import != NULL)
3457 {
3458 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003460 // Function can be replaced with "function!" and when sourcing the
3461 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003462 // A name that is used by an import can not be overruled.
3463 if (import != NULL
3464 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003465 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003466 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003468 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003469 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003470 else
3471 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 goto erret;
3473 }
3474 if (fp->uf_calls > 0)
3475 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003476 emsg_funcname(
3477 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 name);
3479 goto erret;
3480 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003481 if (fp->uf_refcount > 1)
3482 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003483 // This function is referenced somewhere, don't redefine it but
3484 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003485 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003486 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003487 fp = NULL;
3488 overwrite = TRUE;
3489 }
3490 else
3491 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003492 char_u *exp_name = fp->uf_name_exp;
3493
3494 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003495 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003496 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003497 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003498 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003499 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003500#ifdef FEAT_PROFILE
3501 fp->uf_profiling = FALSE;
3502 fp->uf_prof_initialized = FALSE;
3503#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003504 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003506 }
3507 }
3508 else
3509 {
3510 char numbuf[20];
3511
3512 fp = NULL;
3513 if (fudi.fd_newkey == NULL && !eap->forceit)
3514 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003515 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 goto erret;
3517 }
3518 if (fudi.fd_di == NULL)
3519 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003520 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003521 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003522 goto erret;
3523 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003524 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003525 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 goto erret;
3527
Bram Moolenaare38eab22019-12-05 21:50:01 +01003528 // Give the function a sequential number. Can only be used with a
3529 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 vim_free(name);
3531 sprintf(numbuf, "%d", ++func_nr);
3532 name = vim_strsave((char_u *)numbuf);
3533 if (name == NULL)
3534 goto erret;
3535 }
3536
3537 if (fp == NULL)
3538 {
3539 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3540 {
3541 int slen, plen;
3542 char_u *scriptname;
3543
Bram Moolenaare38eab22019-12-05 21:50:01 +01003544 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003546 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 {
3548 scriptname = autoload_name(name);
3549 if (scriptname != NULL)
3550 {
3551 p = vim_strchr(scriptname, '/');
3552 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003553 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003555 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 j = OK;
3557 vim_free(scriptname);
3558 }
3559 }
3560 if (j == FAIL)
3561 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003562 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 goto erret;
3564 }
3565 }
3566
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003567 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 if (fp == NULL)
3569 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003570 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003571 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572
3573 if (fudi.fd_dict != NULL)
3574 {
3575 if (fudi.fd_di == NULL)
3576 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003577 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3579 if (fudi.fd_di == NULL)
3580 {
3581 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003582 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 goto erret;
3584 }
3585 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3586 {
3587 vim_free(fudi.fd_di);
3588 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003589 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 goto erret;
3591 }
3592 }
3593 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003594 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 clear_tv(&fudi.fd_di->di_tv);
3596 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598
Bram Moolenaare38eab22019-12-05 21:50:01 +01003599 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600 flags |= FC_DICT;
3601 }
3602
Bram Moolenaare38eab22019-12-05 21:50:01 +01003603 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003604 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003605 if (overwrite)
3606 {
3607 hi = hash_find(&func_hashtab, name);
3608 hi->hi_key = UF2HIKEY(fp);
3609 }
3610 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 {
3612 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003613 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 goto erret;
3615 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003616 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 }
3618 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003619 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003620 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003621 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003622
3623 if (eap->cmdidx == CMD_def)
3624 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003625 int lnum_save = SOURCING_LNUM;
3626 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003627
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003628 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003629
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003630 // error messages are for the first function line
3631 SOURCING_LNUM = sourcing_lnum_top;
3632
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003633 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003634 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003635 int count = cstack->cs_idx + 1;
3636 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003637
3638 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003639 // a block that is visible now but not when the function is called
3640 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003641 fp->uf_block_ids = ALLOC_MULT(int, count);
3642 if (fp->uf_block_ids != NULL)
3643 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003644 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003645 sizeof(int) * count);
3646 fp->uf_block_depth = count;
3647 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003648
3649 // Set flag in each block to indicate a function was defined. This
3650 // is used to keep the variable when leaving the block, see
3651 // hide_script_var().
3652 for (i = 0; i <= cstack->cs_idx; ++i)
3653 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003654 }
3655
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003656 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003657 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003658 SOURCING_LNUM = lnum_save;
3659 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003660 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003661 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003662
3663 // parse the return type, if any
3664 if (ret_type == NULL)
3665 fp->uf_ret_type = &t_void;
3666 else
3667 {
3668 p = ret_type;
3669 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3670 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003671 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003672 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003673 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003674 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003675
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003677 if ((flags & FC_CLOSURE) != 0)
3678 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003679 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003680 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003681 }
3682 else
3683 fp->uf_scoped = NULL;
3684
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686 if (prof_def_func())
3687 func_do_profile(fp);
3688#endif
3689 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003690 if (sandbox)
3691 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003692 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003693 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 fp->uf_flags = flags;
3695 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003696 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003697 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003698 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003699 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003700 if (is_export)
3701 {
3702 fp->uf_flags |= FC_EXPORT;
3703 // let ex_export() know the export worked.
3704 is_export = FALSE;
3705 }
3706
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003707 if (eap->cmdidx == CMD_def)
3708 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003709 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3710 // :func does not use Vim9 script syntax, even in a Vim9 script file
3711 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 goto ret_free;
3714
3715erret:
3716 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003717 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718errret_2:
3719 ga_clear_strings(&newlines);
3720ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003721 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003723 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003724 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003726 if (name != name_arg)
3727 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003728 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 did_emsg |= saved_did_emsg;
3730 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003731
3732 return fp;
3733}
3734
3735/*
3736 * ":function"
3737 */
3738 void
3739ex_function(exarg_T *eap)
3740{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003741 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003742}
3743
3744/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003745 * :defcompile - compile all :def functions in the current script that need to
3746 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003747 */
3748 void
3749ex_defcompile(exarg_T *eap UNUSED)
3750{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003751 long todo = (long)func_hashtab.ht_used;
3752 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003753 hashitem_T *hi;
3754 ufunc_T *ufunc;
3755
3756 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3757 {
3758 if (!HASHITEM_EMPTY(hi))
3759 {
3760 --todo;
3761 ufunc = HI2UF(hi);
3762 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003763 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3764 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003765 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003766 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003767
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003768 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003769 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003770 // a function has been added or removed, need to start over
3771 todo = (long)func_hashtab.ht_used;
3772 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003773 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003774 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003775 }
3776 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003777 }
3778 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779}
3780
3781/*
3782 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3783 * Return 2 if "p" starts with "s:".
3784 * Return 0 otherwise.
3785 */
3786 int
3787eval_fname_script(char_u *p)
3788{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003789 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3790 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3792 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3793 return 5;
3794 if (p[0] == 's' && p[1] == ':')
3795 return 2;
3796 return 0;
3797}
3798
3799 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003800translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801{
3802 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003803 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003804 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003805}
3806
3807/*
3808 * Return TRUE when "ufunc" has old-style "..." varargs
3809 * or named varargs "...name: type".
3810 */
3811 int
3812has_varargs(ufunc_T *ufunc)
3813{
3814 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815}
3816
3817/*
3818 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003819 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 */
3821 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003822function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823{
3824 char_u *nm = name;
3825 char_u *p;
3826 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003827 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003828 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003830 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3831 if (no_deref)
3832 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003833 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834 nm = skipwhite(nm);
3835
Bram Moolenaare38eab22019-12-05 21:50:01 +01003836 // Only accept "funcname", "funcname ", "funcname (..." and
3837 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003839 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 vim_free(p);
3841 return n;
3842}
3843
Bram Moolenaar113e1072019-01-20 15:30:40 +01003844#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845 char_u *
3846get_expanded_name(char_u *name, int check)
3847{
3848 char_u *nm = name;
3849 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003850 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003851
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003852 p = trans_function_name(&nm, &is_global, FALSE,
3853 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003855 if (p != NULL && *nm == NUL
3856 && (!check || translated_function_exists(p, is_global)))
3857 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858
3859 vim_free(p);
3860 return NULL;
3861}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003862#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864/*
3865 * Function given to ExpandGeneric() to obtain the list of user defined
3866 * function names.
3867 */
3868 char_u *
3869get_user_func_name(expand_T *xp, int idx)
3870{
3871 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003872 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 static hashitem_T *hi;
3874 ufunc_T *fp;
3875
3876 if (idx == 0)
3877 {
3878 done = 0;
3879 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003880 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003882 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883 {
3884 if (done++ > 0)
3885 ++hi;
3886 while (HASHITEM_EMPTY(hi))
3887 ++hi;
3888 fp = HI2UF(hi);
3889
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003890 // don't show dead, dict and lambda functions
3891 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003892 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003893 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894
3895 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003896 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897
3898 cat_func_name(IObuff, fp);
3899 if (xp->xp_context != EXPAND_USER_FUNC)
3900 {
3901 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003902 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003903 STRCAT(IObuff, ")");
3904 }
3905 return IObuff;
3906 }
3907 return NULL;
3908}
3909
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910/*
3911 * ":delfunction {name}"
3912 */
3913 void
3914ex_delfunction(exarg_T *eap)
3915{
3916 ufunc_T *fp = NULL;
3917 char_u *p;
3918 char_u *name;
3919 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003920 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921
3922 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003923 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924 vim_free(fudi.fd_newkey);
3925 if (name == NULL)
3926 {
3927 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003928 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929 return;
3930 }
3931 if (!ends_excmd(*skipwhite(p)))
3932 {
3933 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003934 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 return;
3936 }
3937 eap->nextcmd = check_nextcmd(p);
3938 if (eap->nextcmd != NULL)
3939 *p = NUL;
3940
3941 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003942 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 vim_free(name);
3944
3945 if (!eap->skip)
3946 {
3947 if (fp == NULL)
3948 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003949 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003950 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951 return;
3952 }
3953 if (fp->uf_calls > 0)
3954 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003955 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003956 return;
3957 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003958 if (fp->uf_flags & FC_VIM9)
3959 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003960 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003961 return;
3962 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963
3964 if (fudi.fd_dict != NULL)
3965 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003966 // Delete the dict item that refers to the function, it will
3967 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3969 }
3970 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003971 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003972 // A normal function (not a numbered function or lambda) has a
3973 // refcount of 1 for the entry in the hashtable. When deleting
3974 // it and the refcount is more than one, it should be kept.
3975 // A numbered function and lambda should be kept if the refcount is
3976 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003977 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003978 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003979 // Function is still referenced somewhere. Don't free it but
3980 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003981 if (func_remove(fp))
3982 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003983 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003984 }
3985 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003986 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003987 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988 }
3989}
3990
3991/*
3992 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003993 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 */
3995 void
3996func_unref(char_u *name)
3997{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003998 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004000 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004001 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004002 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004003 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004006 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004008 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004009 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004010 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004012 // Only delete it when it's not being used. Otherwise it's done
4013 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004014 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004015 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004016 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004017}
4018
4019/*
4020 * Unreference a Function: decrement the reference count and free it when it
4021 * becomes zero.
4022 */
4023 void
4024func_ptr_unref(ufunc_T *fp)
4025{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004026 if (fp != NULL && --fp->uf_refcount <= 0)
4027 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004028 // Only delete it when it's not being used. Otherwise it's done
4029 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004030 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004031 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 }
4033}
4034
4035/*
4036 * Count a reference to a Function.
4037 */
4038 void
4039func_ref(char_u *name)
4040{
4041 ufunc_T *fp;
4042
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004043 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004045 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004046 if (fp != NULL)
4047 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004049 // Only give an error for a numbered function.
4050 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004051 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004052}
4053
4054/*
4055 * Count a reference to a Function.
4056 */
4057 void
4058func_ptr_ref(ufunc_T *fp)
4059{
4060 if (fp != NULL)
4061 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062}
4063
4064/*
4065 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4066 * referenced from anywhere that is in use.
4067 */
4068 static int
4069can_free_funccal(funccall_T *fc, int copyID)
4070{
4071 return (fc->l_varlist.lv_copyID != copyID
4072 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004073 && fc->l_avars.dv_copyID != copyID
4074 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075}
4076
4077/*
4078 * ":return [expr]"
4079 */
4080 void
4081ex_return(exarg_T *eap)
4082{
4083 char_u *arg = eap->arg;
4084 typval_T rettv;
4085 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004086 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087
4088 if (current_funccal == NULL)
4089 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004090 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091 return;
4092 }
4093
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004094 CLEAR_FIELD(evalarg);
4095 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4096
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 if (eap->skip)
4098 ++emsg_skip;
4099
4100 eap->nextcmd = NULL;
4101 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004102 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 {
4104 if (!eap->skip)
4105 returning = do_return(eap, FALSE, TRUE, &rettv);
4106 else
4107 clear_tv(&rettv);
4108 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004109 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 else if (!eap->skip)
4111 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004112 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004113 update_force_abort();
4114
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 /*
4116 * Return unless the expression evaluation has been cancelled due to an
4117 * aborting error, an interrupt, or an exception.
4118 */
4119 if (!aborting())
4120 returning = do_return(eap, FALSE, TRUE, NULL);
4121 }
4122
Bram Moolenaare38eab22019-12-05 21:50:01 +01004123 // When skipping or the return gets pending, advance to the next command
4124 // in this line (!returning). Otherwise, ignore the rest of the line.
4125 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004126 if (returning)
4127 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004128 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 eap->nextcmd = check_nextcmd(arg);
4130
4131 if (eap->skip)
4132 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004133 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134}
4135
4136/*
4137 * ":1,25call func(arg1, arg2)" function call.
4138 */
4139 void
4140ex_call(exarg_T *eap)
4141{
4142 char_u *arg = eap->arg;
4143 char_u *startarg;
4144 char_u *name;
4145 char_u *tofree;
4146 int len;
4147 typval_T rettv;
4148 linenr_T lnum;
4149 int doesrange;
4150 int failed = FALSE;
4151 funcdict_T fudi;
4152 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004153 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154
Bram Moolenaare6b53242020-07-01 17:28:33 +02004155 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 if (eap->skip)
4157 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004158 // trans_function_name() doesn't work well when skipping, use eval0()
4159 // instead to skip to any following command, e.g. for:
4160 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004162 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 clear_tv(&rettv);
4164 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004165 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166 return;
4167 }
4168
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004169 tofree = trans_function_name(&arg, NULL, eap->skip,
4170 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 if (fudi.fd_newkey != NULL)
4172 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004173 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004174 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 vim_free(fudi.fd_newkey);
4176 }
4177 if (tofree == NULL)
4178 return;
4179
Bram Moolenaare38eab22019-12-05 21:50:01 +01004180 // Increase refcount on dictionary, it could get deleted when evaluating
4181 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 if (fudi.fd_dict != NULL)
4183 ++fudi.fd_dict->dv_refcount;
4184
Bram Moolenaare38eab22019-12-05 21:50:01 +01004185 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4186 // contents. For VAR_PARTIAL get its partial, unless we already have one
4187 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 len = (int)STRLEN(tofree);
4189 name = deref_func_name(tofree, &len,
4190 partial != NULL ? NULL : &partial, FALSE);
4191
Bram Moolenaare38eab22019-12-05 21:50:01 +01004192 // Skip white space to allow ":call func ()". Not good, but required for
4193 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004195 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196
4197 if (*startarg != '(')
4198 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004199 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004200 goto end;
4201 }
4202
4203 /*
4204 * When skipping, evaluate the function once, to find the end of the
4205 * arguments.
4206 * When the function takes a range, this is discovered after the first
4207 * call, and the loop is broken.
4208 */
4209 if (eap->skip)
4210 {
4211 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004212 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004213 }
4214 else
4215 lnum = eap->line1;
4216 for ( ; lnum <= eap->line2; ++lnum)
4217 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004218 funcexe_T funcexe;
4219
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 if (!eap->skip && eap->addr_count > 0)
4221 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004222 if (lnum > curbuf->b_ml.ml_line_count)
4223 {
4224 // If the function deleted lines or switched to another buffer
4225 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004226 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004227 break;
4228 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229 curwin->w_cursor.lnum = lnum;
4230 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232 }
4233 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004234
Bram Moolenaara80faa82020-04-12 19:37:17 +02004235 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004236 funcexe.firstline = eap->line1;
4237 funcexe.lastline = eap->line2;
4238 funcexe.doesrange = &doesrange;
4239 funcexe.evaluate = !eap->skip;
4240 funcexe.partial = partial;
4241 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004242 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243 {
4244 failed = TRUE;
4245 break;
4246 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004247 if (has_watchexpr())
4248 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004250 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004251 if (handle_subscript(&arg, &rettv,
4252 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004253 {
4254 failed = TRUE;
4255 break;
4256 }
4257
4258 clear_tv(&rettv);
4259 if (doesrange || eap->skip)
4260 break;
4261
Bram Moolenaare38eab22019-12-05 21:50:01 +01004262 // Stop when immediately aborting on error, or when an interrupt
4263 // occurred or an exception was thrown but not caught.
4264 // get_func_tv() returned OK, so that the check for trailing
4265 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 if (aborting())
4267 break;
4268 }
4269 if (eap->skip)
4270 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004271 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272
Bram Moolenaare51bb172020-02-16 19:42:23 +01004273 // When inside :try we need to check for following "| catch".
4274 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004276 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004277 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004278 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004280 if (!failed)
4281 {
4282 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004283 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004284 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285 }
4286 else
4287 eap->nextcmd = check_nextcmd(arg);
4288 }
4289
4290end:
4291 dict_unref(fudi.fd_dict);
4292 vim_free(tofree);
4293}
4294
4295/*
4296 * Return from a function. Possibly makes the return pending. Also called
4297 * for a pending return at the ":endtry" or after returning from an extra
4298 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4299 * when called due to a ":return" command. "rettv" may point to a typval_T
4300 * with the return rettv. Returns TRUE when the return can be carried out,
4301 * FALSE when the return gets pending.
4302 */
4303 int
4304do_return(
4305 exarg_T *eap,
4306 int reanimate,
4307 int is_cmd,
4308 void *rettv)
4309{
4310 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004311 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312
4313 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004314 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 current_funccal->returned = FALSE;
4316
4317 /*
4318 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4319 * not in its finally clause (which then is to be executed next) is found.
4320 * In this case, make the ":return" pending for execution at the ":endtry".
4321 * Otherwise, return normally.
4322 */
4323 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4324 if (idx >= 0)
4325 {
4326 cstack->cs_pending[idx] = CSTP_RETURN;
4327
4328 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004329 // A pending return again gets pending. "rettv" points to an
4330 // allocated variable with the rettv of the original ":return"'s
4331 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332 cstack->cs_rettv[idx] = rettv;
4333 else
4334 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004335 // When undoing a return in order to make it pending, get the stored
4336 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 if (reanimate)
4338 rettv = current_funccal->rettv;
4339
4340 if (rettv != NULL)
4341 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004342 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4344 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4345 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004346 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 }
4348 else
4349 cstack->cs_rettv[idx] = NULL;
4350
4351 if (reanimate)
4352 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004353 // The pending return value could be overwritten by a ":return"
4354 // without argument in a finally clause; reset the default
4355 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004356 current_funccal->rettv->v_type = VAR_NUMBER;
4357 current_funccal->rettv->vval.v_number = 0;
4358 }
4359 }
4360 report_make_pending(CSTP_RETURN, rettv);
4361 }
4362 else
4363 {
4364 current_funccal->returned = TRUE;
4365
Bram Moolenaare38eab22019-12-05 21:50:01 +01004366 // If the return is carried out now, store the return value. For
4367 // a return immediately after reanimation, the value is already
4368 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004369 if (!reanimate && rettv != NULL)
4370 {
4371 clear_tv(current_funccal->rettv);
4372 *current_funccal->rettv = *(typval_T *)rettv;
4373 if (!is_cmd)
4374 vim_free(rettv);
4375 }
4376 }
4377
4378 return idx < 0;
4379}
4380
4381/*
4382 * Free the variable with a pending return value.
4383 */
4384 void
4385discard_pending_return(void *rettv)
4386{
4387 free_tv((typval_T *)rettv);
4388}
4389
4390/*
4391 * Generate a return command for producing the value of "rettv". The result
4392 * is an allocated string. Used by report_pending() for verbose messages.
4393 */
4394 char_u *
4395get_return_cmd(void *rettv)
4396{
4397 char_u *s = NULL;
4398 char_u *tofree = NULL;
4399 char_u numbuf[NUMBUFLEN];
4400
4401 if (rettv != NULL)
4402 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4403 if (s == NULL)
4404 s = (char_u *)"";
4405
4406 STRCPY(IObuff, ":return ");
4407 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4408 if (STRLEN(s) + 8 >= IOSIZE)
4409 STRCPY(IObuff + IOSIZE - 4, "...");
4410 vim_free(tofree);
4411 return vim_strsave(IObuff);
4412}
4413
4414/*
4415 * Get next function line.
4416 * Called by do_cmdline() to get the next line.
4417 * Returns allocated string, or NULL for end of function.
4418 */
4419 char_u *
4420get_func_line(
4421 int c UNUSED,
4422 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004423 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004424 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425{
4426 funccall_T *fcp = (funccall_T *)cookie;
4427 ufunc_T *fp = fcp->func;
4428 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004429 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430
Bram Moolenaare38eab22019-12-05 21:50:01 +01004431 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004432 if (fcp->dbg_tick != debug_tick)
4433 {
4434 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004435 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 fcp->dbg_tick = debug_tick;
4437 }
4438#ifdef FEAT_PROFILE
4439 if (do_profiling == PROF_YES)
4440 func_line_end(cookie);
4441#endif
4442
4443 gap = &fp->uf_lines;
4444 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4445 || fcp->returned)
4446 retval = NULL;
4447 else
4448 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004449 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 while (fcp->linenr < gap->ga_len
4451 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4452 ++fcp->linenr;
4453 if (fcp->linenr >= gap->ga_len)
4454 retval = NULL;
4455 else
4456 {
4457 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004458 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459#ifdef FEAT_PROFILE
4460 if (do_profiling == PROF_YES)
4461 func_line_start(cookie);
4462#endif
4463 }
4464 }
4465
Bram Moolenaare38eab22019-12-05 21:50:01 +01004466 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004467 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004469 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004470 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004472 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 fcp->dbg_tick = debug_tick;
4474 }
4475
4476 return retval;
4477}
4478
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479/*
4480 * Return TRUE if the currently active function should be ended, because a
4481 * return was encountered or an error occurred. Used inside a ":while".
4482 */
4483 int
4484func_has_ended(void *cookie)
4485{
4486 funccall_T *fcp = (funccall_T *)cookie;
4487
Bram Moolenaare38eab22019-12-05 21:50:01 +01004488 // Ignore the "abort" flag if the abortion behavior has been changed due to
4489 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004490 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4491 || fcp->returned);
4492}
4493
4494/*
4495 * return TRUE if cookie indicates a function which "abort"s on errors.
4496 */
4497 int
4498func_has_abort(
4499 void *cookie)
4500{
4501 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4502}
4503
4504
4505/*
4506 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4507 * Don't do this when "Func" is already a partial that was bound
4508 * explicitly (pt_auto is FALSE).
4509 * Changes "rettv" in-place.
4510 * Returns the updated "selfdict_in".
4511 */
4512 dict_T *
4513make_partial(dict_T *selfdict_in, typval_T *rettv)
4514{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004515 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 char_u *tofree = NULL;
4517 ufunc_T *fp;
4518 char_u fname_buf[FLEN_FIXED + 1];
4519 int error;
4520 dict_T *selfdict = selfdict_in;
4521
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004522 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4523 fp = rettv->vval.v_partial->pt_func;
4524 else
4525 {
4526 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4527 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004528 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004529 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004530 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004531 vim_free(tofree);
4532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533
4534 if (fp != NULL && (fp->uf_flags & FC_DICT))
4535 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004536 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537
4538 if (pt != NULL)
4539 {
4540 pt->pt_refcount = 1;
4541 pt->pt_dict = selfdict;
4542 pt->pt_auto = TRUE;
4543 selfdict = NULL;
4544 if (rettv->v_type == VAR_FUNC)
4545 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004546 // Just a function: Take over the function name and use
4547 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 pt->pt_name = rettv->vval.v_string;
4549 }
4550 else
4551 {
4552 partial_T *ret_pt = rettv->vval.v_partial;
4553 int i;
4554
Bram Moolenaare38eab22019-12-05 21:50:01 +01004555 // Partial: copy the function name, use selfdict and copy
4556 // args. Can't take over name or args, the partial might
4557 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004558 if (ret_pt->pt_name != NULL)
4559 {
4560 pt->pt_name = vim_strsave(ret_pt->pt_name);
4561 func_ref(pt->pt_name);
4562 }
4563 else
4564 {
4565 pt->pt_func = ret_pt->pt_func;
4566 func_ptr_ref(pt->pt_func);
4567 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 if (ret_pt->pt_argc > 0)
4569 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004570 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004572 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 pt->pt_argc = 0;
4574 else
4575 {
4576 pt->pt_argc = ret_pt->pt_argc;
4577 for (i = 0; i < pt->pt_argc; i++)
4578 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4579 }
4580 }
4581 partial_unref(ret_pt);
4582 }
4583 rettv->v_type = VAR_PARTIAL;
4584 rettv->vval.v_partial = pt;
4585 }
4586 }
4587 return selfdict;
4588}
4589
4590/*
4591 * Return the name of the executed function.
4592 */
4593 char_u *
4594func_name(void *cookie)
4595{
4596 return ((funccall_T *)cookie)->func->uf_name;
4597}
4598
4599/*
4600 * Return the address holding the next breakpoint line for a funccall cookie.
4601 */
4602 linenr_T *
4603func_breakpoint(void *cookie)
4604{
4605 return &((funccall_T *)cookie)->breakpoint;
4606}
4607
4608/*
4609 * Return the address holding the debug tick for a funccall cookie.
4610 */
4611 int *
4612func_dbg_tick(void *cookie)
4613{
4614 return &((funccall_T *)cookie)->dbg_tick;
4615}
4616
4617/*
4618 * Return the nesting level for a funccall cookie.
4619 */
4620 int
4621func_level(void *cookie)
4622{
4623 return ((funccall_T *)cookie)->level;
4624}
4625
4626/*
4627 * Return TRUE when a function was ended by a ":return" command.
4628 */
4629 int
4630current_func_returned(void)
4631{
4632 return current_funccal->returned;
4633}
4634
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004635 int
4636free_unref_funccal(int copyID, int testing)
4637{
4638 int did_free = FALSE;
4639 int did_free_funccal = FALSE;
4640 funccall_T *fc, **pfc;
4641
4642 for (pfc = &previous_funccal; *pfc != NULL; )
4643 {
4644 if (can_free_funccal(*pfc, copyID))
4645 {
4646 fc = *pfc;
4647 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004648 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649 did_free = TRUE;
4650 did_free_funccal = TRUE;
4651 }
4652 else
4653 pfc = &(*pfc)->caller;
4654 }
4655 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004656 // When a funccal was freed some more items might be garbage
4657 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 (void)garbage_collect(testing);
4659
4660 return did_free;
4661}
4662
4663/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004664 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665 */
4666 static funccall_T *
4667get_funccal(void)
4668{
4669 int i;
4670 funccall_T *funccal;
4671 funccall_T *temp_funccal;
4672
4673 funccal = current_funccal;
4674 if (debug_backtrace_level > 0)
4675 {
4676 for (i = 0; i < debug_backtrace_level; i++)
4677 {
4678 temp_funccal = funccal->caller;
4679 if (temp_funccal)
4680 funccal = temp_funccal;
4681 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004682 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004683 debug_backtrace_level = i;
4684 }
4685 }
4686 return funccal;
4687}
4688
4689/*
4690 * Return the hashtable used for local variables in the current funccal.
4691 * Return NULL if there is no current funccal.
4692 */
4693 hashtab_T *
4694get_funccal_local_ht()
4695{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004696 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697 return NULL;
4698 return &get_funccal()->l_vars.dv_hashtab;
4699}
4700
4701/*
4702 * Return the l: scope variable.
4703 * Return NULL if there is no current funccal.
4704 */
4705 dictitem_T *
4706get_funccal_local_var()
4707{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004708 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709 return NULL;
4710 return &get_funccal()->l_vars_var;
4711}
4712
4713/*
4714 * Return the hashtable used for argument in the current funccal.
4715 * Return NULL if there is no current funccal.
4716 */
4717 hashtab_T *
4718get_funccal_args_ht()
4719{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004720 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721 return NULL;
4722 return &get_funccal()->l_avars.dv_hashtab;
4723}
4724
4725/*
4726 * Return the a: scope variable.
4727 * Return NULL if there is no current funccal.
4728 */
4729 dictitem_T *
4730get_funccal_args_var()
4731{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004732 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004734 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735}
4736
4737/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 * List function variables, if there is a function.
4739 */
4740 void
4741list_func_vars(int *first)
4742{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004743 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004745 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746}
4747
4748/*
4749 * If "ht" is the hashtable for local variables in the current funccal, return
4750 * the dict that contains it.
4751 * Otherwise return NULL.
4752 */
4753 dict_T *
4754get_current_funccal_dict(hashtab_T *ht)
4755{
4756 if (current_funccal != NULL
4757 && ht == &current_funccal->l_vars.dv_hashtab)
4758 return &current_funccal->l_vars;
4759 return NULL;
4760}
4761
4762/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004763 * Search hashitem in parent scope.
4764 */
4765 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004766find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004767{
4768 funccall_T *old_current_funccal = current_funccal;
4769 hashtab_T *ht;
4770 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004771 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004772
4773 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4774 return NULL;
4775
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004776 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004777 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004778 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004779 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004780 ht = find_var_ht(name, &varname);
4781 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004782 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004783 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004784 if (!HASHITEM_EMPTY(hi))
4785 {
4786 *pht = ht;
4787 break;
4788 }
4789 }
4790 if (current_funccal == current_funccal->func->uf_scoped)
4791 break;
4792 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004793 }
4794 current_funccal = old_current_funccal;
4795
4796 return hi;
4797}
4798
4799/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004800 * Search variable in parent scope.
4801 */
4802 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004803find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004804{
4805 dictitem_T *v = NULL;
4806 funccall_T *old_current_funccal = current_funccal;
4807 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004808 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004809
4810 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4811 return NULL;
4812
Bram Moolenaare38eab22019-12-05 21:50:01 +01004813 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004814 current_funccal = current_funccal->func->uf_scoped;
4815 while (current_funccal)
4816 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004817 ht = find_var_ht(name, &varname);
4818 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004819 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004820 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004821 if (v != NULL)
4822 break;
4823 }
4824 if (current_funccal == current_funccal->func->uf_scoped)
4825 break;
4826 current_funccal = current_funccal->func->uf_scoped;
4827 }
4828 current_funccal = old_current_funccal;
4829
4830 return v;
4831}
4832
4833/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834 * Set "copyID + 1" in previous_funccal and callers.
4835 */
4836 int
4837set_ref_in_previous_funccal(int copyID)
4838{
4839 int abort = FALSE;
4840 funccall_T *fc;
4841
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004842 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004843 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004844 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004845 abort = abort
4846 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4847 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004848 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 }
4850 return abort;
4851}
4852
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004853 static int
4854set_ref_in_funccal(funccall_T *fc, int copyID)
4855{
4856 int abort = FALSE;
4857
4858 if (fc->fc_copyID != copyID)
4859 {
4860 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004861 abort = abort
4862 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4863 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004864 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004865 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004866 }
4867 return abort;
4868}
4869
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870/*
4871 * Set "copyID" in all local vars and arguments in the call stack.
4872 */
4873 int
4874set_ref_in_call_stack(int copyID)
4875{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004876 int abort = FALSE;
4877 funccall_T *fc;
4878 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004880 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004881 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004882
4883 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004884 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4885 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004886 abort = abort || set_ref_in_funccal(fc, copyID);
4887
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004888 return abort;
4889}
4890
4891/*
4892 * Set "copyID" in all functions available by name.
4893 */
4894 int
4895set_ref_in_functions(int copyID)
4896{
4897 int todo;
4898 hashitem_T *hi = NULL;
4899 int abort = FALSE;
4900 ufunc_T *fp;
4901
4902 todo = (int)func_hashtab.ht_used;
4903 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004905 if (!HASHITEM_EMPTY(hi))
4906 {
4907 --todo;
4908 fp = HI2UF(hi);
4909 if (!func_name_refcount(fp->uf_name))
4910 abort = abort || set_ref_in_func(NULL, fp, copyID);
4911 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912 }
4913 return abort;
4914}
4915
4916/*
4917 * Set "copyID" in all function arguments.
4918 */
4919 int
4920set_ref_in_func_args(int copyID)
4921{
4922 int i;
4923 int abort = FALSE;
4924
4925 for (i = 0; i < funcargs.ga_len; ++i)
4926 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4927 copyID, NULL, NULL);
4928 return abort;
4929}
4930
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004931/*
4932 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004933 * Returns TRUE if setting references failed somehow.
4934 */
4935 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004936set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004937{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004938 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004939 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004940 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004941 char_u fname_buf[FLEN_FIXED + 1];
4942 char_u *tofree = NULL;
4943 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004944 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004945
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004946 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004947 return FALSE;
4948
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004949 if (fp_in == NULL)
4950 {
4951 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004952 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004953 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004954 if (fp != NULL)
4955 {
4956 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004957 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004958 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004959
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004960 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004961 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004962}
4963
Bram Moolenaare38eab22019-12-05 21:50:01 +01004964#endif // FEAT_EVAL