blob: ff19afd40b3ff55d4907d45c5a5821476dd7233b [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 Moolenaarcd45ed02020-12-22 17:35:54 +01001263 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001264}
1265
1266/*
1267 * Free a function and remove it from the list of functions. Does not free
1268 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001269 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001270 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001271 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001272 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001273func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001274{
1275 // Only remove it when not done already, otherwise we would remove a newer
1276 // version of the function with the same name.
1277 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1278 func_remove(fp);
1279
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001280 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001281 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001282 if (fp->uf_dfunc_idx > 0)
1283 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001284 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001285 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001286 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001287 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001288 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001289}
1290
1291/*
1292 * Free all things that a function contains and free the function itself.
1293 * When "force" is TRUE we are exiting.
1294 */
1295 static void
1296func_clear_free(ufunc_T *fp, int force)
1297{
1298 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001299 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1300 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001301 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001302 else
1303 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001304}
1305
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001306/*
1307 * Copy already defined function "lambda" to a new function with name "global".
1308 * This is for when a compiled function defines a global function.
1309 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001310 int
1311copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001312{
1313 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001314 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001315
1316 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001317 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001318 semsg(_(e_lambda_function_not_found_str), lambda);
1319 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001320 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001321
1322 // TODO: handle ! to overwrite
1323 fp = find_func(global, TRUE, NULL);
1324 if (fp != NULL)
1325 {
1326 semsg(_(e_funcexts), global);
1327 return FAIL;
1328 }
1329
1330 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1331 if (fp == NULL)
1332 return FAIL;
1333
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;
1338 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1339 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1340 == FAIL
1341 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1342 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 }
1368 fp->uf_ret_type = ufunc->uf_ret_type;
1369
1370 fp->uf_refcount = 1;
1371 STRCPY(fp->uf_name, global);
1372 hash_add(&func_hashtab, UF2HIKEY(fp));
1373
1374 // the referenced dfunc_T is now used one more time
1375 link_def_function(fp);
1376
1377 // Create a partial to store the context of the function, if not done
1378 // already.
1379 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1380 {
1381 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1382
1383 if (pt == NULL)
1384 goto failed;
1385 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
1386 goto failed;
1387 ufunc->uf_partial = pt;
1388 --pt->pt_refcount; // not referenced here yet
1389 }
1390 if (ufunc->uf_partial != NULL)
1391 {
1392 fp->uf_partial = ufunc->uf_partial;
1393 ++fp->uf_partial->pt_refcount;
1394 }
1395
1396 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001397
1398failed:
1399 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001400 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001401}
1402
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001403static int funcdepth = 0;
1404
1405/*
1406 * Increment the function call depth count.
1407 * Return FAIL when going over 'maxfuncdepth'.
1408 * Otherwise return OK, must call funcdepth_decrement() later!
1409 */
1410 int
1411funcdepth_increment(void)
1412{
1413 if (funcdepth >= p_mfd)
1414 {
1415 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1416 return FAIL;
1417 }
1418 ++funcdepth;
1419 return OK;
1420}
1421
1422 void
1423funcdepth_decrement(void)
1424{
1425 --funcdepth;
1426}
1427
1428/*
1429 * Get the current function call depth.
1430 */
1431 int
1432funcdepth_get(void)
1433{
1434 return funcdepth;
1435}
1436
1437/*
1438 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001439 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001440 * times as funcdepth_increment().
1441 */
1442 void
1443funcdepth_restore(int depth)
1444{
1445 funcdepth = depth;
1446}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001447
1448/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449 * Call a user function.
1450 */
1451 static void
1452call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001453 ufunc_T *fp, // pointer to function
1454 int argcount, // nr of args
1455 typval_T *argvars, // arguments
1456 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001457 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001458 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001459{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001460 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001461 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 funccall_T *fc;
1463 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001464 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001466 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467 int i;
1468 int ai;
1469 int islambda = FALSE;
1470 char_u numbuf[NUMBUFLEN];
1471 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001472#ifdef FEAT_PROFILE
1473 proftime_T wait_start;
1474 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001475 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001477 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001479 // If depth of calling is getting too high, don't execute the function.
1480 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482 rettv->v_type = VAR_NUMBER;
1483 rettv->vval.v_number = -1;
1484 return;
1485 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486
Bram Moolenaare38eab22019-12-05 21:50:01 +01001487 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001489 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001490 if (fc == NULL)
1491 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 fc->caller = current_funccal;
1493 current_funccal = fc;
1494 fc->func = fp;
1495 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001497 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1499 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001500 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001501 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001502 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001503
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001504 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001505 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001506 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001507 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001508 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001509 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001510 free_funccal(fc);
1511 return;
1512 }
1513
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1515 islambda = TRUE;
1516
1517 /*
1518 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1519 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1520 * each argument variable and saves a lot of time.
1521 */
1522 /*
1523 * Init l: variables.
1524 */
1525 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1526 if (selfdict != NULL)
1527 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001528 // Set l:self to "selfdict". Use "name" to avoid a warning from
1529 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001530 v = &fc->fixvar[fixvar_idx++].var;
1531 name = v->di_key;
1532 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001533 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1535 v->di_tv.v_type = VAR_DICT;
1536 v->di_tv.v_lock = 0;
1537 v->di_tv.vval.v_dict = selfdict;
1538 ++selfdict->dv_refcount;
1539 }
1540
1541 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001542 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001543 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 * Set a:000 to a list with room for the "..." arguments.
1545 */
1546 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001547 if ((fp->uf_flags & FC_NOARGS) == 0)
1548 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001549 (varnumber_T)(argcount >= fp->uf_args.ga_len
1550 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001551 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001552 if ((fp->uf_flags & FC_NOARGS) == 0)
1553 {
1554 // Use "name" to avoid a warning from some compiler that checks the
1555 // destination size.
1556 v = &fc->fixvar[fixvar_idx++].var;
1557 name = v->di_key;
1558 STRCPY(name, "000");
1559 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1560 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1561 v->di_tv.v_type = VAR_LIST;
1562 v->di_tv.v_lock = VAR_FIXED;
1563 v->di_tv.vval.v_list = &fc->l_varlist;
1564 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001565 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1567 fc->l_varlist.lv_lock = VAR_FIXED;
1568
1569 /*
1570 * Set a:firstline to "firstline" and a:lastline to "lastline".
1571 * Set a:name to named arguments.
1572 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001573 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001575 if ((fp->uf_flags & FC_NOARGS) == 0)
1576 {
1577 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001578 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001579 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001580 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001581 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001582 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583 {
1584 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001585 typval_T def_rettv;
1586 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587
1588 ai = i - fp->uf_args.ga_len;
1589 if (ai < 0)
1590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001591 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001592 name = FUNCARG(fp, i);
1593 if (islambda)
1594 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001595
1596 // evaluate named argument default expression
1597 isdefault = ai + fp->uf_def_args.ga_len >= 0
1598 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1599 && argvars[i].vval.v_number == VVAL_NONE));
1600 if (isdefault)
1601 {
1602 char_u *default_expr = NULL;
1603 def_rettv.v_type = VAR_NUMBER;
1604 def_rettv.vval.v_number = -1;
1605
1606 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1607 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001608 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001609 {
1610 default_arg_err = 1;
1611 break;
1612 }
1613 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614 }
1615 else
1616 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001617 if ((fp->uf_flags & FC_NOARGS) != 0)
1618 // Bail out if no a: arguments used (in lambda).
1619 break;
1620
Bram Moolenaare38eab22019-12-05 21:50:01 +01001621 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 sprintf((char *)numbuf, "%d", ai + 1);
1623 name = numbuf;
1624 }
1625 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1626 {
1627 v = &fc->fixvar[fixvar_idx++].var;
1628 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001629 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630 }
1631 else
1632 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001633 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 if (v == NULL)
1635 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001636 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001639 // Note: the values are copied directly to avoid alloc/free.
1640 // "argvars" must have VAR_FIXED for v_lock.
1641 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 v->di_tv.v_lock = VAR_FIXED;
1643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644 if (addlocal)
1645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001646 // Named arguments should be accessed without the "a:" prefix in
1647 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001648 copy_tv(&v->di_tv, &v->di_tv);
1649 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001651 else
1652 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653
1654 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1655 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001656 listitem_T *li = &fc->l_listitems[ai];
1657
1658 li->li_tv = argvars[i];
1659 li->li_tv.v_lock = VAR_FIXED;
1660 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 }
1662 }
1663
Bram Moolenaare38eab22019-12-05 21:50:01 +01001664 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001666
1667 if (fp->uf_flags & FC_SANDBOX)
1668 {
1669 using_sandbox = TRUE;
1670 ++sandbox;
1671 }
1672
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001673 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001674 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001675 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001676 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001677 ++no_wait_return;
1678 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001680 smsg(_("calling %s"), SOURCING_NAME);
1681 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001683 char_u buf[MSG_BUF_LEN];
1684 char_u numbuf2[NUMBUFLEN];
1685 char_u *tofree;
1686 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001688 msg_puts("(");
1689 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001691 if (i > 0)
1692 msg_puts(", ");
1693 if (argvars[i].v_type == VAR_NUMBER)
1694 msg_outnum((long)argvars[i].vval.v_number);
1695 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001697 // Do not want errors such as E724 here.
1698 ++emsg_off;
1699 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1700 --emsg_off;
1701 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001702 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001703 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001704 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001705 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1706 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001708 msg_puts((char *)s);
1709 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 }
1711 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001712 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001713 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001715 msg_puts("\n"); // don't overwrite this either
1716
1717 verbose_leave_scroll();
1718 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 }
1720#ifdef FEAT_PROFILE
1721 if (do_profiling == PROF_YES)
1722 {
1723 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001724 {
1725 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001727 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728 if (fp->uf_profiling
1729 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1730 {
1731 ++fp->uf_tm_count;
1732 profile_start(&call_start);
1733 profile_zero(&fp->uf_tm_children);
1734 }
1735 script_prof_save(&wait_start);
1736 }
1737#endif
1738
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001739 save_current_sctx = current_sctx;
1740 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 save_did_emsg = did_emsg;
1742 did_emsg = FALSE;
1743
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001744 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1745 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001746 else if (islambda)
1747 {
1748 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1749
1750 // A Lambda always has the command "return {expr}". It is much faster
1751 // to evaluate {expr} directly.
1752 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001753 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001754 --ex_nesting_level;
1755 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001756 else
1757 // call do_cmdline() to execute the lines
1758 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1760
1761 --RedrawingDisabled;
1762
Bram Moolenaare38eab22019-12-05 21:50:01 +01001763 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1765 {
1766 clear_tv(rettv);
1767 rettv->v_type = VAR_NUMBER;
1768 rettv->vval.v_number = -1;
1769 }
1770
1771#ifdef FEAT_PROFILE
1772 if (do_profiling == PROF_YES && (fp->uf_profiling
1773 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1774 {
1775 profile_end(&call_start);
1776 profile_sub_wait(&wait_start, &call_start);
1777 profile_add(&fp->uf_tm_total, &call_start);
1778 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1779 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1780 {
1781 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1782 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1783 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001784 if (started_profiling)
1785 // make a ":profdel func" stop profiling the function
1786 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 }
1788#endif
1789
Bram Moolenaare38eab22019-12-05 21:50:01 +01001790 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001791 if (p_verbose >= 12)
1792 {
1793 ++no_wait_return;
1794 verbose_enter_scroll();
1795
1796 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001797 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001798 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001799 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800 (long)fc->rettv->vval.v_number);
1801 else
1802 {
1803 char_u buf[MSG_BUF_LEN];
1804 char_u numbuf2[NUMBUFLEN];
1805 char_u *tofree;
1806 char_u *s;
1807
Bram Moolenaare38eab22019-12-05 21:50:01 +01001808 // The value may be very long. Skip the middle part, so that we
1809 // have some idea how it starts and ends. smsg() would always
1810 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811 ++emsg_off;
1812 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1813 --emsg_off;
1814 if (s != NULL)
1815 {
1816 if (vim_strsize(s) > MSG_BUF_CLEN)
1817 {
1818 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1819 s = buf;
1820 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001821 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 vim_free(tofree);
1823 }
1824 }
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
Bram Moolenaare31ee862020-01-07 20:59:34 +01001831 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001832 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001833 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834#ifdef FEAT_PROFILE
1835 if (do_profiling == PROF_YES)
1836 script_prof_restore(&wait_start);
1837#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001838 if (using_sandbox)
1839 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001840
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001841 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 {
1843 ++no_wait_return;
1844 verbose_enter_scroll();
1845
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001846 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001847 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848
1849 verbose_leave_scroll();
1850 --no_wait_return;
1851 }
1852
1853 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001854 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001855 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856}
1857
1858/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001859 * Check the argument count for user function "fp".
1860 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1861 */
1862 int
1863check_user_func_argcount(ufunc_T *fp, int argcount)
1864{
1865 int regular_args = fp->uf_args.ga_len;
1866
1867 if (argcount < regular_args - fp->uf_def_args.ga_len)
1868 return FCERR_TOOFEW;
1869 else if (!has_varargs(fp) && argcount > regular_args)
1870 return FCERR_TOOMANY;
1871 return FCERR_UNKNOWN;
1872}
1873
1874/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001875 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001876 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001877 int
1878call_user_func_check(
1879 ufunc_T *fp,
1880 int argcount,
1881 typval_T *argvars,
1882 typval_T *rettv,
1883 funcexe_T *funcexe,
1884 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001885{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001886 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001887
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1889 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01001890 error = check_user_func_argcount(fp, argcount);
1891 if (error != FCERR_UNKNOWN)
1892 return error;
1893 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001894 error = FCERR_DICT;
1895 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001896 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001897 int did_save_redo = FALSE;
1898 save_redo_T save_redo;
1899
1900 /*
1901 * Call the user function.
1902 * Save and restore search patterns, script variables and
1903 * redo buffer.
1904 */
1905 save_search_patterns();
1906 if (!ins_compl_active())
1907 {
1908 saveRedobuff(&save_redo);
1909 did_save_redo = TRUE;
1910 }
1911 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001912 call_user_func(fp, argcount, argvars, rettv, funcexe,
1913 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001914 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1915 // Function was unreferenced while being used, free it now.
1916 func_clear_free(fp, FALSE);
1917 if (did_save_redo)
1918 restoreRedobuff(&save_redo);
1919 restore_search_patterns();
1920 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001921 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001922 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001923}
1924
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001925static funccal_entry_T *funccal_stack = NULL;
1926
1927/*
1928 * Save the current function call pointer, and set it to NULL.
1929 * Used when executing autocommands and for ":source".
1930 */
1931 void
1932save_funccal(funccal_entry_T *entry)
1933{
1934 entry->top_funccal = current_funccal;
1935 entry->next = funccal_stack;
1936 funccal_stack = entry;
1937 current_funccal = NULL;
1938}
1939
1940 void
1941restore_funccal(void)
1942{
1943 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001944 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001945 else
1946 {
1947 current_funccal = funccal_stack->top_funccal;
1948 funccal_stack = funccal_stack->next;
1949 }
1950}
1951
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001952 funccall_T *
1953get_current_funccal(void)
1954{
1955 return current_funccal;
1956}
1957
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001958/*
1959 * Mark all functions of script "sid" as deleted.
1960 */
1961 void
1962delete_script_functions(int sid)
1963{
1964 hashitem_T *hi;
1965 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001966 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001967 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001968 size_t len;
1969
1970 buf[0] = K_SPECIAL;
1971 buf[1] = KS_EXTRA;
1972 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001973 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001974 len = STRLEN(buf);
1975
Bram Moolenaarce658352020-07-31 23:47:12 +02001976 while (todo > 0)
1977 {
1978 todo = func_hashtab.ht_used;
1979 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1980 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001981 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001982 fp = HI2UF(hi);
1983 if (STRNCMP(fp->uf_name, buf, len) == 0)
1984 {
1985 int changed = func_hashtab.ht_changed;
1986
1987 fp->uf_flags |= FC_DEAD;
1988 func_clear(fp, TRUE);
1989 // When clearing a function another function can be cleared
1990 // as a side effect. When that happens start over.
1991 if (changed != func_hashtab.ht_changed)
1992 break;
1993 }
1994 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001995 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001996 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001997}
1998
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001999#if defined(EXITFREE) || defined(PROTO)
2000 void
2001free_all_functions(void)
2002{
2003 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002004 ufunc_T *fp;
2005 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002006 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002007 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002008
Bram Moolenaare38eab22019-12-05 21:50:01 +01002009 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002010 while (current_funccal != NULL)
2011 {
2012 clear_tv(current_funccal->rettv);
2013 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002014 if (current_funccal == NULL && funccal_stack != NULL)
2015 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002016 }
2017
Bram Moolenaare38eab22019-12-05 21:50:01 +01002018 // First clear what the functions contain. Since this may lower the
2019 // reference count of a function, it may also free a function and change
2020 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002021 while (todo > 0)
2022 {
2023 todo = func_hashtab.ht_used;
2024 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2025 if (!HASHITEM_EMPTY(hi))
2026 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 // clear the def function index now
2028 fp = HI2UF(hi);
2029 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002030 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031
Bram Moolenaare38eab22019-12-05 21:50:01 +01002032 // Only free functions that are not refcounted, those are
2033 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002034 if (func_name_refcount(fp->uf_name))
2035 ++skipped;
2036 else
2037 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002038 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002039 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002040 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002041 {
2042 skipped = 0;
2043 break;
2044 }
2045 }
2046 --todo;
2047 }
2048 }
2049
Bram Moolenaare38eab22019-12-05 21:50:01 +01002050 // Now actually free the functions. Need to start all over every time,
2051 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002052 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002053 while (func_hashtab.ht_used > skipped)
2054 {
2055 todo = func_hashtab.ht_used;
2056 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002057 if (!HASHITEM_EMPTY(hi))
2058 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002059 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002060 // Only free functions that are not refcounted, those are
2061 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002062 fp = HI2UF(hi);
2063 if (func_name_refcount(fp->uf_name))
2064 ++skipped;
2065 else
2066 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002067 if (func_free(fp, FALSE) == OK)
2068 {
2069 skipped = 0;
2070 break;
2071 }
2072 // did not actually free it
2073 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002074 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002075 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002076 }
2077 if (skipped == 0)
2078 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002079
2080 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002081}
2082#endif
2083
2084/*
2085 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002086 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002087 * "len" is the length of "name", or -1 for NUL terminated.
2088 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002089 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002090builtin_function(char_u *name, int len)
2091{
2092 char_u *p;
2093
Bram Moolenaara26b9702020-04-18 19:53:28 +02002094 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002095 return FALSE;
2096 p = vim_strchr(name, AUTOLOAD_CHAR);
2097 return p == NULL || (len > 0 && p > name + len);
2098}
2099
2100 int
2101func_call(
2102 char_u *name,
2103 typval_T *args,
2104 partial_T *partial,
2105 dict_T *selfdict,
2106 typval_T *rettv)
2107{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002108 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002109 listitem_T *item;
2110 typval_T argv[MAX_FUNC_ARGS + 1];
2111 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112 int r = 0;
2113
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002114 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002115 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116 {
2117 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2118 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002119 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120 break;
2121 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002122 // Make a copy of each argument. This is needed to be able to set
2123 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002124 copy_tv(&item->li_tv, &argv[argc++]);
2125 }
2126
2127 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002128 {
2129 funcexe_T funcexe;
2130
Bram Moolenaara80faa82020-04-12 19:37:17 +02002131 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002132 funcexe.firstline = curwin->w_cursor.lnum;
2133 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002134 funcexe.evaluate = TRUE;
2135 funcexe.partial = partial;
2136 funcexe.selfdict = selfdict;
2137 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2138 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002139
Bram Moolenaare38eab22019-12-05 21:50:01 +01002140 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141 while (argc > 0)
2142 clear_tv(&argv[--argc]);
2143
2144 return r;
2145}
2146
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002147static int callback_depth = 0;
2148
2149 int
2150get_callback_depth(void)
2151{
2152 return callback_depth;
2153}
2154
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002155/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002156 * Invoke call_func() with a callback.
2157 */
2158 int
2159call_callback(
2160 callback_T *callback,
2161 int len, // length of "name" or -1 to use strlen()
2162 typval_T *rettv, // return value goes here
2163 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002164 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002165 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002166{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002167 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002168 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002169
Bram Moolenaara80faa82020-04-12 19:37:17 +02002170 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002171 funcexe.evaluate = TRUE;
2172 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002173 ++callback_depth;
2174 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2175 --callback_depth;
2176 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002177}
2178
2179/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002180 * Give an error message for the result of a function.
2181 * Nothing if "error" is FCERR_NONE.
2182 */
2183 void
2184user_func_error(int error, char_u *name)
2185{
2186 switch (error)
2187 {
2188 case FCERR_UNKNOWN:
2189 emsg_funcname(e_unknownfunc, name);
2190 break;
2191 case FCERR_NOTMETHOD:
2192 emsg_funcname(
2193 N_("E276: Cannot use function as a method: %s"), name);
2194 break;
2195 case FCERR_DELETED:
2196 emsg_funcname(N_(e_func_deleted), name);
2197 break;
2198 case FCERR_TOOMANY:
2199 emsg_funcname((char *)e_toomanyarg, name);
2200 break;
2201 case FCERR_TOOFEW:
2202 emsg_funcname((char *)e_toofewarg, name);
2203 break;
2204 case FCERR_SCRIPT:
2205 emsg_funcname(
2206 N_("E120: Using <SID> not in a script context: %s"), name);
2207 break;
2208 case FCERR_DICT:
2209 emsg_funcname(
2210 N_("E725: Calling dict function without Dictionary: %s"),
2211 name);
2212 break;
2213 }
2214}
2215
2216/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002218 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 * Return FAIL when the function can't be called, OK otherwise.
2220 * Also returns OK when an error was encountered while executing the function.
2221 */
2222 int
2223call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002224 char_u *funcname, // name of the function
2225 int len, // length of "name" or -1 to use strlen()
2226 typval_T *rettv, // return value goes here
2227 int argcount_in, // number of "argvars"
2228 typval_T *argvars_in, // vars for arguments, must have "argcount"
2229 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002230 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231{
2232 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002233 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002234 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002235 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002236 char_u fname_buf[FLEN_FIXED + 1];
2237 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002238 char_u *fname = NULL;
2239 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002240 int argcount = argcount_in;
2241 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002242 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002243 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2244 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002245 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002246 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002247 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002248
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002249 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2250 // even when call_func() returns FAIL.
2251 rettv->v_type = VAR_UNKNOWN;
2252
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002253 if (partial != NULL)
2254 fp = partial->pt_func;
2255 if (fp == NULL)
2256 {
2257 // Make a copy of the name, if it comes from a funcref variable it
2258 // could be changed or deleted in the called function.
2259 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2260 if (name == NULL)
2261 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002262
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002263 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002266 if (funcexe->doesrange != NULL)
2267 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268
2269 if (partial != NULL)
2270 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002271 // When the function has a partial with a dict and there is a dict
2272 // argument, use the dict argument. That is backwards compatible.
2273 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002274 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002275 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002276 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 {
2278 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002279 {
2280 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2281 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002282 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002283 goto theend;
2284 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002286 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002287 for (i = 0; i < argcount_in; ++i)
2288 argv[i + argv_clear] = argvars_in[i];
2289 argvars = argv;
2290 argcount = partial->pt_argc + argcount_in;
2291 }
2292 }
2293
Bram Moolenaaref140542019-12-31 21:27:13 +01002294 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295 {
2296 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002297 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298
Bram Moolenaar333894b2020-08-01 18:53:07 +02002299 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002300 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002301 {
2302 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002304 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305
Bram Moolenaare38eab22019-12-05 21:50:01 +01002306 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002307 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002308 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002309
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002310 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002311 {
2312 /*
2313 * User defined function.
2314 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002315 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002316 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002317
Bram Moolenaare38eab22019-12-05 21:50:01 +01002318 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002319 if (fp == NULL
2320 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002321 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002322 && !aborting())
2323 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002324 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002325 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002327 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2329 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002330 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002331 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002333 if (fp == NULL)
2334 {
2335 char_u *p = untrans_function_name(rfname);
2336
2337 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002338 // Don't do this if the name starts with "s:".
2339 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002340 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002342
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002343 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002344 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002345#ifdef FEAT_LUA
2346 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2347 {
2348 cfunc_T cb = fp->uf_cb;
2349
2350 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2351 }
2352#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002353 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002354 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002355 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002356 // postponed filling in the arguments, do it now
2357 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002358 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002359
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002360 if (funcexe->basetv != NULL)
2361 {
2362 // Method call: base->Method()
2363 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2364 argv[0] = *funcexe->basetv;
2365 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002366 argvars = argv;
2367 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002368 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002369
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002370 error = call_user_func_check(fp, argcount, argvars, rettv,
2371 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 }
2373 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002374 else if (funcexe->basetv != NULL)
2375 {
2376 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002377 * expr->method(): Find the method name in the table, call its
2378 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002379 */
2380 error = call_internal_method(fname, argcount, argvars, rettv,
2381 funcexe->basetv);
2382 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002383 else
2384 {
2385 /*
2386 * Find the function name in the table, call its implementation.
2387 */
2388 error = call_internal_func(fname, argcount, argvars, rettv);
2389 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002390
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002391 /*
2392 * The function call (or "FuncUndefined" autocommand sequence) might
2393 * have been aborted by an error, an interrupt, or an explicitly thrown
2394 * exception that has not been caught so far. This situation can be
2395 * tested for by calling aborting(). For an error in an internal
2396 * function or for the "E132" error in call_user_func(), however, the
2397 * throw point at which the "force_abort" flag (temporarily reset by
2398 * emsg()) is normally updated has not been reached yet. We need to
2399 * update that flag first to make aborting() reliable.
2400 */
2401 update_force_abort();
2402 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002403 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 ret = OK;
2405
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002406theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 /*
2408 * Report an error unless the argument evaluation or function call has been
2409 * cancelled due to an aborting error, an interrupt, or an exception.
2410 */
2411 if (!aborting())
2412 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002413 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002414 }
2415
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002416 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002417 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002418 clear_tv(&argv[--argv_clear + argv_base]);
2419
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420 vim_free(tofree);
2421 vim_free(name);
2422
2423 return ret;
2424}
2425
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002426 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002427printable_func_name(ufunc_T *fp)
2428{
2429 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2430}
2431
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002433 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 */
2435 static void
2436list_func_head(ufunc_T *fp, int indent)
2437{
2438 int j;
2439
2440 msg_start();
2441 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002442 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002443 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002444 msg_puts("def ");
2445 else
2446 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002447 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 msg_putchar('(');
2449 for (j = 0; j < fp->uf_args.ga_len; ++j)
2450 {
2451 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002452 msg_puts(", ");
2453 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002454 if (fp->uf_arg_types != NULL)
2455 {
2456 char *tofree;
2457
2458 msg_puts(": ");
2459 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2460 vim_free(tofree);
2461 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002462 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2463 {
2464 msg_puts(" = ");
2465 msg_puts(((char **)(fp->uf_def_args.ga_data))
2466 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468 }
2469 if (fp->uf_varargs)
2470 {
2471 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002472 msg_puts(", ");
2473 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002475 if (fp->uf_va_name != NULL)
2476 {
2477 if (j)
2478 msg_puts(", ");
2479 msg_puts("...");
2480 msg_puts((char *)fp->uf_va_name);
2481 if (fp->uf_va_type)
2482 {
2483 char *tofree;
2484
2485 msg_puts(": ");
2486 msg_puts(type_name(fp->uf_va_type, &tofree));
2487 vim_free(tofree);
2488 }
2489 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002491
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002492 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002493 {
2494 if (fp->uf_ret_type != &t_void)
2495 {
2496 char *tofree;
2497
2498 msg_puts(": ");
2499 msg_puts(type_name(fp->uf_ret_type, &tofree));
2500 vim_free(tofree);
2501 }
2502 }
2503 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002504 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002506 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002508 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002509 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002510 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 msg_clr_eos();
2512 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002513 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514}
2515
2516/*
2517 * Get a function name, translating "<SID>" and "<SNR>".
2518 * Also handles a Funcref in a List or Dictionary.
2519 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002520 * Set "*is_global" to TRUE when the function must be global, unless
2521 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 * flags:
2523 * TFN_INT: internal function name OK
2524 * TFN_QUIET: be quiet
2525 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002526 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527 * Advances "pp" to just after the function name (if no error).
2528 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002529 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530trans_function_name(
2531 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002532 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002533 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002535 funcdict_T *fdp, // return: info about dictionary used
2536 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537{
2538 char_u *name = NULL;
2539 char_u *start;
2540 char_u *end;
2541 int lead;
2542 char_u sid_buf[20];
2543 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002544 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002545 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002546 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002547 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548
2549 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002550 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551 start = *pp;
2552
Bram Moolenaare38eab22019-12-05 21:50:01 +01002553 // Check for hard coded <SNR>: already translated function ID (from a user
2554 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2556 && (*pp)[2] == (int)KE_SNR)
2557 {
2558 *pp += 3;
2559 len = get_id_len(pp) + 3;
2560 return vim_strnsave(start, len);
2561 }
2562
Bram Moolenaare38eab22019-12-05 21:50:01 +01002563 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2564 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002565 lead = eval_fname_script(start);
2566 if (lead > 2)
2567 start += lead;
2568
Bram Moolenaare38eab22019-12-05 21:50:01 +01002569 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002570 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571 lead > 2 ? 0 : FNE_CHECK_START);
2572 if (end == start)
2573 {
2574 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002575 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576 goto theend;
2577 }
2578 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2579 {
2580 /*
2581 * Report an invalid expression in braces, unless the expression
2582 * evaluation has been cancelled due to an aborting error, an
2583 * interrupt, or an exception.
2584 */
2585 if (!aborting())
2586 {
2587 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002588 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002589 }
2590 else
2591 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2592 goto theend;
2593 }
2594
2595 if (lv.ll_tv != NULL)
2596 {
2597 if (fdp != NULL)
2598 {
2599 fdp->fd_dict = lv.ll_dict;
2600 fdp->fd_newkey = lv.ll_newkey;
2601 lv.ll_newkey = NULL;
2602 fdp->fd_di = lv.ll_di;
2603 }
2604 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2605 {
2606 name = vim_strsave(lv.ll_tv->vval.v_string);
2607 *pp = end;
2608 }
2609 else if (lv.ll_tv->v_type == VAR_PARTIAL
2610 && lv.ll_tv->vval.v_partial != NULL)
2611 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002612 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 *pp = end;
2614 if (partial != NULL)
2615 *partial = lv.ll_tv->vval.v_partial;
2616 }
2617 else
2618 {
2619 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2620 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002621 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 else
2623 *pp = end;
2624 name = NULL;
2625 }
2626 goto theend;
2627 }
2628
2629 if (lv.ll_name == NULL)
2630 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002631 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 *pp = end;
2633 goto theend;
2634 }
2635
Bram Moolenaare38eab22019-12-05 21:50:01 +01002636 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 if (lv.ll_exp_name != NULL)
2638 {
2639 len = (int)STRLEN(lv.ll_exp_name);
2640 name = deref_func_name(lv.ll_exp_name, &len, partial,
2641 flags & TFN_NO_AUTOLOAD);
2642 if (name == lv.ll_exp_name)
2643 name = NULL;
2644 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002645 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 {
2647 len = (int)(end - *pp);
2648 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2649 if (name == *pp)
2650 name = NULL;
2651 }
2652 if (name != NULL)
2653 {
2654 name = vim_strsave(name);
2655 *pp = end;
2656 if (STRNCMP(name, "<SNR>", 5) == 0)
2657 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002658 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 name[0] = K_SPECIAL;
2660 name[1] = KS_EXTRA;
2661 name[2] = (int)KE_SNR;
2662 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2663 }
2664 goto theend;
2665 }
2666
2667 if (lv.ll_exp_name != NULL)
2668 {
2669 len = (int)STRLEN(lv.ll_exp_name);
2670 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2671 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2672 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002673 // When there was "s:" already or the name expanded to get a
2674 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 lv.ll_name += 2;
2676 len -= 2;
2677 lead = 2;
2678 }
2679 }
2680 else
2681 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002682 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002684 {
2685 if (is_global != NULL && lv.ll_name[0] == 'g')
2686 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002688 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 len = (int)(end - lv.ll_name);
2690 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002691 if (len <= 0)
2692 {
2693 if (!skip)
2694 emsg(_(e_function_name));
2695 goto theend;
2696 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002698 // In Vim9 script a user function is script-local by default, unless it
2699 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002700 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002701 if (vim9script)
2702 {
2703 char_u *p;
2704
2705 // SomeScript#func() is a global function.
2706 for (p = start; *p != NUL && *p != '('; ++p)
2707 if (*p == AUTOLOAD_CHAR)
2708 vim9script = FALSE;
2709 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002710
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 /*
2712 * Copy the function name to allocated memory.
2713 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2714 * Accept <SNR>123_name() outside a script.
2715 */
2716 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002717 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002718 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002720 if (!vim9script)
2721 lead = 3;
2722 if (vim9script || (lv.ll_exp_name != NULL
2723 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 || eval_fname_sid(*pp))
2725 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002726 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002727 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002729 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 goto theend;
2731 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002732 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002733 if (vim9script)
2734 extra = 3 + (int)STRLEN(sid_buf);
2735 else
2736 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002737 }
2738 }
2739 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2740 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002741 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 start);
2743 goto theend;
2744 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002745 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 {
2747 char_u *cp = vim_strchr(lv.ll_name, ':');
2748
2749 if (cp != NULL && cp < end)
2750 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002751 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002752 goto theend;
2753 }
2754 }
2755
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002756 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 if (name != NULL)
2758 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002759 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 {
2761 name[0] = K_SPECIAL;
2762 name[1] = KS_EXTRA;
2763 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002764 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 STRCPY(name + 3, sid_buf);
2766 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002767 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2768 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 }
2770 *pp = end;
2771
2772theend:
2773 clear_lval(&lv);
2774 return name;
2775}
2776
2777/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002778 * Assuming "name" is the result of trans_function_name() and it was prefixed
2779 * to use the script-local name, return the unmodified name (points into
2780 * "name"). Otherwise return NULL.
2781 * This can be used to first search for a script-local function and fall back
2782 * to the global function if not found.
2783 */
2784 char_u *
2785untrans_function_name(char_u *name)
2786{
2787 char_u *p;
2788
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002789 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002790 {
2791 p = vim_strchr(name, '_');
2792 if (p != NULL)
2793 return p + 1;
2794 }
2795 return NULL;
2796}
2797
2798/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002799 * List functions. When "regmatch" is NULL all of then.
2800 * Otherwise functions matching "regmatch".
2801 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002802 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002803list_functions(regmatch_T *regmatch)
2804{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002805 int changed = func_hashtab.ht_changed;
2806 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002807 hashitem_T *hi;
2808
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002809 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002810 {
2811 if (!HASHITEM_EMPTY(hi))
2812 {
2813 ufunc_T *fp = HI2UF(hi);
2814
2815 --todo;
2816 if ((fp->uf_flags & FC_DEAD) == 0
2817 && (regmatch == NULL
2818 ? !message_filtered(fp->uf_name)
2819 && !func_name_refcount(fp->uf_name)
2820 : !isdigit(*fp->uf_name)
2821 && vim_regexec(regmatch, fp->uf_name, 0)))
2822 {
2823 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002824 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002825 {
2826 emsg(_("E454: function list was modified"));
2827 return;
2828 }
2829 }
2830 }
2831 }
2832}
2833
2834/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002835 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002836 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2837 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002838 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002840 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002841define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842{
2843 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002844 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845 int j;
2846 int c;
2847 int saved_did_emsg;
2848 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002849 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002850 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002851 char_u *p;
2852 char_u *arg;
2853 char_u *line_arg = NULL;
2854 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002856 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 garray_T newlines;
2858 int varargs = FALSE;
2859 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002860 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002861 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002862 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002863 int indent;
2864 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002865#define MAX_FUNC_NESTING 50
2866 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 dictitem_T *v;
2868 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002869 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002872 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002873 linenr_T sourcing_lnum_off;
2874 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002875 int is_heredoc = FALSE;
2876 char_u *skip_until = NULL;
2877 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002878 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002879 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880
2881 /*
2882 * ":function" without argument: list functions.
2883 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002884 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002885 {
2886 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002887 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002889 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 }
2891
2892 /*
2893 * ":function /pat": list functions matching pattern.
2894 */
2895 if (*eap->arg == '/')
2896 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002897 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 if (!eap->skip)
2899 {
2900 regmatch_T regmatch;
2901
2902 c = *p;
2903 *p = NUL;
2904 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2905 *p = c;
2906 if (regmatch.regprog != NULL)
2907 {
2908 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002909 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002910 vim_regfree(regmatch.regprog);
2911 }
2912 }
2913 if (*p == '/')
2914 ++p;
2915 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002916 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 }
2918
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002919 ga_init(&newargs);
2920 ga_init(&argtypes);
2921 ga_init(&default_args);
2922
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 /*
2924 * Get the function name. There are these situations:
2925 * func normal function name
2926 * "name" == func, "fudi.fd_dict" == NULL
2927 * dict.func new dictionary entry
2928 * "name" == NULL, "fudi.fd_dict" set,
2929 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2930 * dict.func existing dict entry with a Funcref
2931 * "name" == func, "fudi.fd_dict" set,
2932 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2933 * dict.func existing dict entry that's not a Funcref
2934 * "name" == NULL, "fudi.fd_dict" set,
2935 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2936 * s:func script-local function name
2937 * g:func global function name, same as "func"
2938 */
2939 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002940 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002942 // nested function, argument is (args).
2943 paren = TRUE;
2944 CLEAR_FIELD(fudi);
2945 }
2946 else
2947 {
2948 name = trans_function_name(&p, &is_global, eap->skip,
2949 TFN_NO_AUTOLOAD, &fudi, NULL);
2950 paren = (vim_strchr(p, '(') != NULL);
2951 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002953 /*
2954 * Return on an invalid expression in braces, unless the expression
2955 * evaluation has been cancelled due to an aborting error, an
2956 * interrupt, or an exception.
2957 */
2958 if (!aborting())
2959 {
2960 if (!eap->skip && fudi.fd_newkey != NULL)
2961 semsg(_(e_dictkey), fudi.fd_newkey);
2962 vim_free(fudi.fd_newkey);
2963 return NULL;
2964 }
2965 else
2966 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 }
2969
Bram Moolenaare38eab22019-12-05 21:50:01 +01002970 // An error in a function call during evaluation of an expression in magic
2971 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 saved_did_emsg = did_emsg;
2973 did_emsg = FALSE;
2974
2975 /*
2976 * ":function func" with only function name: list function.
2977 */
2978 if (!paren)
2979 {
2980 if (!ends_excmd(*skipwhite(p)))
2981 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002982 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 goto ret_free;
2984 }
2985 eap->nextcmd = check_nextcmd(p);
2986 if (eap->nextcmd != NULL)
2987 *p = NUL;
2988 if (!eap->skip && !got_int)
2989 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002990 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002991 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2992 {
2993 char_u *up = untrans_function_name(name);
2994
2995 // With Vim9 script the name was made script-local, if not
2996 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002997 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002998 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002999 }
3000
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 if (fp != NULL)
3002 {
3003 list_func_head(fp, TRUE);
3004 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3005 {
3006 if (FUNCLINE(fp, j) == NULL)
3007 continue;
3008 msg_putchar('\n');
3009 msg_outnum((long)(j + 1));
3010 if (j < 9)
3011 msg_putchar(' ');
3012 if (j < 99)
3013 msg_putchar(' ');
3014 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003015 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 ui_breakcheck();
3017 }
3018 if (!got_int)
3019 {
3020 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003021 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003022 msg_puts(" enddef");
3023 else
3024 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025 }
3026 }
3027 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003028 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 }
3030 goto ret_free;
3031 }
3032
3033 /*
3034 * ":function name(arg1, arg2)" Define function.
3035 */
3036 p = skipwhite(p);
3037 if (*p != '(')
3038 {
3039 if (!eap->skip)
3040 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003041 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042 goto ret_free;
3043 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003044 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003045 if (vim_strchr(p, '(') != NULL)
3046 p = vim_strchr(p, '(');
3047 }
3048 p = skipwhite(p + 1);
3049
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003050 // In Vim9 script only global functions can be redefined.
3051 if (vim9script && eap->forceit && !is_global)
3052 {
3053 emsg(_(e_nobang));
3054 goto ret_free;
3055 }
3056
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3058
Bram Moolenaar04b12692020-05-04 23:24:44 +02003059 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003061 // Check the name of the function. Unless it's a dictionary function
3062 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003063 if (name != NULL)
3064 arg = name;
3065 else
3066 arg = fudi.fd_newkey;
3067 if (arg != NULL && (fudi.fd_di == NULL
3068 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3069 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3070 {
3071 if (*arg == K_SPECIAL)
3072 j = 3;
3073 else
3074 j = 0;
3075 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3076 : eval_isnamec(arg[j])))
3077 ++j;
3078 if (arg[j] != NUL)
3079 emsg_funcname((char *)e_invarg2, arg);
3080 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003081 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003083 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084 }
3085
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003086 // This may get more lines and make the pointers into the first line
3087 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003088 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003089 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003090 &varargs, &default_args, eap->skip,
3091 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 goto errret_2;
3093
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003094 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003095 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003096 // find the return type: :def Func(): type
3097 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003098 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003099 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003100 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003101 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003102 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003103 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003104 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003105 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003106 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003107 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003108 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003109 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003110 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003112 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003114 else
3115 // find extra arguments "range", "dict", "abort" and "closure"
3116 for (;;)
3117 {
3118 p = skipwhite(p);
3119 if (STRNCMP(p, "range", 5) == 0)
3120 {
3121 flags |= FC_RANGE;
3122 p += 5;
3123 }
3124 else if (STRNCMP(p, "dict", 4) == 0)
3125 {
3126 flags |= FC_DICT;
3127 p += 4;
3128 }
3129 else if (STRNCMP(p, "abort", 5) == 0)
3130 {
3131 flags |= FC_ABORT;
3132 p += 5;
3133 }
3134 else if (STRNCMP(p, "closure", 7) == 0)
3135 {
3136 flags |= FC_CLOSURE;
3137 p += 7;
3138 if (current_funccal == NULL)
3139 {
3140 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3141 name == NULL ? (char_u *)"" : name);
3142 goto erret;
3143 }
3144 }
3145 else
3146 break;
3147 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148
Bram Moolenaare38eab22019-12-05 21:50:01 +01003149 // When there is a line break use what follows for the function body.
3150 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 if (*p == '\n')
3152 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003153 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003154 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3155 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02003156 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
3157 && !eap->skip
3158 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003159 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160
3161 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003162 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3163 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 */
3165 if (KeyTyped)
3166 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003167 // Check if the function already exists, don't let the user type the
3168 // whole function before telling him it doesn't work! For a script we
3169 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003170 if (!eap->skip && !eap->forceit)
3171 {
3172 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003173 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003174 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 emsg_funcname(e_funcexts, name);
3176 }
3177
3178 if (!eap->skip && did_emsg)
3179 goto erret;
3180
Bram Moolenaare38eab22019-12-05 21:50:01 +01003181 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003182 cmdline_row = msg_row;
3183 }
3184
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003185 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003186 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003187
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003188 // Detect having skipped over comment lines to find the return
3189 // type. Add NULL lines to keep the line count correct.
3190 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3191 if (SOURCING_LNUM < sourcing_lnum_off)
3192 {
3193 sourcing_lnum_off -= SOURCING_LNUM;
3194 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3195 goto erret;
3196 while (sourcing_lnum_off-- > 0)
3197 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3198 }
3199
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 indent = 2;
3201 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 for (;;)
3204 {
3205 if (KeyTyped)
3206 {
3207 msg_scroll = TRUE;
3208 saved_wait_return = FALSE;
3209 }
3210 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211
3212 if (line_arg != NULL)
3213 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003214 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215 theline = line_arg;
3216 p = vim_strchr(theline, '\n');
3217 if (p == NULL)
3218 line_arg += STRLEN(line_arg);
3219 else
3220 {
3221 *p = NUL;
3222 line_arg = p + 1;
3223 }
3224 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003225 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003226 {
3227 vim_free(line_to_free);
3228 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003229 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003230 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003231 theline = eap->getline(':', eap->cookie, indent,
3232 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003233 line_to_free = theline;
3234 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 if (KeyTyped)
3236 lines_left = Rows - 1;
3237 if (theline == NULL)
3238 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003239 if (skip_until != NULL)
3240 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3241 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003242 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 else
3244 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 goto erret;
3246 }
3247
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003248 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003249 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003250 if (SOURCING_LNUM < sourcing_lnum_off)
3251 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 else
3253 sourcing_lnum_off = 0;
3254
3255 if (skip_until != NULL)
3256 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003257 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003258 // * ":append" and "."
3259 // * ":python <<EOF" and "EOF"
3260 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3261 if (heredoc_trimmed == NULL
3262 || (is_heredoc && skipwhite(theline) == theline)
3263 || STRNCMP(theline, heredoc_trimmed,
3264 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003265 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003266 if (heredoc_trimmed == NULL)
3267 p = theline;
3268 else if (is_heredoc)
3269 p = skipwhite(theline) == theline
3270 ? theline : theline + STRLEN(heredoc_trimmed);
3271 else
3272 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003273 if (STRCMP(p, skip_until) == 0)
3274 {
3275 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003276 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003277 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003278 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003279 }
3280 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 }
3282 else
3283 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003284 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003285 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 ;
3287
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 // Check for "endfunction" or "enddef".
3289 if (checkforcmd(&p, nesting_def[nesting]
3290 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003291 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003292 char_u *nextcmd = NULL;
3293
Bram Moolenaar663bb232017-06-22 19:12:10 +02003294 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003295 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003296 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003297 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003298 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299 give_warning2(eap->cmdidx == CMD_def
3300 ? (char_u *)_("W1001: Text found after :enddef: %s")
3301 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003302 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003303 if (nextcmd != NULL)
3304 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003305 // Another command follows. If the line came from "eap" we
3306 // can simply point into it, otherwise we need to change
3307 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003308 eap->nextcmd = nextcmd;
3309 if (line_to_free != NULL)
3310 {
3311 vim_free(*eap->cmdlinep);
3312 *eap->cmdlinep = line_to_free;
3313 line_to_free = NULL;
3314 }
3315 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 break;
3317 }
3318
Bram Moolenaare38eab22019-12-05 21:50:01 +01003319 // Increase indent inside "if", "while", "for" and "try", decrease
3320 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003321 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003322 indent -= 2;
3323 else if (STRNCMP(p, "if", 2) == 0
3324 || STRNCMP(p, "wh", 2) == 0
3325 || STRNCMP(p, "for", 3) == 0
3326 || STRNCMP(p, "try", 3) == 0)
3327 indent += 2;
3328
Bram Moolenaare38eab22019-12-05 21:50:01 +01003329 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003330 // Only recognize "def" inside "def", not inside "function",
3331 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003332 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003333 if (checkforcmd(&p, "function", 2)
3334 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 {
3336 if (*p == '!')
3337 p = skipwhite(p + 1);
3338 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003339 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 if (*skipwhite(p) == '(')
3341 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003342 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003343 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003344 else
3345 {
3346 ++nesting;
3347 nesting_def[nesting] = (c == 'd');
3348 indent += 2;
3349 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 }
3351 }
3352
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003353 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003354 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003355 if (eap->cmdidx != CMD_def
3356 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003357 || (p[0] == 'c'
3358 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3359 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3360 && (STRNCMP(&p[3], "nge", 3) != 0
3361 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 || (p[0] == 'i'
3363 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003364 && (!ASCII_ISALPHA(p[2])
3365 || (p[2] == 's'
3366 && (!ASCII_ISALPHA(p[3])
3367 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 skip_until = vim_strsave((char_u *)".");
3369
Bram Moolenaare38eab22019-12-05 21:50:01 +01003370 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 arg = skipwhite(skiptowhite(p));
3372 if (arg[0] == '<' && arg[1] =='<'
3373 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003374 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3375 || ((p[2] == '3' || p[2] == 'x')
3376 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 || (p[0] == 'p' && p[1] == 'e'
3378 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3379 || (p[0] == 't' && p[1] == 'c'
3380 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3381 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3382 && !ASCII_ISALPHA(p[3]))
3383 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3384 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3385 || (p[0] == 'm' && p[1] == 'z'
3386 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3387 ))
3388 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003389 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003391 if (STRNCMP(p, "trim", 4) == 0)
3392 {
3393 // Ignore leading white space.
3394 p = skipwhite(p + 4);
3395 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003396 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 if (*p == NUL)
3399 skip_until = vim_strsave((char_u *)".");
3400 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003401 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003402 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003403 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003405
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003406 // Check for ":cmd v =<< [trim] EOF"
3407 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003408 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003409 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003410 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003411 if (*arg == '[')
3412 arg = vim_strchr(arg, ']');
3413 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003414 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003415 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3416 && arg[1] == '<' && arg[2] =='<');
3417
3418 if (!found)
3419 // skip over the argument after "cmd"
3420 arg = skipwhite(skiptowhite(arg));
3421 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003422 && (checkforcmd(&p, "let", 2)
3423 || checkforcmd(&p, "var", 3)
3424 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003425 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003426 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003427 p = skipwhite(arg + 3);
3428 if (STRNCMP(p, "trim", 4) == 0)
3429 {
3430 // Ignore leading white space.
3431 p = skipwhite(p + 4);
3432 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003433 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003434 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003435 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003436 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003437 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003438 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003439 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 }
3441
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445
Bram Moolenaare38eab22019-12-05 21:50:01 +01003446 // Copy the line to newly allocated memory. get_one_sourceline()
3447 // allocates 250 bytes per line, this saves 80% on average. The cost
3448 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003450 if (p == NULL)
3451 goto erret;
3452 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453
Bram Moolenaare38eab22019-12-05 21:50:01 +01003454 // Add NULL lines for continuation lines, so that the line count is
3455 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 while (sourcing_lnum_off-- > 0)
3457 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3458
Bram Moolenaare38eab22019-12-05 21:50:01 +01003459 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 if (line_arg != NULL && *line_arg == NUL)
3461 line_arg = NULL;
3462 }
3463
Bram Moolenaare38eab22019-12-05 21:50:01 +01003464 // Don't define the function when skipping commands or when an error was
3465 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 if (eap->skip || did_emsg)
3467 goto erret;
3468
3469 /*
3470 * If there are no errors, add the function
3471 */
3472 if (fudi.fd_dict == NULL)
3473 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003474 hashtab_T *ht;
3475
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 v = find_var(name, &ht, FALSE);
3477 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3478 {
3479 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3480 name);
3481 goto erret;
3482 }
3483
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003484 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003485 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003487 char_u *uname = untrans_function_name(name);
3488
3489 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3490 }
3491
3492 if (fp != NULL || import != NULL)
3493 {
3494 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003495
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003496 // Function can be replaced with "function!" and when sourcing the
3497 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003498 // A name that is used by an import can not be overruled.
3499 if (import != NULL
3500 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003501 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003502 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003503 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003504 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003505 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003506 else
3507 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 goto erret;
3509 }
3510 if (fp->uf_calls > 0)
3511 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003512 emsg_funcname(
3513 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 name);
3515 goto erret;
3516 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003517 if (fp->uf_refcount > 1)
3518 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003519 // This function is referenced somewhere, don't redefine it but
3520 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003521 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003522 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003523 fp = NULL;
3524 overwrite = TRUE;
3525 }
3526 else
3527 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003528 char_u *exp_name = fp->uf_name_exp;
3529
3530 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003531 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003532 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003533 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003534 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003535 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003536#ifdef FEAT_PROFILE
3537 fp->uf_profiling = FALSE;
3538 fp->uf_prof_initialized = FALSE;
3539#endif
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003540 unlink_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003541 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 }
3543 }
3544 else
3545 {
3546 char numbuf[20];
3547
3548 fp = NULL;
3549 if (fudi.fd_newkey == NULL && !eap->forceit)
3550 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003551 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 goto erret;
3553 }
3554 if (fudi.fd_di == NULL)
3555 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003556 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003557 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 goto erret;
3559 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003560 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003561 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003562 goto erret;
3563
Bram Moolenaare38eab22019-12-05 21:50:01 +01003564 // Give the function a sequential number. Can only be used with a
3565 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 vim_free(name);
3567 sprintf(numbuf, "%d", ++func_nr);
3568 name = vim_strsave((char_u *)numbuf);
3569 if (name == NULL)
3570 goto erret;
3571 }
3572
3573 if (fp == NULL)
3574 {
3575 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3576 {
3577 int slen, plen;
3578 char_u *scriptname;
3579
Bram Moolenaare38eab22019-12-05 21:50:01 +01003580 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003582 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 {
3584 scriptname = autoload_name(name);
3585 if (scriptname != NULL)
3586 {
3587 p = vim_strchr(scriptname, '/');
3588 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003589 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003591 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 j = OK;
3593 vim_free(scriptname);
3594 }
3595 }
3596 if (j == FAIL)
3597 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003598 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 goto erret;
3600 }
3601 }
3602
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003603 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 if (fp == NULL)
3605 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003606 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003607 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608
3609 if (fudi.fd_dict != NULL)
3610 {
3611 if (fudi.fd_di == NULL)
3612 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003613 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3615 if (fudi.fd_di == NULL)
3616 {
3617 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003618 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 goto erret;
3620 }
3621 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3622 {
3623 vim_free(fudi.fd_di);
3624 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003625 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003626 goto erret;
3627 }
3628 }
3629 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003630 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 clear_tv(&fudi.fd_di->di_tv);
3632 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 flags |= FC_DICT;
3637 }
3638
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003640 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003641 if (overwrite)
3642 {
3643 hi = hash_find(&func_hashtab, name);
3644 hi->hi_key = UF2HIKEY(fp);
3645 }
3646 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003647 {
3648 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003649 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 goto erret;
3651 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003652 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 }
3654 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003655 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003656 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003657 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003658
3659 if (eap->cmdidx == CMD_def)
3660 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003661 int lnum_save = SOURCING_LNUM;
3662 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003663
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003664 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003665
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003666 // error messages are for the first function line
3667 SOURCING_LNUM = sourcing_lnum_top;
3668
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003669 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003670 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003671 int count = cstack->cs_idx + 1;
3672 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003673
3674 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003675 // a block that is visible now but not when the function is called
3676 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003677 fp->uf_block_ids = ALLOC_MULT(int, count);
3678 if (fp->uf_block_ids != NULL)
3679 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003680 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003681 sizeof(int) * count);
3682 fp->uf_block_depth = count;
3683 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003684
3685 // Set flag in each block to indicate a function was defined. This
3686 // is used to keep the variable when leaving the block, see
3687 // hide_script_var().
3688 for (i = 0; i <= cstack->cs_idx; ++i)
3689 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003690 }
3691
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003692 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003693 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003694 SOURCING_LNUM = lnum_save;
3695 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003696 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003697 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003698
3699 // parse the return type, if any
3700 if (ret_type == NULL)
3701 fp->uf_ret_type = &t_void;
3702 else
3703 {
3704 p = ret_type;
3705 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3706 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003707 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003708 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003709 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003710 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003711
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003713 if ((flags & FC_CLOSURE) != 0)
3714 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003715 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003716 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003717 }
3718 else
3719 fp->uf_scoped = NULL;
3720
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 if (prof_def_func())
3723 func_do_profile(fp);
3724#endif
3725 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003726 if (sandbox)
3727 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003728 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003729 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003730 fp->uf_flags = flags;
3731 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003732 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003733 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003734 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003735 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003736 if (is_export)
3737 {
3738 fp->uf_flags |= FC_EXPORT;
3739 // let ex_export() know the export worked.
3740 is_export = FALSE;
3741 }
3742
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003743 if (eap->cmdidx == CMD_def)
3744 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003745 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3746 // :func does not use Vim9 script syntax, even in a Vim9 script file
3747 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003748
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749 goto ret_free;
3750
3751erret:
3752 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003753 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754errret_2:
3755 ga_clear_strings(&newlines);
3756ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003757 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003759 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003760 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003762 if (name != name_arg)
3763 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003764 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 did_emsg |= saved_did_emsg;
3766 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003767
3768 return fp;
3769}
3770
3771/*
3772 * ":function"
3773 */
3774 void
3775ex_function(exarg_T *eap)
3776{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003777 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003778}
3779
3780/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003781 * :defcompile - compile all :def functions in the current script that need to
3782 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003783 */
3784 void
3785ex_defcompile(exarg_T *eap UNUSED)
3786{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003787 long todo = (long)func_hashtab.ht_used;
3788 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003789 hashitem_T *hi;
3790 ufunc_T *ufunc;
3791
3792 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3793 {
3794 if (!HASHITEM_EMPTY(hi))
3795 {
3796 --todo;
3797 ufunc = HI2UF(hi);
3798 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003799 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3800 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003801 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003802 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003803
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003804 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003805 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003806 // a function has been added or removed, need to start over
3807 todo = (long)func_hashtab.ht_used;
3808 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003809 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003810 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003811 }
3812 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003813 }
3814 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815}
3816
3817/*
3818 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3819 * Return 2 if "p" starts with "s:".
3820 * Return 0 otherwise.
3821 */
3822 int
3823eval_fname_script(char_u *p)
3824{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003825 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3826 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3828 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3829 return 5;
3830 if (p[0] == 's' && p[1] == ':')
3831 return 2;
3832 return 0;
3833}
3834
3835 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003836translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837{
3838 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003839 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003840 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841}
3842
3843/*
3844 * Return TRUE when "ufunc" has old-style "..." varargs
3845 * or named varargs "...name: type".
3846 */
3847 int
3848has_varargs(ufunc_T *ufunc)
3849{
3850 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003851}
3852
3853/*
3854 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003855 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003856 */
3857 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003858function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859{
3860 char_u *nm = name;
3861 char_u *p;
3862 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003863 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003864 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003866 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3867 if (no_deref)
3868 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003869 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 nm = skipwhite(nm);
3871
Bram Moolenaare38eab22019-12-05 21:50:01 +01003872 // Only accept "funcname", "funcname ", "funcname (..." and
3873 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003875 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003876 vim_free(p);
3877 return n;
3878}
3879
Bram Moolenaar113e1072019-01-20 15:30:40 +01003880#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 char_u *
3882get_expanded_name(char_u *name, int check)
3883{
3884 char_u *nm = name;
3885 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003886 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003888 p = trans_function_name(&nm, &is_global, FALSE,
3889 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003890
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003891 if (p != NULL && *nm == NUL
3892 && (!check || translated_function_exists(p, is_global)))
3893 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894
3895 vim_free(p);
3896 return NULL;
3897}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003898#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003900/*
3901 * Function given to ExpandGeneric() to obtain the list of user defined
3902 * function names.
3903 */
3904 char_u *
3905get_user_func_name(expand_T *xp, int idx)
3906{
3907 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003908 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 static hashitem_T *hi;
3910 ufunc_T *fp;
3911
3912 if (idx == 0)
3913 {
3914 done = 0;
3915 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003916 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003918 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 {
3920 if (done++ > 0)
3921 ++hi;
3922 while (HASHITEM_EMPTY(hi))
3923 ++hi;
3924 fp = HI2UF(hi);
3925
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003926 // don't show dead, dict and lambda functions
3927 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003928 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003929 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930
3931 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003932 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933
3934 cat_func_name(IObuff, fp);
3935 if (xp->xp_context != EXPAND_USER_FUNC)
3936 {
3937 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003938 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 STRCAT(IObuff, ")");
3940 }
3941 return IObuff;
3942 }
3943 return NULL;
3944}
3945
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946/*
3947 * ":delfunction {name}"
3948 */
3949 void
3950ex_delfunction(exarg_T *eap)
3951{
3952 ufunc_T *fp = NULL;
3953 char_u *p;
3954 char_u *name;
3955 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003956 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957
3958 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003959 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 vim_free(fudi.fd_newkey);
3961 if (name == NULL)
3962 {
3963 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003964 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 return;
3966 }
3967 if (!ends_excmd(*skipwhite(p)))
3968 {
3969 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003970 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 return;
3972 }
3973 eap->nextcmd = check_nextcmd(p);
3974 if (eap->nextcmd != NULL)
3975 *p = NUL;
3976
3977 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003978 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 vim_free(name);
3980
3981 if (!eap->skip)
3982 {
3983 if (fp == NULL)
3984 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003985 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003986 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003987 return;
3988 }
3989 if (fp->uf_calls > 0)
3990 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003991 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003992 return;
3993 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003994 if (fp->uf_flags & FC_VIM9)
3995 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003996 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003997 return;
3998 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999
4000 if (fudi.fd_dict != NULL)
4001 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004002 // Delete the dict item that refers to the function, it will
4003 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4005 }
4006 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004007 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004008 // A normal function (not a numbered function or lambda) has a
4009 // refcount of 1 for the entry in the hashtable. When deleting
4010 // it and the refcount is more than one, it should be kept.
4011 // A numbered function and lambda should be kept if the refcount is
4012 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004013 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004014 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004015 // Function is still referenced somewhere. Don't free it but
4016 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004017 if (func_remove(fp))
4018 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004019 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004020 }
4021 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004022 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004023 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 }
4025}
4026
4027/*
4028 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004029 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 */
4031 void
4032func_unref(char_u *name)
4033{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004034 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004036 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004038 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004039 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004042 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004044 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004046 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004048 // Only delete it when it's not being used. Otherwise it's done
4049 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004050 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004051 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02004052 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004053}
4054
4055/*
4056 * Unreference a Function: decrement the reference count and free it when it
4057 * becomes zero.
4058 */
4059 void
4060func_ptr_unref(ufunc_T *fp)
4061{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004062 if (fp != NULL && --fp->uf_refcount <= 0)
4063 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004064 // Only delete it when it's not being used. Otherwise it's done
4065 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004066 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004067 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068 }
4069}
4070
4071/*
4072 * Count a reference to a Function.
4073 */
4074 void
4075func_ref(char_u *name)
4076{
4077 ufunc_T *fp;
4078
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004079 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004081 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004082 if (fp != NULL)
4083 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004085 // Only give an error for a numbered function.
4086 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004087 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004088}
4089
4090/*
4091 * Count a reference to a Function.
4092 */
4093 void
4094func_ptr_ref(ufunc_T *fp)
4095{
4096 if (fp != NULL)
4097 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098}
4099
4100/*
4101 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4102 * referenced from anywhere that is in use.
4103 */
4104 static int
4105can_free_funccal(funccall_T *fc, int copyID)
4106{
4107 return (fc->l_varlist.lv_copyID != copyID
4108 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004109 && fc->l_avars.dv_copyID != copyID
4110 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111}
4112
4113/*
4114 * ":return [expr]"
4115 */
4116 void
4117ex_return(exarg_T *eap)
4118{
4119 char_u *arg = eap->arg;
4120 typval_T rettv;
4121 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004122 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004123
4124 if (current_funccal == NULL)
4125 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004126 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004127 return;
4128 }
4129
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004130 CLEAR_FIELD(evalarg);
4131 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4132
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133 if (eap->skip)
4134 ++emsg_skip;
4135
4136 eap->nextcmd = NULL;
4137 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004138 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 {
4140 if (!eap->skip)
4141 returning = do_return(eap, FALSE, TRUE, &rettv);
4142 else
4143 clear_tv(&rettv);
4144 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004145 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 else if (!eap->skip)
4147 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004148 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004149 update_force_abort();
4150
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 /*
4152 * Return unless the expression evaluation has been cancelled due to an
4153 * aborting error, an interrupt, or an exception.
4154 */
4155 if (!aborting())
4156 returning = do_return(eap, FALSE, TRUE, NULL);
4157 }
4158
Bram Moolenaare38eab22019-12-05 21:50:01 +01004159 // When skipping or the return gets pending, advance to the next command
4160 // in this line (!returning). Otherwise, ignore the rest of the line.
4161 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162 if (returning)
4163 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004164 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 eap->nextcmd = check_nextcmd(arg);
4166
4167 if (eap->skip)
4168 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004169 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170}
4171
4172/*
4173 * ":1,25call func(arg1, arg2)" function call.
4174 */
4175 void
4176ex_call(exarg_T *eap)
4177{
4178 char_u *arg = eap->arg;
4179 char_u *startarg;
4180 char_u *name;
4181 char_u *tofree;
4182 int len;
4183 typval_T rettv;
4184 linenr_T lnum;
4185 int doesrange;
4186 int failed = FALSE;
4187 funcdict_T fudi;
4188 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004189 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190
Bram Moolenaare6b53242020-07-01 17:28:33 +02004191 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 if (eap->skip)
4193 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004194 // trans_function_name() doesn't work well when skipping, use eval0()
4195 // instead to skip to any following command, e.g. for:
4196 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004198 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 clear_tv(&rettv);
4200 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004201 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 return;
4203 }
4204
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004205 tofree = trans_function_name(&arg, NULL, eap->skip,
4206 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004207 if (fudi.fd_newkey != NULL)
4208 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004209 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004210 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 vim_free(fudi.fd_newkey);
4212 }
4213 if (tofree == NULL)
4214 return;
4215
Bram Moolenaare38eab22019-12-05 21:50:01 +01004216 // Increase refcount on dictionary, it could get deleted when evaluating
4217 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218 if (fudi.fd_dict != NULL)
4219 ++fudi.fd_dict->dv_refcount;
4220
Bram Moolenaare38eab22019-12-05 21:50:01 +01004221 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4222 // contents. For VAR_PARTIAL get its partial, unless we already have one
4223 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004224 len = (int)STRLEN(tofree);
4225 name = deref_func_name(tofree, &len,
4226 partial != NULL ? NULL : &partial, FALSE);
4227
Bram Moolenaare38eab22019-12-05 21:50:01 +01004228 // Skip white space to allow ":call func ()". Not good, but required for
4229 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004231 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232
4233 if (*startarg != '(')
4234 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004235 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236 goto end;
4237 }
4238
4239 /*
4240 * When skipping, evaluate the function once, to find the end of the
4241 * arguments.
4242 * When the function takes a range, this is discovered after the first
4243 * call, and the loop is broken.
4244 */
4245 if (eap->skip)
4246 {
4247 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004248 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249 }
4250 else
4251 lnum = eap->line1;
4252 for ( ; lnum <= eap->line2; ++lnum)
4253 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004254 funcexe_T funcexe;
4255
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256 if (!eap->skip && eap->addr_count > 0)
4257 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004258 if (lnum > curbuf->b_ml.ml_line_count)
4259 {
4260 // If the function deleted lines or switched to another buffer
4261 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004262 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004263 break;
4264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265 curwin->w_cursor.lnum = lnum;
4266 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 }
4269 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004270
Bram Moolenaara80faa82020-04-12 19:37:17 +02004271 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004272 funcexe.firstline = eap->line1;
4273 funcexe.lastline = eap->line2;
4274 funcexe.doesrange = &doesrange;
4275 funcexe.evaluate = !eap->skip;
4276 funcexe.partial = partial;
4277 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004278 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 {
4280 failed = TRUE;
4281 break;
4282 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004283 if (has_watchexpr())
4284 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004286 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004287 if (handle_subscript(&arg, &rettv,
4288 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 {
4290 failed = TRUE;
4291 break;
4292 }
4293
4294 clear_tv(&rettv);
4295 if (doesrange || eap->skip)
4296 break;
4297
Bram Moolenaare38eab22019-12-05 21:50:01 +01004298 // Stop when immediately aborting on error, or when an interrupt
4299 // occurred or an exception was thrown but not caught.
4300 // get_func_tv() returned OK, so that the check for trailing
4301 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004302 if (aborting())
4303 break;
4304 }
4305 if (eap->skip)
4306 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004307 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308
Bram Moolenaare51bb172020-02-16 19:42:23 +01004309 // When inside :try we need to check for following "| catch".
4310 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004312 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004313 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004314 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004316 if (!failed)
4317 {
4318 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004319 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 }
4322 else
4323 eap->nextcmd = check_nextcmd(arg);
4324 }
4325
4326end:
4327 dict_unref(fudi.fd_dict);
4328 vim_free(tofree);
4329}
4330
4331/*
4332 * Return from a function. Possibly makes the return pending. Also called
4333 * for a pending return at the ":endtry" or after returning from an extra
4334 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4335 * when called due to a ":return" command. "rettv" may point to a typval_T
4336 * with the return rettv. Returns TRUE when the return can be carried out,
4337 * FALSE when the return gets pending.
4338 */
4339 int
4340do_return(
4341 exarg_T *eap,
4342 int reanimate,
4343 int is_cmd,
4344 void *rettv)
4345{
4346 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004347 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348
4349 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004350 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 current_funccal->returned = FALSE;
4352
4353 /*
4354 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4355 * not in its finally clause (which then is to be executed next) is found.
4356 * In this case, make the ":return" pending for execution at the ":endtry".
4357 * Otherwise, return normally.
4358 */
4359 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4360 if (idx >= 0)
4361 {
4362 cstack->cs_pending[idx] = CSTP_RETURN;
4363
4364 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004365 // A pending return again gets pending. "rettv" points to an
4366 // allocated variable with the rettv of the original ":return"'s
4367 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 cstack->cs_rettv[idx] = rettv;
4369 else
4370 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004371 // When undoing a return in order to make it pending, get the stored
4372 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004373 if (reanimate)
4374 rettv = current_funccal->rettv;
4375
4376 if (rettv != NULL)
4377 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004378 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4380 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4381 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004382 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 }
4384 else
4385 cstack->cs_rettv[idx] = NULL;
4386
4387 if (reanimate)
4388 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004389 // The pending return value could be overwritten by a ":return"
4390 // without argument in a finally clause; reset the default
4391 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392 current_funccal->rettv->v_type = VAR_NUMBER;
4393 current_funccal->rettv->vval.v_number = 0;
4394 }
4395 }
4396 report_make_pending(CSTP_RETURN, rettv);
4397 }
4398 else
4399 {
4400 current_funccal->returned = TRUE;
4401
Bram Moolenaare38eab22019-12-05 21:50:01 +01004402 // If the return is carried out now, store the return value. For
4403 // a return immediately after reanimation, the value is already
4404 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 if (!reanimate && rettv != NULL)
4406 {
4407 clear_tv(current_funccal->rettv);
4408 *current_funccal->rettv = *(typval_T *)rettv;
4409 if (!is_cmd)
4410 vim_free(rettv);
4411 }
4412 }
4413
4414 return idx < 0;
4415}
4416
4417/*
4418 * Free the variable with a pending return value.
4419 */
4420 void
4421discard_pending_return(void *rettv)
4422{
4423 free_tv((typval_T *)rettv);
4424}
4425
4426/*
4427 * Generate a return command for producing the value of "rettv". The result
4428 * is an allocated string. Used by report_pending() for verbose messages.
4429 */
4430 char_u *
4431get_return_cmd(void *rettv)
4432{
4433 char_u *s = NULL;
4434 char_u *tofree = NULL;
4435 char_u numbuf[NUMBUFLEN];
4436
4437 if (rettv != NULL)
4438 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4439 if (s == NULL)
4440 s = (char_u *)"";
4441
4442 STRCPY(IObuff, ":return ");
4443 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4444 if (STRLEN(s) + 8 >= IOSIZE)
4445 STRCPY(IObuff + IOSIZE - 4, "...");
4446 vim_free(tofree);
4447 return vim_strsave(IObuff);
4448}
4449
4450/*
4451 * Get next function line.
4452 * Called by do_cmdline() to get the next line.
4453 * Returns allocated string, or NULL for end of function.
4454 */
4455 char_u *
4456get_func_line(
4457 int c UNUSED,
4458 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004459 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004460 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461{
4462 funccall_T *fcp = (funccall_T *)cookie;
4463 ufunc_T *fp = fcp->func;
4464 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004465 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466
Bram Moolenaare38eab22019-12-05 21:50:01 +01004467 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 if (fcp->dbg_tick != debug_tick)
4469 {
4470 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004471 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 fcp->dbg_tick = debug_tick;
4473 }
4474#ifdef FEAT_PROFILE
4475 if (do_profiling == PROF_YES)
4476 func_line_end(cookie);
4477#endif
4478
4479 gap = &fp->uf_lines;
4480 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4481 || fcp->returned)
4482 retval = NULL;
4483 else
4484 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004485 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 while (fcp->linenr < gap->ga_len
4487 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4488 ++fcp->linenr;
4489 if (fcp->linenr >= gap->ga_len)
4490 retval = NULL;
4491 else
4492 {
4493 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004494 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495#ifdef FEAT_PROFILE
4496 if (do_profiling == PROF_YES)
4497 func_line_start(cookie);
4498#endif
4499 }
4500 }
4501
Bram Moolenaare38eab22019-12-05 21:50:01 +01004502 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004503 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004505 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004506 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004508 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 fcp->dbg_tick = debug_tick;
4510 }
4511
4512 return retval;
4513}
4514
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515/*
4516 * Return TRUE if the currently active function should be ended, because a
4517 * return was encountered or an error occurred. Used inside a ":while".
4518 */
4519 int
4520func_has_ended(void *cookie)
4521{
4522 funccall_T *fcp = (funccall_T *)cookie;
4523
Bram Moolenaare38eab22019-12-05 21:50:01 +01004524 // Ignore the "abort" flag if the abortion behavior has been changed due to
4525 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4527 || fcp->returned);
4528}
4529
4530/*
4531 * return TRUE if cookie indicates a function which "abort"s on errors.
4532 */
4533 int
4534func_has_abort(
4535 void *cookie)
4536{
4537 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4538}
4539
4540
4541/*
4542 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4543 * Don't do this when "Func" is already a partial that was bound
4544 * explicitly (pt_auto is FALSE).
4545 * Changes "rettv" in-place.
4546 * Returns the updated "selfdict_in".
4547 */
4548 dict_T *
4549make_partial(dict_T *selfdict_in, typval_T *rettv)
4550{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004551 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 char_u *tofree = NULL;
4553 ufunc_T *fp;
4554 char_u fname_buf[FLEN_FIXED + 1];
4555 int error;
4556 dict_T *selfdict = selfdict_in;
4557
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004558 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4559 fp = rettv->vval.v_partial->pt_func;
4560 else
4561 {
4562 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4563 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004564 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004565 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004566 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004567 vim_free(tofree);
4568 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569
4570 if (fp != NULL && (fp->uf_flags & FC_DICT))
4571 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004572 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573
4574 if (pt != NULL)
4575 {
4576 pt->pt_refcount = 1;
4577 pt->pt_dict = selfdict;
4578 pt->pt_auto = TRUE;
4579 selfdict = NULL;
4580 if (rettv->v_type == VAR_FUNC)
4581 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004582 // Just a function: Take over the function name and use
4583 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004584 pt->pt_name = rettv->vval.v_string;
4585 }
4586 else
4587 {
4588 partial_T *ret_pt = rettv->vval.v_partial;
4589 int i;
4590
Bram Moolenaare38eab22019-12-05 21:50:01 +01004591 // Partial: copy the function name, use selfdict and copy
4592 // args. Can't take over name or args, the partial might
4593 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004594 if (ret_pt->pt_name != NULL)
4595 {
4596 pt->pt_name = vim_strsave(ret_pt->pt_name);
4597 func_ref(pt->pt_name);
4598 }
4599 else
4600 {
4601 pt->pt_func = ret_pt->pt_func;
4602 func_ptr_ref(pt->pt_func);
4603 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 if (ret_pt->pt_argc > 0)
4605 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004606 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004608 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 pt->pt_argc = 0;
4610 else
4611 {
4612 pt->pt_argc = ret_pt->pt_argc;
4613 for (i = 0; i < pt->pt_argc; i++)
4614 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4615 }
4616 }
4617 partial_unref(ret_pt);
4618 }
4619 rettv->v_type = VAR_PARTIAL;
4620 rettv->vval.v_partial = pt;
4621 }
4622 }
4623 return selfdict;
4624}
4625
4626/*
4627 * Return the name of the executed function.
4628 */
4629 char_u *
4630func_name(void *cookie)
4631{
4632 return ((funccall_T *)cookie)->func->uf_name;
4633}
4634
4635/*
4636 * Return the address holding the next breakpoint line for a funccall cookie.
4637 */
4638 linenr_T *
4639func_breakpoint(void *cookie)
4640{
4641 return &((funccall_T *)cookie)->breakpoint;
4642}
4643
4644/*
4645 * Return the address holding the debug tick for a funccall cookie.
4646 */
4647 int *
4648func_dbg_tick(void *cookie)
4649{
4650 return &((funccall_T *)cookie)->dbg_tick;
4651}
4652
4653/*
4654 * Return the nesting level for a funccall cookie.
4655 */
4656 int
4657func_level(void *cookie)
4658{
4659 return ((funccall_T *)cookie)->level;
4660}
4661
4662/*
4663 * Return TRUE when a function was ended by a ":return" command.
4664 */
4665 int
4666current_func_returned(void)
4667{
4668 return current_funccal->returned;
4669}
4670
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671 int
4672free_unref_funccal(int copyID, int testing)
4673{
4674 int did_free = FALSE;
4675 int did_free_funccal = FALSE;
4676 funccall_T *fc, **pfc;
4677
4678 for (pfc = &previous_funccal; *pfc != NULL; )
4679 {
4680 if (can_free_funccal(*pfc, copyID))
4681 {
4682 fc = *pfc;
4683 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004684 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004685 did_free = TRUE;
4686 did_free_funccal = TRUE;
4687 }
4688 else
4689 pfc = &(*pfc)->caller;
4690 }
4691 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004692 // When a funccal was freed some more items might be garbage
4693 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 (void)garbage_collect(testing);
4695
4696 return did_free;
4697}
4698
4699/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004700 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701 */
4702 static funccall_T *
4703get_funccal(void)
4704{
4705 int i;
4706 funccall_T *funccal;
4707 funccall_T *temp_funccal;
4708
4709 funccal = current_funccal;
4710 if (debug_backtrace_level > 0)
4711 {
4712 for (i = 0; i < debug_backtrace_level; i++)
4713 {
4714 temp_funccal = funccal->caller;
4715 if (temp_funccal)
4716 funccal = temp_funccal;
4717 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004718 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 debug_backtrace_level = i;
4720 }
4721 }
4722 return funccal;
4723}
4724
4725/*
4726 * Return the hashtable used for local variables in the current funccal.
4727 * Return NULL if there is no current funccal.
4728 */
4729 hashtab_T *
4730get_funccal_local_ht()
4731{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004732 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 return NULL;
4734 return &get_funccal()->l_vars.dv_hashtab;
4735}
4736
4737/*
4738 * Return the l: scope variable.
4739 * Return NULL if there is no current funccal.
4740 */
4741 dictitem_T *
4742get_funccal_local_var()
4743{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004744 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745 return NULL;
4746 return &get_funccal()->l_vars_var;
4747}
4748
4749/*
4750 * Return the hashtable used for argument in the current funccal.
4751 * Return NULL if there is no current funccal.
4752 */
4753 hashtab_T *
4754get_funccal_args_ht()
4755{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004756 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 return NULL;
4758 return &get_funccal()->l_avars.dv_hashtab;
4759}
4760
4761/*
4762 * Return the a: scope variable.
4763 * Return NULL if there is no current funccal.
4764 */
4765 dictitem_T *
4766get_funccal_args_var()
4767{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004768 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004770 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771}
4772
4773/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 * List function variables, if there is a function.
4775 */
4776 void
4777list_func_vars(int *first)
4778{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004779 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004781 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782}
4783
4784/*
4785 * If "ht" is the hashtable for local variables in the current funccal, return
4786 * the dict that contains it.
4787 * Otherwise return NULL.
4788 */
4789 dict_T *
4790get_current_funccal_dict(hashtab_T *ht)
4791{
4792 if (current_funccal != NULL
4793 && ht == &current_funccal->l_vars.dv_hashtab)
4794 return &current_funccal->l_vars;
4795 return NULL;
4796}
4797
4798/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004799 * Search hashitem in parent scope.
4800 */
4801 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004802find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004803{
4804 funccall_T *old_current_funccal = current_funccal;
4805 hashtab_T *ht;
4806 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004807 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004808
4809 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4810 return NULL;
4811
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004812 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004813 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004814 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004815 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004816 ht = find_var_ht(name, &varname);
4817 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004818 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004819 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004820 if (!HASHITEM_EMPTY(hi))
4821 {
4822 *pht = ht;
4823 break;
4824 }
4825 }
4826 if (current_funccal == current_funccal->func->uf_scoped)
4827 break;
4828 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004829 }
4830 current_funccal = old_current_funccal;
4831
4832 return hi;
4833}
4834
4835/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004836 * Search variable in parent scope.
4837 */
4838 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004839find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004840{
4841 dictitem_T *v = NULL;
4842 funccall_T *old_current_funccal = current_funccal;
4843 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004844 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004845
4846 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4847 return NULL;
4848
Bram Moolenaare38eab22019-12-05 21:50:01 +01004849 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004850 current_funccal = current_funccal->func->uf_scoped;
4851 while (current_funccal)
4852 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004853 ht = find_var_ht(name, &varname);
4854 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004855 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004856 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004857 if (v != NULL)
4858 break;
4859 }
4860 if (current_funccal == current_funccal->func->uf_scoped)
4861 break;
4862 current_funccal = current_funccal->func->uf_scoped;
4863 }
4864 current_funccal = old_current_funccal;
4865
4866 return v;
4867}
4868
4869/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 * Set "copyID + 1" in previous_funccal and callers.
4871 */
4872 int
4873set_ref_in_previous_funccal(int copyID)
4874{
4875 int abort = FALSE;
4876 funccall_T *fc;
4877
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004878 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004880 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004881 abort = abort
4882 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4883 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004884 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885 }
4886 return abort;
4887}
4888
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004889 static int
4890set_ref_in_funccal(funccall_T *fc, int copyID)
4891{
4892 int abort = FALSE;
4893
4894 if (fc->fc_copyID != copyID)
4895 {
4896 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004897 abort = abort
4898 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4899 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004900 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004901 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004902 }
4903 return abort;
4904}
4905
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906/*
4907 * Set "copyID" in all local vars and arguments in the call stack.
4908 */
4909 int
4910set_ref_in_call_stack(int copyID)
4911{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004912 int abort = FALSE;
4913 funccall_T *fc;
4914 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004916 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004917 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004918
4919 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004920 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4921 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004922 abort = abort || set_ref_in_funccal(fc, copyID);
4923
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004924 return abort;
4925}
4926
4927/*
4928 * Set "copyID" in all functions available by name.
4929 */
4930 int
4931set_ref_in_functions(int copyID)
4932{
4933 int todo;
4934 hashitem_T *hi = NULL;
4935 int abort = FALSE;
4936 ufunc_T *fp;
4937
4938 todo = (int)func_hashtab.ht_used;
4939 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004940 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004941 if (!HASHITEM_EMPTY(hi))
4942 {
4943 --todo;
4944 fp = HI2UF(hi);
4945 if (!func_name_refcount(fp->uf_name))
4946 abort = abort || set_ref_in_func(NULL, fp, copyID);
4947 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948 }
4949 return abort;
4950}
4951
4952/*
4953 * Set "copyID" in all function arguments.
4954 */
4955 int
4956set_ref_in_func_args(int copyID)
4957{
4958 int i;
4959 int abort = FALSE;
4960
4961 for (i = 0; i < funcargs.ga_len; ++i)
4962 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4963 copyID, NULL, NULL);
4964 return abort;
4965}
4966
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004967/*
4968 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004969 * Returns TRUE if setting references failed somehow.
4970 */
4971 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004972set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004973{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004974 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004975 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004976 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004977 char_u fname_buf[FLEN_FIXED + 1];
4978 char_u *tofree = NULL;
4979 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004980 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004981
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004982 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004983 return FALSE;
4984
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004985 if (fp_in == NULL)
4986 {
4987 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004988 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004989 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004990 if (fp != NULL)
4991 {
4992 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004993 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004994 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004995
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004996 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004997 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004998}
4999
Bram Moolenaare38eab22019-12-05 21:50:01 +01005000#endif // FEAT_EVAL