blob: f7ad9f391e05b6be0c9e623e8f5b74896ab2add0 [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 Moolenaar50824712020-12-20 21:10:17 +01001837 * Check the argument count for user function "fp".
1838 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1839 */
1840 int
1841check_user_func_argcount(ufunc_T *fp, int argcount)
1842{
1843 int regular_args = fp->uf_args.ga_len;
1844
1845 if (argcount < regular_args - fp->uf_def_args.ga_len)
1846 return FCERR_TOOFEW;
1847 else if (!has_varargs(fp) && argcount > regular_args)
1848 return FCERR_TOOMANY;
1849 return FCERR_UNKNOWN;
1850}
1851
1852/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001853 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001854 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001855 int
1856call_user_func_check(
1857 ufunc_T *fp,
1858 int argcount,
1859 typval_T *argvars,
1860 typval_T *rettv,
1861 funcexe_T *funcexe,
1862 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001863{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001864 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001865
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001866 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1867 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01001868 error = check_user_func_argcount(fp, argcount);
1869 if (error != FCERR_UNKNOWN)
1870 return error;
1871 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001872 error = FCERR_DICT;
1873 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001874 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001875 int did_save_redo = FALSE;
1876 save_redo_T save_redo;
1877
1878 /*
1879 * Call the user function.
1880 * Save and restore search patterns, script variables and
1881 * redo buffer.
1882 */
1883 save_search_patterns();
1884 if (!ins_compl_active())
1885 {
1886 saveRedobuff(&save_redo);
1887 did_save_redo = TRUE;
1888 }
1889 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001890 call_user_func(fp, argcount, argvars, rettv, funcexe,
1891 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001892 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1893 // Function was unreferenced while being used, free it now.
1894 func_clear_free(fp, FALSE);
1895 if (did_save_redo)
1896 restoreRedobuff(&save_redo);
1897 restore_search_patterns();
1898 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001899 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001900 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001901}
1902
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001903static funccal_entry_T *funccal_stack = NULL;
1904
1905/*
1906 * Save the current function call pointer, and set it to NULL.
1907 * Used when executing autocommands and for ":source".
1908 */
1909 void
1910save_funccal(funccal_entry_T *entry)
1911{
1912 entry->top_funccal = current_funccal;
1913 entry->next = funccal_stack;
1914 funccal_stack = entry;
1915 current_funccal = NULL;
1916}
1917
1918 void
1919restore_funccal(void)
1920{
1921 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001922 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001923 else
1924 {
1925 current_funccal = funccal_stack->top_funccal;
1926 funccal_stack = funccal_stack->next;
1927 }
1928}
1929
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001930 funccall_T *
1931get_current_funccal(void)
1932{
1933 return current_funccal;
1934}
1935
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001936/*
1937 * Mark all functions of script "sid" as deleted.
1938 */
1939 void
1940delete_script_functions(int sid)
1941{
1942 hashitem_T *hi;
1943 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001944 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001945 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001946 size_t len;
1947
1948 buf[0] = K_SPECIAL;
1949 buf[1] = KS_EXTRA;
1950 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001951 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001952 len = STRLEN(buf);
1953
Bram Moolenaarce658352020-07-31 23:47:12 +02001954 while (todo > 0)
1955 {
1956 todo = func_hashtab.ht_used;
1957 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1958 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001959 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001960 fp = HI2UF(hi);
1961 if (STRNCMP(fp->uf_name, buf, len) == 0)
1962 {
1963 int changed = func_hashtab.ht_changed;
1964
1965 fp->uf_flags |= FC_DEAD;
1966 func_clear(fp, TRUE);
1967 // When clearing a function another function can be cleared
1968 // as a side effect. When that happens start over.
1969 if (changed != func_hashtab.ht_changed)
1970 break;
1971 }
1972 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001973 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001974 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001975}
1976
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001977#if defined(EXITFREE) || defined(PROTO)
1978 void
1979free_all_functions(void)
1980{
1981 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001982 ufunc_T *fp;
1983 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001984 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001985 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001986
Bram Moolenaare38eab22019-12-05 21:50:01 +01001987 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001988 while (current_funccal != NULL)
1989 {
1990 clear_tv(current_funccal->rettv);
1991 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001992 if (current_funccal == NULL && funccal_stack != NULL)
1993 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001994 }
1995
Bram Moolenaare38eab22019-12-05 21:50:01 +01001996 // First clear what the functions contain. Since this may lower the
1997 // reference count of a function, it may also free a function and change
1998 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001999 while (todo > 0)
2000 {
2001 todo = func_hashtab.ht_used;
2002 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2003 if (!HASHITEM_EMPTY(hi))
2004 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002005 // clear the def function index now
2006 fp = HI2UF(hi);
2007 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002008 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009
Bram Moolenaare38eab22019-12-05 21:50:01 +01002010 // Only free functions that are not refcounted, those are
2011 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002012 if (func_name_refcount(fp->uf_name))
2013 ++skipped;
2014 else
2015 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002016 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002017 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002018 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002019 {
2020 skipped = 0;
2021 break;
2022 }
2023 }
2024 --todo;
2025 }
2026 }
2027
Bram Moolenaare38eab22019-12-05 21:50:01 +01002028 // Now actually free the functions. Need to start all over every time,
2029 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002030 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002031 while (func_hashtab.ht_used > skipped)
2032 {
2033 todo = func_hashtab.ht_used;
2034 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002035 if (!HASHITEM_EMPTY(hi))
2036 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002037 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002038 // Only free functions that are not refcounted, those are
2039 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002040 fp = HI2UF(hi);
2041 if (func_name_refcount(fp->uf_name))
2042 ++skipped;
2043 else
2044 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002045 if (func_free(fp, FALSE) == OK)
2046 {
2047 skipped = 0;
2048 break;
2049 }
2050 // did not actually free it
2051 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002052 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002053 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002054 }
2055 if (skipped == 0)
2056 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002057
2058 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002059}
2060#endif
2061
2062/*
2063 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002064 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002065 * "len" is the length of "name", or -1 for NUL terminated.
2066 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002067 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002068builtin_function(char_u *name, int len)
2069{
2070 char_u *p;
2071
Bram Moolenaara26b9702020-04-18 19:53:28 +02002072 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002073 return FALSE;
2074 p = vim_strchr(name, AUTOLOAD_CHAR);
2075 return p == NULL || (len > 0 && p > name + len);
2076}
2077
2078 int
2079func_call(
2080 char_u *name,
2081 typval_T *args,
2082 partial_T *partial,
2083 dict_T *selfdict,
2084 typval_T *rettv)
2085{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002086 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002087 listitem_T *item;
2088 typval_T argv[MAX_FUNC_ARGS + 1];
2089 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002090 int r = 0;
2091
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002092 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002093 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002094 {
2095 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2096 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002097 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002098 break;
2099 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002100 // Make a copy of each argument. This is needed to be able to set
2101 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 copy_tv(&item->li_tv, &argv[argc++]);
2103 }
2104
2105 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002106 {
2107 funcexe_T funcexe;
2108
Bram Moolenaara80faa82020-04-12 19:37:17 +02002109 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002110 funcexe.firstline = curwin->w_cursor.lnum;
2111 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002112 funcexe.evaluate = TRUE;
2113 funcexe.partial = partial;
2114 funcexe.selfdict = selfdict;
2115 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2116 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002117
Bram Moolenaare38eab22019-12-05 21:50:01 +01002118 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002119 while (argc > 0)
2120 clear_tv(&argv[--argc]);
2121
2122 return r;
2123}
2124
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002125static int callback_depth = 0;
2126
2127 int
2128get_callback_depth(void)
2129{
2130 return callback_depth;
2131}
2132
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002133/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002134 * Invoke call_func() with a callback.
2135 */
2136 int
2137call_callback(
2138 callback_T *callback,
2139 int len, // length of "name" or -1 to use strlen()
2140 typval_T *rettv, // return value goes here
2141 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002142 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002143 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002144{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002145 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002146 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002147
Bram Moolenaara80faa82020-04-12 19:37:17 +02002148 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002149 funcexe.evaluate = TRUE;
2150 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002151 ++callback_depth;
2152 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2153 --callback_depth;
2154 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002155}
2156
2157/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002158 * Give an error message for the result of a function.
2159 * Nothing if "error" is FCERR_NONE.
2160 */
2161 void
2162user_func_error(int error, char_u *name)
2163{
2164 switch (error)
2165 {
2166 case FCERR_UNKNOWN:
2167 emsg_funcname(e_unknownfunc, name);
2168 break;
2169 case FCERR_NOTMETHOD:
2170 emsg_funcname(
2171 N_("E276: Cannot use function as a method: %s"), name);
2172 break;
2173 case FCERR_DELETED:
2174 emsg_funcname(N_(e_func_deleted), name);
2175 break;
2176 case FCERR_TOOMANY:
2177 emsg_funcname((char *)e_toomanyarg, name);
2178 break;
2179 case FCERR_TOOFEW:
2180 emsg_funcname((char *)e_toofewarg, name);
2181 break;
2182 case FCERR_SCRIPT:
2183 emsg_funcname(
2184 N_("E120: Using <SID> not in a script context: %s"), name);
2185 break;
2186 case FCERR_DICT:
2187 emsg_funcname(
2188 N_("E725: Calling dict function without Dictionary: %s"),
2189 name);
2190 break;
2191 }
2192}
2193
2194/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002196 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002197 * Return FAIL when the function can't be called, OK otherwise.
2198 * Also returns OK when an error was encountered while executing the function.
2199 */
2200 int
2201call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002202 char_u *funcname, // name of the function
2203 int len, // length of "name" or -1 to use strlen()
2204 typval_T *rettv, // return value goes here
2205 int argcount_in, // number of "argvars"
2206 typval_T *argvars_in, // vars for arguments, must have "argcount"
2207 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002208 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209{
2210 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002211 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002213 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 char_u fname_buf[FLEN_FIXED + 1];
2215 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002216 char_u *fname = NULL;
2217 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002218 int argcount = argcount_in;
2219 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002220 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002221 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2222 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002223 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002224 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002225 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002227 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2228 // even when call_func() returns FAIL.
2229 rettv->v_type = VAR_UNKNOWN;
2230
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002231 if (partial != NULL)
2232 fp = partial->pt_func;
2233 if (fp == NULL)
2234 {
2235 // Make a copy of the name, if it comes from a funcref variable it
2236 // could be changed or deleted in the called function.
2237 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2238 if (name == NULL)
2239 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002240
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002241 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2242 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002243
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002244 if (funcexe->doesrange != NULL)
2245 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002246
2247 if (partial != NULL)
2248 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002249 // When the function has a partial with a dict and there is a dict
2250 // argument, use the dict argument. That is backwards compatible.
2251 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002252 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002253 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002254 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002255 {
2256 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002257 {
2258 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2259 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002260 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002261 goto theend;
2262 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002263 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 for (i = 0; i < argcount_in; ++i)
2266 argv[i + argv_clear] = argvars_in[i];
2267 argvars = argv;
2268 argcount = partial->pt_argc + argcount_in;
2269 }
2270 }
2271
Bram Moolenaaref140542019-12-31 21:27:13 +01002272 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002273 {
2274 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002275 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002276
Bram Moolenaar333894b2020-08-01 18:53:07 +02002277 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002278 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002279 {
2280 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002281 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283
Bram Moolenaare38eab22019-12-05 21:50:01 +01002284 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002286 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002287
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002288 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289 {
2290 /*
2291 * User defined function.
2292 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002293 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002294 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295
Bram Moolenaare38eab22019-12-05 21:50:01 +01002296 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002297 if (fp == NULL
2298 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002299 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002300 && !aborting())
2301 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002302 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002303 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002304 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002305 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2307 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002308 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002309 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002310 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002311 if (fp == NULL)
2312 {
2313 char_u *p = untrans_function_name(rfname);
2314
2315 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002316 // Don't do this if the name starts with "s:".
2317 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002318 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002319 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002321 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002322 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002323#ifdef FEAT_LUA
2324 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2325 {
2326 cfunc_T cb = fp->uf_cb;
2327
2328 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2329 }
2330#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002331 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002333 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002334 // postponed filling in the arguments, do it now
2335 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002336 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002337
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002338 if (funcexe->basetv != NULL)
2339 {
2340 // Method call: base->Method()
2341 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2342 argv[0] = *funcexe->basetv;
2343 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002344 argvars = argv;
2345 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002346 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002347
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002348 error = call_user_func_check(fp, argcount, argvars, rettv,
2349 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350 }
2351 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002352 else if (funcexe->basetv != NULL)
2353 {
2354 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002355 * expr->method(): Find the method name in the table, call its
2356 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002357 */
2358 error = call_internal_method(fname, argcount, argvars, rettv,
2359 funcexe->basetv);
2360 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 else
2362 {
2363 /*
2364 * Find the function name in the table, call its implementation.
2365 */
2366 error = call_internal_func(fname, argcount, argvars, rettv);
2367 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002368
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369 /*
2370 * The function call (or "FuncUndefined" autocommand sequence) might
2371 * have been aborted by an error, an interrupt, or an explicitly thrown
2372 * exception that has not been caught so far. This situation can be
2373 * tested for by calling aborting(). For an error in an internal
2374 * function or for the "E132" error in call_user_func(), however, the
2375 * throw point at which the "force_abort" flag (temporarily reset by
2376 * emsg()) is normally updated has not been reached yet. We need to
2377 * update that flag first to make aborting() reliable.
2378 */
2379 update_force_abort();
2380 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002381 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 ret = OK;
2383
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002384theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 /*
2386 * Report an error unless the argument evaluation or function call has been
2387 * cancelled due to an aborting error, an interrupt, or an exception.
2388 */
2389 if (!aborting())
2390 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002391 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392 }
2393
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002394 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002395 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002396 clear_tv(&argv[--argv_clear + argv_base]);
2397
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 vim_free(tofree);
2399 vim_free(name);
2400
2401 return ret;
2402}
2403
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002404 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002405printable_func_name(ufunc_T *fp)
2406{
2407 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2408}
2409
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002411 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 */
2413 static void
2414list_func_head(ufunc_T *fp, int indent)
2415{
2416 int j;
2417
2418 msg_start();
2419 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002420 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002421 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002422 msg_puts("def ");
2423 else
2424 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002425 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 msg_putchar('(');
2427 for (j = 0; j < fp->uf_args.ga_len; ++j)
2428 {
2429 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002430 msg_puts(", ");
2431 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002432 if (fp->uf_arg_types != NULL)
2433 {
2434 char *tofree;
2435
2436 msg_puts(": ");
2437 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2438 vim_free(tofree);
2439 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002440 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2441 {
2442 msg_puts(" = ");
2443 msg_puts(((char **)(fp->uf_def_args.ga_data))
2444 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2445 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 }
2447 if (fp->uf_varargs)
2448 {
2449 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002450 msg_puts(", ");
2451 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002453 if (fp->uf_va_name != NULL)
2454 {
2455 if (j)
2456 msg_puts(", ");
2457 msg_puts("...");
2458 msg_puts((char *)fp->uf_va_name);
2459 if (fp->uf_va_type)
2460 {
2461 char *tofree;
2462
2463 msg_puts(": ");
2464 msg_puts(type_name(fp->uf_va_type, &tofree));
2465 vim_free(tofree);
2466 }
2467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002469
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002470 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002471 {
2472 if (fp->uf_ret_type != &t_void)
2473 {
2474 char *tofree;
2475
2476 msg_puts(": ");
2477 msg_puts(type_name(fp->uf_ret_type, &tofree));
2478 vim_free(tofree);
2479 }
2480 }
2481 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002482 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002484 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002486 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002487 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002488 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 msg_clr_eos();
2490 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002491 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492}
2493
2494/*
2495 * Get a function name, translating "<SID>" and "<SNR>".
2496 * Also handles a Funcref in a List or Dictionary.
2497 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002498 * Set "*is_global" to TRUE when the function must be global, unless
2499 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 * flags:
2501 * TFN_INT: internal function name OK
2502 * TFN_QUIET: be quiet
2503 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002504 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 * Advances "pp" to just after the function name (if no error).
2506 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002507 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002508trans_function_name(
2509 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002510 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002511 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002513 funcdict_T *fdp, // return: info about dictionary used
2514 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515{
2516 char_u *name = NULL;
2517 char_u *start;
2518 char_u *end;
2519 int lead;
2520 char_u sid_buf[20];
2521 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002522 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002524 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002525 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526
2527 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002528 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 start = *pp;
2530
Bram Moolenaare38eab22019-12-05 21:50:01 +01002531 // Check for hard coded <SNR>: already translated function ID (from a user
2532 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2534 && (*pp)[2] == (int)KE_SNR)
2535 {
2536 *pp += 3;
2537 len = get_id_len(pp) + 3;
2538 return vim_strnsave(start, len);
2539 }
2540
Bram Moolenaare38eab22019-12-05 21:50:01 +01002541 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2542 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 lead = eval_fname_script(start);
2544 if (lead > 2)
2545 start += lead;
2546
Bram Moolenaare38eab22019-12-05 21:50:01 +01002547 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002548 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 lead > 2 ? 0 : FNE_CHECK_START);
2550 if (end == start)
2551 {
2552 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002553 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002554 goto theend;
2555 }
2556 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2557 {
2558 /*
2559 * Report an invalid expression in braces, unless the expression
2560 * evaluation has been cancelled due to an aborting error, an
2561 * interrupt, or an exception.
2562 */
2563 if (!aborting())
2564 {
2565 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002566 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002567 }
2568 else
2569 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2570 goto theend;
2571 }
2572
2573 if (lv.ll_tv != NULL)
2574 {
2575 if (fdp != NULL)
2576 {
2577 fdp->fd_dict = lv.ll_dict;
2578 fdp->fd_newkey = lv.ll_newkey;
2579 lv.ll_newkey = NULL;
2580 fdp->fd_di = lv.ll_di;
2581 }
2582 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2583 {
2584 name = vim_strsave(lv.ll_tv->vval.v_string);
2585 *pp = end;
2586 }
2587 else if (lv.ll_tv->v_type == VAR_PARTIAL
2588 && lv.ll_tv->vval.v_partial != NULL)
2589 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002590 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002591 *pp = end;
2592 if (partial != NULL)
2593 *partial = lv.ll_tv->vval.v_partial;
2594 }
2595 else
2596 {
2597 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2598 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002599 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002600 else
2601 *pp = end;
2602 name = NULL;
2603 }
2604 goto theend;
2605 }
2606
2607 if (lv.ll_name == NULL)
2608 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002609 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 *pp = end;
2611 goto theend;
2612 }
2613
Bram Moolenaare38eab22019-12-05 21:50:01 +01002614 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 if (lv.ll_exp_name != NULL)
2616 {
2617 len = (int)STRLEN(lv.ll_exp_name);
2618 name = deref_func_name(lv.ll_exp_name, &len, partial,
2619 flags & TFN_NO_AUTOLOAD);
2620 if (name == lv.ll_exp_name)
2621 name = NULL;
2622 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002623 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624 {
2625 len = (int)(end - *pp);
2626 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2627 if (name == *pp)
2628 name = NULL;
2629 }
2630 if (name != NULL)
2631 {
2632 name = vim_strsave(name);
2633 *pp = end;
2634 if (STRNCMP(name, "<SNR>", 5) == 0)
2635 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002636 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 name[0] = K_SPECIAL;
2638 name[1] = KS_EXTRA;
2639 name[2] = (int)KE_SNR;
2640 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2641 }
2642 goto theend;
2643 }
2644
2645 if (lv.ll_exp_name != NULL)
2646 {
2647 len = (int)STRLEN(lv.ll_exp_name);
2648 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2649 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2650 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002651 // When there was "s:" already or the name expanded to get a
2652 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653 lv.ll_name += 2;
2654 len -= 2;
2655 lead = 2;
2656 }
2657 }
2658 else
2659 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002662 {
2663 if (is_global != NULL && lv.ll_name[0] == 'g')
2664 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002666 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 len = (int)(end - lv.ll_name);
2668 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002669 if (len <= 0)
2670 {
2671 if (!skip)
2672 emsg(_(e_function_name));
2673 goto theend;
2674 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002676 // In Vim9 script a user function is script-local by default, unless it
2677 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002678 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002679 if (vim9script)
2680 {
2681 char_u *p;
2682
2683 // SomeScript#func() is a global function.
2684 for (p = start; *p != NUL && *p != '('; ++p)
2685 if (*p == AUTOLOAD_CHAR)
2686 vim9script = FALSE;
2687 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002688
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 /*
2690 * Copy the function name to allocated memory.
2691 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2692 * Accept <SNR>123_name() outside a script.
2693 */
2694 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002695 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002696 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002698 if (!vim9script)
2699 lead = 3;
2700 if (vim9script || (lv.ll_exp_name != NULL
2701 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 || eval_fname_sid(*pp))
2703 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002704 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002705 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002707 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 goto theend;
2709 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002710 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002711 if (vim9script)
2712 extra = 3 + (int)STRLEN(sid_buf);
2713 else
2714 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 }
2716 }
2717 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2718 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002719 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 start);
2721 goto theend;
2722 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002723 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 {
2725 char_u *cp = vim_strchr(lv.ll_name, ':');
2726
2727 if (cp != NULL && cp < end)
2728 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002729 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 goto theend;
2731 }
2732 }
2733
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002734 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002735 if (name != NULL)
2736 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002737 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002738 {
2739 name[0] = K_SPECIAL;
2740 name[1] = KS_EXTRA;
2741 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002742 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 STRCPY(name + 3, sid_buf);
2744 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002745 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2746 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747 }
2748 *pp = end;
2749
2750theend:
2751 clear_lval(&lv);
2752 return name;
2753}
2754
2755/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002756 * Assuming "name" is the result of trans_function_name() and it was prefixed
2757 * to use the script-local name, return the unmodified name (points into
2758 * "name"). Otherwise return NULL.
2759 * This can be used to first search for a script-local function and fall back
2760 * to the global function if not found.
2761 */
2762 char_u *
2763untrans_function_name(char_u *name)
2764{
2765 char_u *p;
2766
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002767 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002768 {
2769 p = vim_strchr(name, '_');
2770 if (p != NULL)
2771 return p + 1;
2772 }
2773 return NULL;
2774}
2775
2776/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002777 * List functions. When "regmatch" is NULL all of then.
2778 * Otherwise functions matching "regmatch".
2779 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002780 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002781list_functions(regmatch_T *regmatch)
2782{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002783 int changed = func_hashtab.ht_changed;
2784 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002785 hashitem_T *hi;
2786
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002787 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002788 {
2789 if (!HASHITEM_EMPTY(hi))
2790 {
2791 ufunc_T *fp = HI2UF(hi);
2792
2793 --todo;
2794 if ((fp->uf_flags & FC_DEAD) == 0
2795 && (regmatch == NULL
2796 ? !message_filtered(fp->uf_name)
2797 && !func_name_refcount(fp->uf_name)
2798 : !isdigit(*fp->uf_name)
2799 && vim_regexec(regmatch, fp->uf_name, 0)))
2800 {
2801 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002802 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002803 {
2804 emsg(_("E454: function list was modified"));
2805 return;
2806 }
2807 }
2808 }
2809 }
2810}
2811
2812/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002813 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002814 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2815 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002816 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002818 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002819define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820{
2821 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002822 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002823 int j;
2824 int c;
2825 int saved_did_emsg;
2826 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002827 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002828 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 char_u *p;
2830 char_u *arg;
2831 char_u *line_arg = NULL;
2832 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002833 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002834 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 garray_T newlines;
2836 int varargs = FALSE;
2837 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002838 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002839 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002840 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 int indent;
2842 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002843#define MAX_FUNC_NESTING 50
2844 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845 dictitem_T *v;
2846 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002847 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002850 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002851 linenr_T sourcing_lnum_off;
2852 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002853 int is_heredoc = FALSE;
2854 char_u *skip_until = NULL;
2855 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002856 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002857 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858
2859 /*
2860 * ":function" without argument: list functions.
2861 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002862 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002863 {
2864 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002865 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002867 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 }
2869
2870 /*
2871 * ":function /pat": list functions matching pattern.
2872 */
2873 if (*eap->arg == '/')
2874 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002875 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 if (!eap->skip)
2877 {
2878 regmatch_T regmatch;
2879
2880 c = *p;
2881 *p = NUL;
2882 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2883 *p = c;
2884 if (regmatch.regprog != NULL)
2885 {
2886 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002887 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 vim_regfree(regmatch.regprog);
2889 }
2890 }
2891 if (*p == '/')
2892 ++p;
2893 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002894 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 }
2896
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002897 ga_init(&newargs);
2898 ga_init(&argtypes);
2899 ga_init(&default_args);
2900
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 /*
2902 * Get the function name. There are these situations:
2903 * func normal function name
2904 * "name" == func, "fudi.fd_dict" == NULL
2905 * dict.func new dictionary entry
2906 * "name" == NULL, "fudi.fd_dict" set,
2907 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2908 * dict.func existing dict entry with a Funcref
2909 * "name" == func, "fudi.fd_dict" set,
2910 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2911 * dict.func existing dict entry that's not a Funcref
2912 * "name" == NULL, "fudi.fd_dict" set,
2913 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2914 * s:func script-local function name
2915 * g:func global function name, same as "func"
2916 */
2917 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002918 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002920 // nested function, argument is (args).
2921 paren = TRUE;
2922 CLEAR_FIELD(fudi);
2923 }
2924 else
2925 {
2926 name = trans_function_name(&p, &is_global, eap->skip,
2927 TFN_NO_AUTOLOAD, &fudi, NULL);
2928 paren = (vim_strchr(p, '(') != NULL);
2929 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002931 /*
2932 * Return on an invalid expression in braces, unless the expression
2933 * evaluation has been cancelled due to an aborting error, an
2934 * interrupt, or an exception.
2935 */
2936 if (!aborting())
2937 {
2938 if (!eap->skip && fudi.fd_newkey != NULL)
2939 semsg(_(e_dictkey), fudi.fd_newkey);
2940 vim_free(fudi.fd_newkey);
2941 return NULL;
2942 }
2943 else
2944 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002945 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946 }
2947
Bram Moolenaare38eab22019-12-05 21:50:01 +01002948 // An error in a function call during evaluation of an expression in magic
2949 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950 saved_did_emsg = did_emsg;
2951 did_emsg = FALSE;
2952
2953 /*
2954 * ":function func" with only function name: list function.
2955 */
2956 if (!paren)
2957 {
2958 if (!ends_excmd(*skipwhite(p)))
2959 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002960 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961 goto ret_free;
2962 }
2963 eap->nextcmd = check_nextcmd(p);
2964 if (eap->nextcmd != NULL)
2965 *p = NUL;
2966 if (!eap->skip && !got_int)
2967 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002968 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002969 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2970 {
2971 char_u *up = untrans_function_name(name);
2972
2973 // With Vim9 script the name was made script-local, if not
2974 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002975 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002976 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002977 }
2978
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002979 if (fp != NULL)
2980 {
2981 list_func_head(fp, TRUE);
2982 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2983 {
2984 if (FUNCLINE(fp, j) == NULL)
2985 continue;
2986 msg_putchar('\n');
2987 msg_outnum((long)(j + 1));
2988 if (j < 9)
2989 msg_putchar(' ');
2990 if (j < 99)
2991 msg_putchar(' ');
2992 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002993 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994 ui_breakcheck();
2995 }
2996 if (!got_int)
2997 {
2998 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002999 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003000 msg_puts(" enddef");
3001 else
3002 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 }
3004 }
3005 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003006 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 }
3008 goto ret_free;
3009 }
3010
3011 /*
3012 * ":function name(arg1, arg2)" Define function.
3013 */
3014 p = skipwhite(p);
3015 if (*p != '(')
3016 {
3017 if (!eap->skip)
3018 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003019 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 goto ret_free;
3021 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003022 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 if (vim_strchr(p, '(') != NULL)
3024 p = vim_strchr(p, '(');
3025 }
3026 p = skipwhite(p + 1);
3027
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003028 // In Vim9 script only global functions can be redefined.
3029 if (vim9script && eap->forceit && !is_global)
3030 {
3031 emsg(_(e_nobang));
3032 goto ret_free;
3033 }
3034
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3036
Bram Moolenaar04b12692020-05-04 23:24:44 +02003037 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003039 // Check the name of the function. Unless it's a dictionary function
3040 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 if (name != NULL)
3042 arg = name;
3043 else
3044 arg = fudi.fd_newkey;
3045 if (arg != NULL && (fudi.fd_di == NULL
3046 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3047 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3048 {
3049 if (*arg == K_SPECIAL)
3050 j = 3;
3051 else
3052 j = 0;
3053 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3054 : eval_isnamec(arg[j])))
3055 ++j;
3056 if (arg[j] != NUL)
3057 emsg_funcname((char *)e_invarg2, arg);
3058 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003059 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003061 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 }
3063
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003064 // This may get more lines and make the pointers into the first line
3065 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003066 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003067 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003068 &varargs, &default_args, eap->skip,
3069 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003070 goto errret_2;
3071
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003072 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003074 // find the return type: :def Func(): type
3075 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003076 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003077 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003078 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003079 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003080 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003081 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003082 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003083 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003084 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003085 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003086 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003087 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003088 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003089 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003090 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003092 else
3093 // find extra arguments "range", "dict", "abort" and "closure"
3094 for (;;)
3095 {
3096 p = skipwhite(p);
3097 if (STRNCMP(p, "range", 5) == 0)
3098 {
3099 flags |= FC_RANGE;
3100 p += 5;
3101 }
3102 else if (STRNCMP(p, "dict", 4) == 0)
3103 {
3104 flags |= FC_DICT;
3105 p += 4;
3106 }
3107 else if (STRNCMP(p, "abort", 5) == 0)
3108 {
3109 flags |= FC_ABORT;
3110 p += 5;
3111 }
3112 else if (STRNCMP(p, "closure", 7) == 0)
3113 {
3114 flags |= FC_CLOSURE;
3115 p += 7;
3116 if (current_funccal == NULL)
3117 {
3118 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3119 name == NULL ? (char_u *)"" : name);
3120 goto erret;
3121 }
3122 }
3123 else
3124 break;
3125 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126
Bram Moolenaare38eab22019-12-05 21:50:01 +01003127 // When there is a line break use what follows for the function body.
3128 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 if (*p == '\n')
3130 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003131 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003132 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3133 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003134 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3135 && !eap->skip
3136 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003137 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138
3139 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003140 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3141 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 */
3143 if (KeyTyped)
3144 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003145 // Check if the function already exists, don't let the user type the
3146 // whole function before telling him it doesn't work! For a script we
3147 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 if (!eap->skip && !eap->forceit)
3149 {
3150 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003151 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003152 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003153 emsg_funcname(e_funcexts, name);
3154 }
3155
3156 if (!eap->skip && did_emsg)
3157 goto erret;
3158
Bram Moolenaare38eab22019-12-05 21:50:01 +01003159 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 cmdline_row = msg_row;
3161 }
3162
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003163 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003164 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003165
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003166 // Detect having skipped over comment lines to find the return
3167 // type. Add NULL lines to keep the line count correct.
3168 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3169 if (SOURCING_LNUM < sourcing_lnum_off)
3170 {
3171 sourcing_lnum_off -= SOURCING_LNUM;
3172 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3173 goto erret;
3174 while (sourcing_lnum_off-- > 0)
3175 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3176 }
3177
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 indent = 2;
3179 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003180 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003181 for (;;)
3182 {
3183 if (KeyTyped)
3184 {
3185 msg_scroll = TRUE;
3186 saved_wait_return = FALSE;
3187 }
3188 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003189
3190 if (line_arg != NULL)
3191 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003192 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003193 theline = line_arg;
3194 p = vim_strchr(theline, '\n');
3195 if (p == NULL)
3196 line_arg += STRLEN(line_arg);
3197 else
3198 {
3199 *p = NUL;
3200 line_arg = p + 1;
3201 }
3202 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003204 {
3205 vim_free(line_to_free);
3206 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003207 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003208 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003209 theline = eap->getline(':', eap->cookie, indent,
3210 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003211 line_to_free = theline;
3212 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 if (KeyTyped)
3214 lines_left = Rows - 1;
3215 if (theline == NULL)
3216 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003217 if (skip_until != NULL)
3218 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3219 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003220 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003221 else
3222 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 goto erret;
3224 }
3225
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003226 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003227 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003228 if (SOURCING_LNUM < sourcing_lnum_off)
3229 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 else
3231 sourcing_lnum_off = 0;
3232
3233 if (skip_until != NULL)
3234 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003235 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003236 // * ":append" and "."
3237 // * ":python <<EOF" and "EOF"
3238 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3239 if (heredoc_trimmed == NULL
3240 || (is_heredoc && skipwhite(theline) == theline)
3241 || STRNCMP(theline, heredoc_trimmed,
3242 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003243 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003244 if (heredoc_trimmed == NULL)
3245 p = theline;
3246 else if (is_heredoc)
3247 p = skipwhite(theline) == theline
3248 ? theline : theline + STRLEN(heredoc_trimmed);
3249 else
3250 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003251 if (STRCMP(p, skip_until) == 0)
3252 {
3253 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003254 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003255 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003256 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003257 }
3258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 }
3260 else
3261 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003262 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003263 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264 ;
3265
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266 // Check for "endfunction" or "enddef".
3267 if (checkforcmd(&p, nesting_def[nesting]
3268 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003270 char_u *nextcmd = NULL;
3271
Bram Moolenaar663bb232017-06-22 19:12:10 +02003272 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003273 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003274 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003275 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003276 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003277 give_warning2(eap->cmdidx == CMD_def
3278 ? (char_u *)_("W1001: Text found after :enddef: %s")
3279 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003280 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003281 if (nextcmd != NULL)
3282 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003283 // Another command follows. If the line came from "eap" we
3284 // can simply point into it, otherwise we need to change
3285 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003286 eap->nextcmd = nextcmd;
3287 if (line_to_free != NULL)
3288 {
3289 vim_free(*eap->cmdlinep);
3290 *eap->cmdlinep = line_to_free;
3291 line_to_free = NULL;
3292 }
3293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 break;
3295 }
3296
Bram Moolenaare38eab22019-12-05 21:50:01 +01003297 // Increase indent inside "if", "while", "for" and "try", decrease
3298 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003300 indent -= 2;
3301 else if (STRNCMP(p, "if", 2) == 0
3302 || STRNCMP(p, "wh", 2) == 0
3303 || STRNCMP(p, "for", 3) == 0
3304 || STRNCMP(p, "try", 3) == 0)
3305 indent += 2;
3306
Bram Moolenaare38eab22019-12-05 21:50:01 +01003307 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003308 // Only recognize "def" inside "def", not inside "function",
3309 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003311 if (checkforcmd(&p, "function", 2)
3312 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 {
3314 if (*p == '!')
3315 p = skipwhite(p + 1);
3316 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003317 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 if (*skipwhite(p) == '(')
3319 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003321 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003322 else
3323 {
3324 ++nesting;
3325 nesting_def[nesting] = (c == 'd');
3326 indent += 2;
3327 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328 }
3329 }
3330
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003331 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003332 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003333 if (eap->cmdidx != CMD_def
3334 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003335 || (p[0] == 'c'
3336 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3337 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3338 && (STRNCMP(&p[3], "nge", 3) != 0
3339 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 || (p[0] == 'i'
3341 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003342 && (!ASCII_ISALPHA(p[2])
3343 || (p[2] == 's'
3344 && (!ASCII_ISALPHA(p[3])
3345 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 skip_until = vim_strsave((char_u *)".");
3347
Bram Moolenaare38eab22019-12-05 21:50:01 +01003348 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 arg = skipwhite(skiptowhite(p));
3350 if (arg[0] == '<' && arg[1] =='<'
3351 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003352 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3353 || ((p[2] == '3' || p[2] == 'x')
3354 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355 || (p[0] == 'p' && p[1] == 'e'
3356 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3357 || (p[0] == 't' && p[1] == 'c'
3358 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3359 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3360 && !ASCII_ISALPHA(p[3]))
3361 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3362 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3363 || (p[0] == 'm' && p[1] == 'z'
3364 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3365 ))
3366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003367 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003369 if (STRNCMP(p, "trim", 4) == 0)
3370 {
3371 // Ignore leading white space.
3372 p = skipwhite(p + 4);
3373 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003374 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003375 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 if (*p == NUL)
3377 skip_until = vim_strsave((char_u *)".");
3378 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003379 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003380 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003381 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003383
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003384 // Check for ":cmd v =<< [trim] EOF"
3385 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003386 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003387 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003388 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003389 if (*arg == '[')
3390 arg = vim_strchr(arg, ']');
3391 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003392 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003393 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3394 && arg[1] == '<' && arg[2] =='<');
3395
3396 if (!found)
3397 // skip over the argument after "cmd"
3398 arg = skipwhite(skiptowhite(arg));
3399 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003400 && (checkforcmd(&p, "let", 2)
3401 || checkforcmd(&p, "var", 3)
3402 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003403 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003404 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003405 p = skipwhite(arg + 3);
3406 if (STRNCMP(p, "trim", 4) == 0)
3407 {
3408 // Ignore leading white space.
3409 p = skipwhite(p + 4);
3410 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003411 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003412 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003413 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003414 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003415 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003416 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003417 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 }
3419
Bram Moolenaare38eab22019-12-05 21:50:01 +01003420 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423
Bram Moolenaare38eab22019-12-05 21:50:01 +01003424 // Copy the line to newly allocated memory. get_one_sourceline()
3425 // allocates 250 bytes per line, this saves 80% on average. The cost
3426 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003428 if (p == NULL)
3429 goto erret;
3430 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431
Bram Moolenaare38eab22019-12-05 21:50:01 +01003432 // Add NULL lines for continuation lines, so that the line count is
3433 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 while (sourcing_lnum_off-- > 0)
3435 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3436
Bram Moolenaare38eab22019-12-05 21:50:01 +01003437 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438 if (line_arg != NULL && *line_arg == NUL)
3439 line_arg = NULL;
3440 }
3441
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 // Don't define the function when skipping commands or when an error was
3443 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 if (eap->skip || did_emsg)
3445 goto erret;
3446
3447 /*
3448 * If there are no errors, add the function
3449 */
3450 if (fudi.fd_dict == NULL)
3451 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452 hashtab_T *ht;
3453
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 v = find_var(name, &ht, FALSE);
3455 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3456 {
3457 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3458 name);
3459 goto erret;
3460 }
3461
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003462 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003463 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003464 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003465 char_u *uname = untrans_function_name(name);
3466
3467 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3468 }
3469
3470 if (fp != NULL || import != NULL)
3471 {
3472 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003473
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003474 // Function can be replaced with "function!" and when sourcing the
3475 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003476 // A name that is used by an import can not be overruled.
3477 if (import != NULL
3478 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003479 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003480 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003481 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003482 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003483 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003484 else
3485 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 goto erret;
3487 }
3488 if (fp->uf_calls > 0)
3489 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003490 emsg_funcname(
3491 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 name);
3493 goto erret;
3494 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003495 if (fp->uf_refcount > 1)
3496 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003497 // This function is referenced somewhere, don't redefine it but
3498 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003499 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003500 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003501 fp = NULL;
3502 overwrite = TRUE;
3503 }
3504 else
3505 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003506 char_u *exp_name = fp->uf_name_exp;
3507
3508 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003509 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003510 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003511 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003512 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003514#ifdef FEAT_PROFILE
3515 fp->uf_profiling = FALSE;
3516 fp->uf_prof_initialized = FALSE;
3517#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003518 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003519 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 }
3521 }
3522 else
3523 {
3524 char numbuf[20];
3525
3526 fp = NULL;
3527 if (fudi.fd_newkey == NULL && !eap->forceit)
3528 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003529 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 goto erret;
3531 }
3532 if (fudi.fd_di == NULL)
3533 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003534 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003535 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 goto erret;
3537 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003538 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003539 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540 goto erret;
3541
Bram Moolenaare38eab22019-12-05 21:50:01 +01003542 // Give the function a sequential number. Can only be used with a
3543 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544 vim_free(name);
3545 sprintf(numbuf, "%d", ++func_nr);
3546 name = vim_strsave((char_u *)numbuf);
3547 if (name == NULL)
3548 goto erret;
3549 }
3550
3551 if (fp == NULL)
3552 {
3553 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3554 {
3555 int slen, plen;
3556 char_u *scriptname;
3557
Bram Moolenaare38eab22019-12-05 21:50:01 +01003558 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003560 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 {
3562 scriptname = autoload_name(name);
3563 if (scriptname != NULL)
3564 {
3565 p = vim_strchr(scriptname, '/');
3566 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003567 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003569 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 j = OK;
3571 vim_free(scriptname);
3572 }
3573 }
3574 if (j == FAIL)
3575 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003576 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 goto erret;
3578 }
3579 }
3580
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003581 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003582 if (fp == NULL)
3583 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003584 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003585 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586
3587 if (fudi.fd_dict != NULL)
3588 {
3589 if (fudi.fd_di == NULL)
3590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003591 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3593 if (fudi.fd_di == NULL)
3594 {
3595 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003596 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 goto erret;
3598 }
3599 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3600 {
3601 vim_free(fudi.fd_di);
3602 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003603 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 goto erret;
3605 }
3606 }
3607 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003608 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 clear_tv(&fudi.fd_di->di_tv);
3610 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612
Bram Moolenaare38eab22019-12-05 21:50:01 +01003613 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 flags |= FC_DICT;
3615 }
3616
Bram Moolenaare38eab22019-12-05 21:50:01 +01003617 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003618 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003619 if (overwrite)
3620 {
3621 hi = hash_find(&func_hashtab, name);
3622 hi->hi_key = UF2HIKEY(fp);
3623 }
3624 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 {
3626 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003627 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 goto erret;
3629 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003630 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 }
3632 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003633 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003634 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003635 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003636
3637 if (eap->cmdidx == CMD_def)
3638 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003639 int lnum_save = SOURCING_LNUM;
3640 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003641
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003642 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003643
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003644 // error messages are for the first function line
3645 SOURCING_LNUM = sourcing_lnum_top;
3646
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003647 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003648 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003649 int count = cstack->cs_idx + 1;
3650 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003651
3652 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003653 // a block that is visible now but not when the function is called
3654 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003655 fp->uf_block_ids = ALLOC_MULT(int, count);
3656 if (fp->uf_block_ids != NULL)
3657 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003658 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003659 sizeof(int) * count);
3660 fp->uf_block_depth = count;
3661 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003662
3663 // Set flag in each block to indicate a function was defined. This
3664 // is used to keep the variable when leaving the block, see
3665 // hide_script_var().
3666 for (i = 0; i <= cstack->cs_idx; ++i)
3667 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003668 }
3669
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003670 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003671 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003672 SOURCING_LNUM = lnum_save;
3673 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003674 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003675 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676
3677 // parse the return type, if any
3678 if (ret_type == NULL)
3679 fp->uf_ret_type = &t_void;
3680 else
3681 {
3682 p = ret_type;
3683 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3684 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003685 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003686 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003687 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003688 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003689
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003691 if ((flags & FC_CLOSURE) != 0)
3692 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003693 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003694 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003695 }
3696 else
3697 fp->uf_scoped = NULL;
3698
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 if (prof_def_func())
3701 func_do_profile(fp);
3702#endif
3703 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003704 if (sandbox)
3705 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003706 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003707 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708 fp->uf_flags = flags;
3709 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003710 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003711 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003712 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003713 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003714 if (is_export)
3715 {
3716 fp->uf_flags |= FC_EXPORT;
3717 // let ex_export() know the export worked.
3718 is_export = FALSE;
3719 }
3720
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003721 if (eap->cmdidx == CMD_def)
3722 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003723 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3724 // :func does not use Vim9 script syntax, even in a Vim9 script file
3725 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003726
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 goto ret_free;
3728
3729erret:
3730 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003731 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732errret_2:
3733 ga_clear_strings(&newlines);
3734ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003735 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003737 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003738 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003740 if (name != name_arg)
3741 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003742 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 did_emsg |= saved_did_emsg;
3744 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003745
3746 return fp;
3747}
3748
3749/*
3750 * ":function"
3751 */
3752 void
3753ex_function(exarg_T *eap)
3754{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003755 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003756}
3757
3758/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003759 * :defcompile - compile all :def functions in the current script that need to
3760 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003761 */
3762 void
3763ex_defcompile(exarg_T *eap UNUSED)
3764{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003765 long todo = (long)func_hashtab.ht_used;
3766 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003767 hashitem_T *hi;
3768 ufunc_T *ufunc;
3769
3770 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3771 {
3772 if (!HASHITEM_EMPTY(hi))
3773 {
3774 --todo;
3775 ufunc = HI2UF(hi);
3776 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003777 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3778 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003779 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003780 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003781
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003782 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003783 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003784 // a function has been added or removed, need to start over
3785 todo = (long)func_hashtab.ht_used;
3786 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003787 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003788 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003789 }
3790 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003791 }
3792 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793}
3794
3795/*
3796 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3797 * Return 2 if "p" starts with "s:".
3798 * Return 0 otherwise.
3799 */
3800 int
3801eval_fname_script(char_u *p)
3802{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003803 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3804 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3806 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3807 return 5;
3808 if (p[0] == 's' && p[1] == ':')
3809 return 2;
3810 return 0;
3811}
3812
3813 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003814translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815{
3816 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003817 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003818 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003819}
3820
3821/*
3822 * Return TRUE when "ufunc" has old-style "..." varargs
3823 * or named varargs "...name: type".
3824 */
3825 int
3826has_varargs(ufunc_T *ufunc)
3827{
3828 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829}
3830
3831/*
3832 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003833 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834 */
3835 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003836function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837{
3838 char_u *nm = name;
3839 char_u *p;
3840 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003841 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003842 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003844 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3845 if (no_deref)
3846 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003847 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 nm = skipwhite(nm);
3849
Bram Moolenaare38eab22019-12-05 21:50:01 +01003850 // Only accept "funcname", "funcname ", "funcname (..." and
3851 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003853 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 vim_free(p);
3855 return n;
3856}
3857
Bram Moolenaar113e1072019-01-20 15:30:40 +01003858#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859 char_u *
3860get_expanded_name(char_u *name, int check)
3861{
3862 char_u *nm = name;
3863 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003864 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003866 p = trans_function_name(&nm, &is_global, FALSE,
3867 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003869 if (p != NULL && *nm == NUL
3870 && (!check || translated_function_exists(p, is_global)))
3871 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872
3873 vim_free(p);
3874 return NULL;
3875}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003876#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878/*
3879 * Function given to ExpandGeneric() to obtain the list of user defined
3880 * function names.
3881 */
3882 char_u *
3883get_user_func_name(expand_T *xp, int idx)
3884{
3885 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003886 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 static hashitem_T *hi;
3888 ufunc_T *fp;
3889
3890 if (idx == 0)
3891 {
3892 done = 0;
3893 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003894 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003896 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897 {
3898 if (done++ > 0)
3899 ++hi;
3900 while (HASHITEM_EMPTY(hi))
3901 ++hi;
3902 fp = HI2UF(hi);
3903
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003904 // don't show dead, dict and lambda functions
3905 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003906 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003907 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908
3909 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003910 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911
3912 cat_func_name(IObuff, fp);
3913 if (xp->xp_context != EXPAND_USER_FUNC)
3914 {
3915 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003916 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 STRCAT(IObuff, ")");
3918 }
3919 return IObuff;
3920 }
3921 return NULL;
3922}
3923
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924/*
3925 * ":delfunction {name}"
3926 */
3927 void
3928ex_delfunction(exarg_T *eap)
3929{
3930 ufunc_T *fp = NULL;
3931 char_u *p;
3932 char_u *name;
3933 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003934 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935
3936 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003937 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 vim_free(fudi.fd_newkey);
3939 if (name == NULL)
3940 {
3941 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003942 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 return;
3944 }
3945 if (!ends_excmd(*skipwhite(p)))
3946 {
3947 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003948 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 return;
3950 }
3951 eap->nextcmd = check_nextcmd(p);
3952 if (eap->nextcmd != NULL)
3953 *p = NUL;
3954
3955 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003956 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 vim_free(name);
3958
3959 if (!eap->skip)
3960 {
3961 if (fp == NULL)
3962 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003963 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003964 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 return;
3966 }
3967 if (fp->uf_calls > 0)
3968 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003969 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 return;
3971 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003972 if (fp->uf_flags & FC_VIM9)
3973 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003974 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003975 return;
3976 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977
3978 if (fudi.fd_dict != NULL)
3979 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003980 // Delete the dict item that refers to the function, it will
3981 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3983 }
3984 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003985 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003986 // A normal function (not a numbered function or lambda) has a
3987 // refcount of 1 for the entry in the hashtable. When deleting
3988 // it and the refcount is more than one, it should be kept.
3989 // A numbered function and lambda should be kept if the refcount is
3990 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003991 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003992 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003993 // Function is still referenced somewhere. Don't free it but
3994 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003995 if (func_remove(fp))
3996 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003997 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003998 }
3999 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004000 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004001 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 }
4003}
4004
4005/*
4006 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004007 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 */
4009 void
4010func_unref(char_u *name)
4011{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004012 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004013
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004014 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004016 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004017 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004018 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004020 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004022 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004024 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004026 // Only delete it when it's not being used. Otherwise it's done
4027 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004028 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004029 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004030 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004031}
4032
4033/*
4034 * Unreference a Function: decrement the reference count and free it when it
4035 * becomes zero.
4036 */
4037 void
4038func_ptr_unref(ufunc_T *fp)
4039{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004040 if (fp != NULL && --fp->uf_refcount <= 0)
4041 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004042 // Only delete it when it's not being used. Otherwise it's done
4043 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004044 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004045 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 }
4047}
4048
4049/*
4050 * Count a reference to a Function.
4051 */
4052 void
4053func_ref(char_u *name)
4054{
4055 ufunc_T *fp;
4056
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004057 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004059 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004060 if (fp != NULL)
4061 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004063 // Only give an error for a numbered function.
4064 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004065 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004066}
4067
4068/*
4069 * Count a reference to a Function.
4070 */
4071 void
4072func_ptr_ref(ufunc_T *fp)
4073{
4074 if (fp != NULL)
4075 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076}
4077
4078/*
4079 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4080 * referenced from anywhere that is in use.
4081 */
4082 static int
4083can_free_funccal(funccall_T *fc, int copyID)
4084{
4085 return (fc->l_varlist.lv_copyID != copyID
4086 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004087 && fc->l_avars.dv_copyID != copyID
4088 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089}
4090
4091/*
4092 * ":return [expr]"
4093 */
4094 void
4095ex_return(exarg_T *eap)
4096{
4097 char_u *arg = eap->arg;
4098 typval_T rettv;
4099 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004100 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101
4102 if (current_funccal == NULL)
4103 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004104 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 return;
4106 }
4107
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004108 CLEAR_FIELD(evalarg);
4109 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4110
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 if (eap->skip)
4112 ++emsg_skip;
4113
4114 eap->nextcmd = NULL;
4115 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004116 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 {
4118 if (!eap->skip)
4119 returning = do_return(eap, FALSE, TRUE, &rettv);
4120 else
4121 clear_tv(&rettv);
4122 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004123 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 else if (!eap->skip)
4125 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004126 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004127 update_force_abort();
4128
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 /*
4130 * Return unless the expression evaluation has been cancelled due to an
4131 * aborting error, an interrupt, or an exception.
4132 */
4133 if (!aborting())
4134 returning = do_return(eap, FALSE, TRUE, NULL);
4135 }
4136
Bram Moolenaare38eab22019-12-05 21:50:01 +01004137 // When skipping or the return gets pending, advance to the next command
4138 // in this line (!returning). Otherwise, ignore the rest of the line.
4139 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 if (returning)
4141 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004142 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004143 eap->nextcmd = check_nextcmd(arg);
4144
4145 if (eap->skip)
4146 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004147 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148}
4149
4150/*
4151 * ":1,25call func(arg1, arg2)" function call.
4152 */
4153 void
4154ex_call(exarg_T *eap)
4155{
4156 char_u *arg = eap->arg;
4157 char_u *startarg;
4158 char_u *name;
4159 char_u *tofree;
4160 int len;
4161 typval_T rettv;
4162 linenr_T lnum;
4163 int doesrange;
4164 int failed = FALSE;
4165 funcdict_T fudi;
4166 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004167 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004168
Bram Moolenaare6b53242020-07-01 17:28:33 +02004169 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 if (eap->skip)
4171 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004172 // trans_function_name() doesn't work well when skipping, use eval0()
4173 // instead to skip to any following command, e.g. for:
4174 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004176 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 clear_tv(&rettv);
4178 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004179 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180 return;
4181 }
4182
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004183 tofree = trans_function_name(&arg, NULL, eap->skip,
4184 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 if (fudi.fd_newkey != NULL)
4186 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004187 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004188 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 vim_free(fudi.fd_newkey);
4190 }
4191 if (tofree == NULL)
4192 return;
4193
Bram Moolenaare38eab22019-12-05 21:50:01 +01004194 // Increase refcount on dictionary, it could get deleted when evaluating
4195 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196 if (fudi.fd_dict != NULL)
4197 ++fudi.fd_dict->dv_refcount;
4198
Bram Moolenaare38eab22019-12-05 21:50:01 +01004199 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4200 // contents. For VAR_PARTIAL get its partial, unless we already have one
4201 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 len = (int)STRLEN(tofree);
4203 name = deref_func_name(tofree, &len,
4204 partial != NULL ? NULL : &partial, FALSE);
4205
Bram Moolenaare38eab22019-12-05 21:50:01 +01004206 // Skip white space to allow ":call func ()". Not good, but required for
4207 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004209 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210
4211 if (*startarg != '(')
4212 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004213 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 goto end;
4215 }
4216
4217 /*
4218 * When skipping, evaluate the function once, to find the end of the
4219 * arguments.
4220 * When the function takes a range, this is discovered after the first
4221 * call, and the loop is broken.
4222 */
4223 if (eap->skip)
4224 {
4225 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004226 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 }
4228 else
4229 lnum = eap->line1;
4230 for ( ; lnum <= eap->line2; ++lnum)
4231 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004232 funcexe_T funcexe;
4233
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234 if (!eap->skip && eap->addr_count > 0)
4235 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004236 if (lnum > curbuf->b_ml.ml_line_count)
4237 {
4238 // If the function deleted lines or switched to another buffer
4239 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004240 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004241 break;
4242 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243 curwin->w_cursor.lnum = lnum;
4244 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004246 }
4247 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004248
Bram Moolenaara80faa82020-04-12 19:37:17 +02004249 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004250 funcexe.firstline = eap->line1;
4251 funcexe.lastline = eap->line2;
4252 funcexe.doesrange = &doesrange;
4253 funcexe.evaluate = !eap->skip;
4254 funcexe.partial = partial;
4255 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004256 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257 {
4258 failed = TRUE;
4259 break;
4260 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004261 if (has_watchexpr())
4262 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004264 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004265 if (handle_subscript(&arg, &rettv,
4266 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 {
4268 failed = TRUE;
4269 break;
4270 }
4271
4272 clear_tv(&rettv);
4273 if (doesrange || eap->skip)
4274 break;
4275
Bram Moolenaare38eab22019-12-05 21:50:01 +01004276 // Stop when immediately aborting on error, or when an interrupt
4277 // occurred or an exception was thrown but not caught.
4278 // get_func_tv() returned OK, so that the check for trailing
4279 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 if (aborting())
4281 break;
4282 }
4283 if (eap->skip)
4284 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004285 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286
Bram Moolenaare51bb172020-02-16 19:42:23 +01004287 // When inside :try we need to check for following "| catch".
4288 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004290 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004291 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004292 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004294 if (!failed)
4295 {
4296 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004297 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004298 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 }
4300 else
4301 eap->nextcmd = check_nextcmd(arg);
4302 }
4303
4304end:
4305 dict_unref(fudi.fd_dict);
4306 vim_free(tofree);
4307}
4308
4309/*
4310 * Return from a function. Possibly makes the return pending. Also called
4311 * for a pending return at the ":endtry" or after returning from an extra
4312 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4313 * when called due to a ":return" command. "rettv" may point to a typval_T
4314 * with the return rettv. Returns TRUE when the return can be carried out,
4315 * FALSE when the return gets pending.
4316 */
4317 int
4318do_return(
4319 exarg_T *eap,
4320 int reanimate,
4321 int is_cmd,
4322 void *rettv)
4323{
4324 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004325 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004326
4327 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004328 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 current_funccal->returned = FALSE;
4330
4331 /*
4332 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4333 * not in its finally clause (which then is to be executed next) is found.
4334 * In this case, make the ":return" pending for execution at the ":endtry".
4335 * Otherwise, return normally.
4336 */
4337 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4338 if (idx >= 0)
4339 {
4340 cstack->cs_pending[idx] = CSTP_RETURN;
4341
4342 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004343 // A pending return again gets pending. "rettv" points to an
4344 // allocated variable with the rettv of the original ":return"'s
4345 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 cstack->cs_rettv[idx] = rettv;
4347 else
4348 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004349 // When undoing a return in order to make it pending, get the stored
4350 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 if (reanimate)
4352 rettv = current_funccal->rettv;
4353
4354 if (rettv != NULL)
4355 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004356 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4358 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4359 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004360 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 }
4362 else
4363 cstack->cs_rettv[idx] = NULL;
4364
4365 if (reanimate)
4366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004367 // The pending return value could be overwritten by a ":return"
4368 // without argument in a finally clause; reset the default
4369 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370 current_funccal->rettv->v_type = VAR_NUMBER;
4371 current_funccal->rettv->vval.v_number = 0;
4372 }
4373 }
4374 report_make_pending(CSTP_RETURN, rettv);
4375 }
4376 else
4377 {
4378 current_funccal->returned = TRUE;
4379
Bram Moolenaare38eab22019-12-05 21:50:01 +01004380 // If the return is carried out now, store the return value. For
4381 // a return immediately after reanimation, the value is already
4382 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 if (!reanimate && rettv != NULL)
4384 {
4385 clear_tv(current_funccal->rettv);
4386 *current_funccal->rettv = *(typval_T *)rettv;
4387 if (!is_cmd)
4388 vim_free(rettv);
4389 }
4390 }
4391
4392 return idx < 0;
4393}
4394
4395/*
4396 * Free the variable with a pending return value.
4397 */
4398 void
4399discard_pending_return(void *rettv)
4400{
4401 free_tv((typval_T *)rettv);
4402}
4403
4404/*
4405 * Generate a return command for producing the value of "rettv". The result
4406 * is an allocated string. Used by report_pending() for verbose messages.
4407 */
4408 char_u *
4409get_return_cmd(void *rettv)
4410{
4411 char_u *s = NULL;
4412 char_u *tofree = NULL;
4413 char_u numbuf[NUMBUFLEN];
4414
4415 if (rettv != NULL)
4416 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4417 if (s == NULL)
4418 s = (char_u *)"";
4419
4420 STRCPY(IObuff, ":return ");
4421 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4422 if (STRLEN(s) + 8 >= IOSIZE)
4423 STRCPY(IObuff + IOSIZE - 4, "...");
4424 vim_free(tofree);
4425 return vim_strsave(IObuff);
4426}
4427
4428/*
4429 * Get next function line.
4430 * Called by do_cmdline() to get the next line.
4431 * Returns allocated string, or NULL for end of function.
4432 */
4433 char_u *
4434get_func_line(
4435 int c UNUSED,
4436 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004437 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004438 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439{
4440 funccall_T *fcp = (funccall_T *)cookie;
4441 ufunc_T *fp = fcp->func;
4442 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004443 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 if (fcp->dbg_tick != debug_tick)
4447 {
4448 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004449 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 fcp->dbg_tick = debug_tick;
4451 }
4452#ifdef FEAT_PROFILE
4453 if (do_profiling == PROF_YES)
4454 func_line_end(cookie);
4455#endif
4456
4457 gap = &fp->uf_lines;
4458 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4459 || fcp->returned)
4460 retval = NULL;
4461 else
4462 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004463 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 while (fcp->linenr < gap->ga_len
4465 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4466 ++fcp->linenr;
4467 if (fcp->linenr >= gap->ga_len)
4468 retval = NULL;
4469 else
4470 {
4471 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004472 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473#ifdef FEAT_PROFILE
4474 if (do_profiling == PROF_YES)
4475 func_line_start(cookie);
4476#endif
4477 }
4478 }
4479
Bram Moolenaare38eab22019-12-05 21:50:01 +01004480 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004481 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004483 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004484 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004486 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 fcp->dbg_tick = debug_tick;
4488 }
4489
4490 return retval;
4491}
4492
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493/*
4494 * Return TRUE if the currently active function should be ended, because a
4495 * return was encountered or an error occurred. Used inside a ":while".
4496 */
4497 int
4498func_has_ended(void *cookie)
4499{
4500 funccall_T *fcp = (funccall_T *)cookie;
4501
Bram Moolenaare38eab22019-12-05 21:50:01 +01004502 // Ignore the "abort" flag if the abortion behavior has been changed due to
4503 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4505 || fcp->returned);
4506}
4507
4508/*
4509 * return TRUE if cookie indicates a function which "abort"s on errors.
4510 */
4511 int
4512func_has_abort(
4513 void *cookie)
4514{
4515 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4516}
4517
4518
4519/*
4520 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4521 * Don't do this when "Func" is already a partial that was bound
4522 * explicitly (pt_auto is FALSE).
4523 * Changes "rettv" in-place.
4524 * Returns the updated "selfdict_in".
4525 */
4526 dict_T *
4527make_partial(dict_T *selfdict_in, typval_T *rettv)
4528{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004529 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530 char_u *tofree = NULL;
4531 ufunc_T *fp;
4532 char_u fname_buf[FLEN_FIXED + 1];
4533 int error;
4534 dict_T *selfdict = selfdict_in;
4535
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004536 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4537 fp = rettv->vval.v_partial->pt_func;
4538 else
4539 {
4540 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4541 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004542 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004543 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004544 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004545 vim_free(tofree);
4546 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547
4548 if (fp != NULL && (fp->uf_flags & FC_DICT))
4549 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004550 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551
4552 if (pt != NULL)
4553 {
4554 pt->pt_refcount = 1;
4555 pt->pt_dict = selfdict;
4556 pt->pt_auto = TRUE;
4557 selfdict = NULL;
4558 if (rettv->v_type == VAR_FUNC)
4559 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004560 // Just a function: Take over the function name and use
4561 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 pt->pt_name = rettv->vval.v_string;
4563 }
4564 else
4565 {
4566 partial_T *ret_pt = rettv->vval.v_partial;
4567 int i;
4568
Bram Moolenaare38eab22019-12-05 21:50:01 +01004569 // Partial: copy the function name, use selfdict and copy
4570 // args. Can't take over name or args, the partial might
4571 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004572 if (ret_pt->pt_name != NULL)
4573 {
4574 pt->pt_name = vim_strsave(ret_pt->pt_name);
4575 func_ref(pt->pt_name);
4576 }
4577 else
4578 {
4579 pt->pt_func = ret_pt->pt_func;
4580 func_ptr_ref(pt->pt_func);
4581 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 if (ret_pt->pt_argc > 0)
4583 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004584 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004586 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 pt->pt_argc = 0;
4588 else
4589 {
4590 pt->pt_argc = ret_pt->pt_argc;
4591 for (i = 0; i < pt->pt_argc; i++)
4592 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4593 }
4594 }
4595 partial_unref(ret_pt);
4596 }
4597 rettv->v_type = VAR_PARTIAL;
4598 rettv->vval.v_partial = pt;
4599 }
4600 }
4601 return selfdict;
4602}
4603
4604/*
4605 * Return the name of the executed function.
4606 */
4607 char_u *
4608func_name(void *cookie)
4609{
4610 return ((funccall_T *)cookie)->func->uf_name;
4611}
4612
4613/*
4614 * Return the address holding the next breakpoint line for a funccall cookie.
4615 */
4616 linenr_T *
4617func_breakpoint(void *cookie)
4618{
4619 return &((funccall_T *)cookie)->breakpoint;
4620}
4621
4622/*
4623 * Return the address holding the debug tick for a funccall cookie.
4624 */
4625 int *
4626func_dbg_tick(void *cookie)
4627{
4628 return &((funccall_T *)cookie)->dbg_tick;
4629}
4630
4631/*
4632 * Return the nesting level for a funccall cookie.
4633 */
4634 int
4635func_level(void *cookie)
4636{
4637 return ((funccall_T *)cookie)->level;
4638}
4639
4640/*
4641 * Return TRUE when a function was ended by a ":return" command.
4642 */
4643 int
4644current_func_returned(void)
4645{
4646 return current_funccal->returned;
4647}
4648
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649 int
4650free_unref_funccal(int copyID, int testing)
4651{
4652 int did_free = FALSE;
4653 int did_free_funccal = FALSE;
4654 funccall_T *fc, **pfc;
4655
4656 for (pfc = &previous_funccal; *pfc != NULL; )
4657 {
4658 if (can_free_funccal(*pfc, copyID))
4659 {
4660 fc = *pfc;
4661 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004662 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663 did_free = TRUE;
4664 did_free_funccal = TRUE;
4665 }
4666 else
4667 pfc = &(*pfc)->caller;
4668 }
4669 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004670 // When a funccal was freed some more items might be garbage
4671 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 (void)garbage_collect(testing);
4673
4674 return did_free;
4675}
4676
4677/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004678 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 */
4680 static funccall_T *
4681get_funccal(void)
4682{
4683 int i;
4684 funccall_T *funccal;
4685 funccall_T *temp_funccal;
4686
4687 funccal = current_funccal;
4688 if (debug_backtrace_level > 0)
4689 {
4690 for (i = 0; i < debug_backtrace_level; i++)
4691 {
4692 temp_funccal = funccal->caller;
4693 if (temp_funccal)
4694 funccal = temp_funccal;
4695 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004696 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697 debug_backtrace_level = i;
4698 }
4699 }
4700 return funccal;
4701}
4702
4703/*
4704 * Return the hashtable used for local variables in the current funccal.
4705 * Return NULL if there is no current funccal.
4706 */
4707 hashtab_T *
4708get_funccal_local_ht()
4709{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004710 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 return NULL;
4712 return &get_funccal()->l_vars.dv_hashtab;
4713}
4714
4715/*
4716 * Return the l: scope variable.
4717 * Return NULL if there is no current funccal.
4718 */
4719 dictitem_T *
4720get_funccal_local_var()
4721{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004722 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 return NULL;
4724 return &get_funccal()->l_vars_var;
4725}
4726
4727/*
4728 * Return the hashtable used for argument in the current funccal.
4729 * Return NULL if there is no current funccal.
4730 */
4731 hashtab_T *
4732get_funccal_args_ht()
4733{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004734 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 return NULL;
4736 return &get_funccal()->l_avars.dv_hashtab;
4737}
4738
4739/*
4740 * Return the a: scope variable.
4741 * Return NULL if there is no current funccal.
4742 */
4743 dictitem_T *
4744get_funccal_args_var()
4745{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004746 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004748 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749}
4750
4751/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 * List function variables, if there is a function.
4753 */
4754 void
4755list_func_vars(int *first)
4756{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004757 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004758 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004759 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004760}
4761
4762/*
4763 * If "ht" is the hashtable for local variables in the current funccal, return
4764 * the dict that contains it.
4765 * Otherwise return NULL.
4766 */
4767 dict_T *
4768get_current_funccal_dict(hashtab_T *ht)
4769{
4770 if (current_funccal != NULL
4771 && ht == &current_funccal->l_vars.dv_hashtab)
4772 return &current_funccal->l_vars;
4773 return NULL;
4774}
4775
4776/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004777 * Search hashitem in parent scope.
4778 */
4779 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004780find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004781{
4782 funccall_T *old_current_funccal = current_funccal;
4783 hashtab_T *ht;
4784 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004785 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004786
4787 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4788 return NULL;
4789
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004790 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004791 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004792 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004793 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004794 ht = find_var_ht(name, &varname);
4795 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004796 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004797 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004798 if (!HASHITEM_EMPTY(hi))
4799 {
4800 *pht = ht;
4801 break;
4802 }
4803 }
4804 if (current_funccal == current_funccal->func->uf_scoped)
4805 break;
4806 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004807 }
4808 current_funccal = old_current_funccal;
4809
4810 return hi;
4811}
4812
4813/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004814 * Search variable in parent scope.
4815 */
4816 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004817find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004818{
4819 dictitem_T *v = NULL;
4820 funccall_T *old_current_funccal = current_funccal;
4821 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004822 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004823
4824 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4825 return NULL;
4826
Bram Moolenaare38eab22019-12-05 21:50:01 +01004827 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004828 current_funccal = current_funccal->func->uf_scoped;
4829 while (current_funccal)
4830 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004831 ht = find_var_ht(name, &varname);
4832 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004833 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004834 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004835 if (v != NULL)
4836 break;
4837 }
4838 if (current_funccal == current_funccal->func->uf_scoped)
4839 break;
4840 current_funccal = current_funccal->func->uf_scoped;
4841 }
4842 current_funccal = old_current_funccal;
4843
4844 return v;
4845}
4846
4847/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 * Set "copyID + 1" in previous_funccal and callers.
4849 */
4850 int
4851set_ref_in_previous_funccal(int copyID)
4852{
4853 int abort = FALSE;
4854 funccall_T *fc;
4855
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004856 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004858 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004859 abort = abort
4860 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4861 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004862 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 }
4864 return abort;
4865}
4866
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004867 static int
4868set_ref_in_funccal(funccall_T *fc, int copyID)
4869{
4870 int abort = FALSE;
4871
4872 if (fc->fc_copyID != copyID)
4873 {
4874 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004875 abort = abort
4876 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4877 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004878 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004879 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004880 }
4881 return abort;
4882}
4883
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004884/*
4885 * Set "copyID" in all local vars and arguments in the call stack.
4886 */
4887 int
4888set_ref_in_call_stack(int copyID)
4889{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004890 int abort = FALSE;
4891 funccall_T *fc;
4892 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004893
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004894 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004895 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004896
4897 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004898 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4899 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004900 abort = abort || set_ref_in_funccal(fc, copyID);
4901
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004902 return abort;
4903}
4904
4905/*
4906 * Set "copyID" in all functions available by name.
4907 */
4908 int
4909set_ref_in_functions(int copyID)
4910{
4911 int todo;
4912 hashitem_T *hi = NULL;
4913 int abort = FALSE;
4914 ufunc_T *fp;
4915
4916 todo = (int)func_hashtab.ht_used;
4917 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004919 if (!HASHITEM_EMPTY(hi))
4920 {
4921 --todo;
4922 fp = HI2UF(hi);
4923 if (!func_name_refcount(fp->uf_name))
4924 abort = abort || set_ref_in_func(NULL, fp, copyID);
4925 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004926 }
4927 return abort;
4928}
4929
4930/*
4931 * Set "copyID" in all function arguments.
4932 */
4933 int
4934set_ref_in_func_args(int copyID)
4935{
4936 int i;
4937 int abort = FALSE;
4938
4939 for (i = 0; i < funcargs.ga_len; ++i)
4940 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4941 copyID, NULL, NULL);
4942 return abort;
4943}
4944
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004945/*
4946 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004947 * Returns TRUE if setting references failed somehow.
4948 */
4949 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004950set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004951{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004952 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004953 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004954 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004955 char_u fname_buf[FLEN_FIXED + 1];
4956 char_u *tofree = NULL;
4957 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004958 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004959
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004960 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004961 return FALSE;
4962
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004963 if (fp_in == NULL)
4964 {
4965 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004966 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004967 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004968 if (fp != NULL)
4969 {
4970 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004971 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004972 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004973
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004974 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004975 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004976}
4977
Bram Moolenaare38eab22019-12-05 21:50:01 +01004978#endif // FEAT_EVAL