blob: 450582c4f8e8d34fa4dd1cd18875067a24f2ce57 [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 Moolenaarc3fc75d2021-02-07 15:28:09 +0100129 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
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.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100157 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100158 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200159 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100160 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200161get_function_args(
162 char_u **argp,
163 char_u endchar,
164 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100166 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200167 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200169 int skip,
170 exarg_T *eap,
171 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200172{
173 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100174 char_u *arg;
175 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200177 int any_default = FALSE;
178 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100179 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200180
181 if (newargs != NULL)
182 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183 if (argtypes != NULL)
184 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200185 if (default_args != NULL)
186 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200187
188 if (varargs != NULL)
189 *varargs = FALSE;
190
191 /*
192 * Isolate the arguments: "arg1, arg2, ...)"
193 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100194 arg = skipwhite(*argp);
195 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196 while (*p != endchar)
197 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200198 while (eap != NULL && eap->getline != NULL
199 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200200 {
201 char_u *theline;
202
203 // End of the line, get the next one.
204 theline = eap->getline(':', eap->cookie, 0, TRUE);
205 if (theline == NULL)
206 break;
207 vim_free(*line_to_free);
208 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200209 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 p = skipwhite(theline);
211 }
212
213 if (mustend && *p != endchar)
214 {
215 if (!skip)
216 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100217 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200218 }
219 if (*p == endchar)
220 break;
221
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
223 {
224 if (varargs != NULL)
225 *varargs = TRUE;
226 p += 3;
227 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228
229 if (argtypes != NULL)
230 {
231 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200232 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100233 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100234 if (!skip)
235 emsg(_(e_missing_name_after_dots));
236 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100237 }
238
239 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100240 p = one_function_arg(p, newargs, argtypes, types_optional,
241 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242 if (p == arg)
243 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100244 if (*skipwhite(p) == '=')
245 {
246 emsg(_(e_cannot_use_default_for_variable_arguments));
247 break;
248 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200250 }
251 else
252 {
253 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100254 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100255 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200256 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200257
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200258 if (*skipwhite(p) == '=' && default_args != NULL)
259 {
260 typval_T rettv;
261
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100262 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200263 any_default = TRUE;
264 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200265 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200266 p = skipwhite(p);
267 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200268 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200269 {
270 if (ga_grow(default_args, 1) == FAIL)
271 goto err_ret;
272
273 // trim trailing whitespace
274 while (p > expr && VIM_ISWHITE(p[-1]))
275 p--;
276 c = *p;
277 *p = NUL;
278 expr = vim_strsave(expr);
279 if (expr == NULL)
280 {
281 *p = c;
282 goto err_ret;
283 }
284 ((char_u **)(default_args->ga_data))
285 [default_args->ga_len] = expr;
286 default_args->ga_len++;
287 *p = c;
288 }
289 else
290 mustend = TRUE;
291 }
292 else if (any_default)
293 {
294 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200295 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200296 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200297 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200298 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200300 // Don't give this error when skipping, it makes the "->" not
301 // found in "{k,v -> x}" and give a confusing error.
302 if (!skip && in_vim9script()
303 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
304 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100305 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200306 goto err_ret;
307 }
308 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200309 else
310 mustend = TRUE;
311 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200312 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200313 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200315
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200316 if (*p != endchar)
317 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100318 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200319
320 *argp = p;
321 return OK;
322
323err_ret:
324 if (newargs != NULL)
325 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200326 if (default_args != NULL)
327 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200328 return FAIL;
329}
330
331/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100332 * Parse the argument types, filling "fp->uf_arg_types".
333 * Return OK or FAIL.
334 */
335 static int
336parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
337{
338 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
339 if (argtypes->ga_len > 0)
340 {
341 // When "varargs" is set the last name/type goes into uf_va_name
342 // and uf_va_type.
343 int len = argtypes->ga_len - (varargs ? 1 : 0);
344
345 if (len > 0)
346 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
347 if (fp->uf_arg_types != NULL)
348 {
349 int i;
350 type_T *type;
351
352 for (i = 0; i < len; ++ i)
353 {
354 char_u *p = ((char_u **)argtypes->ga_data)[i];
355
356 if (p == NULL)
357 // will get the type from the default value
358 type = &t_unknown;
359 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100360 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100361 if (type == NULL)
362 return FAIL;
363 fp->uf_arg_types[i] = type;
364 }
365 }
366 if (varargs)
367 {
368 char_u *p;
369
370 // Move the last argument "...name: type" to uf_va_name and
371 // uf_va_type.
372 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
373 [fp->uf_args.ga_len - 1];
374 --fp->uf_args.ga_len;
375 p = ((char_u **)argtypes->ga_data)[len];
376 if (p == NULL)
377 // todo: get type from default value
378 fp->uf_va_type = &t_any;
379 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100380 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100381 if (fp->uf_va_type == NULL)
382 return FAIL;
383 }
384 }
385 return OK;
386}
387
388/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200389 * Register function "fp" as using "current_funccal" as its scope.
390 */
391 static int
392register_closure(ufunc_T *fp)
393{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200394 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100395 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200396 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200397 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200398 fp->uf_scoped = current_funccal;
399 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200400
Bram Moolenaar58016442016-07-31 18:30:22 +0200401 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
402 return FAIL;
403 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
404 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200405 return OK;
406}
407
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100408 static void
409set_ufunc_name(ufunc_T *fp, char_u *name)
410{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100411 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
412 // actually extends beyond the struct.
413 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100414
415 if (name[0] == K_SPECIAL)
416 {
417 fp->uf_name_exp = alloc(STRLEN(name) + 3);
418 if (fp->uf_name_exp != NULL)
419 {
420 STRCPY(fp->uf_name_exp, "<SNR>");
421 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
422 }
423 }
424}
425
Bram Moolenaar58016442016-07-31 18:30:22 +0200426/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200427 * Get a name for a lambda. Returned in static memory.
428 */
429 char_u *
430get_lambda_name(void)
431{
432 static char_u name[30];
433 static int lambda_no = 0;
434
435 sprintf((char*)name, "<lambda>%d", ++lambda_no);
436 return name;
437}
438
Bram Moolenaar801ab062020-06-25 19:27:56 +0200439#if defined(FEAT_LUA) || defined(PROTO)
440/*
441 * Registers a native C callback which can be called from Vim script.
442 * Returns the name of the Vim script function.
443 */
444 char_u *
445register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
446{
447 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200448 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200449
450 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
451 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200452 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200453
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200454 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200455 fp->uf_refcount = 1;
456 fp->uf_varargs = TRUE;
457 fp->uf_flags = FC_CFUNC;
458 fp->uf_calls = 0;
459 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200460 fp->uf_cb = cb;
461 fp->uf_cb_free = cb_free;
462 fp->uf_cb_state = state;
463
464 set_ufunc_name(fp, name);
465 hash_add(&func_hashtab, UF2HIKEY(fp));
466
467 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200468}
469#endif
470
Bram Moolenaar04b12692020-05-04 23:24:44 +0200471/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100472 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100473 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100474 * If "white_error" is not NULL check for correct use of white space and set
475 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100476 * Return NULL if no valid arrow found.
477 */
478 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100479skip_arrow(
480 char_u *start,
481 int equal_arrow,
482 char_u **ret_type,
483 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100484{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100485 char_u *s = start;
486 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100487
488 if (equal_arrow)
489 {
490 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100491 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100492 if (white_error != NULL && !VIM_ISWHITE(s[1]))
493 {
494 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100495 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100496 return NULL;
497 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100498 s = skipwhite(s + 1);
499 *ret_type = s;
500 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100501 if (s == *ret_type)
502 {
503 emsg(_(e_missing_return_type));
504 return NULL;
505 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100506 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100507 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100508 s = skipwhite(s);
509 if (*s != '=')
510 return NULL;
511 ++s;
512 }
513 if (*s != '>')
514 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100515 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
516 || !IS_WHITE_OR_NUL(s[1])))
517 {
518 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100519 semsg(_(e_white_space_required_before_and_after_str_at_str),
520 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100521 return NULL;
522 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100523 return skipwhite(s + 1);
524}
525
526/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200527 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100528 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100529 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200530 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
531 */
532 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100533get_lambda_tv(
534 char_u **arg,
535 typval_T *rettv,
536 int types_optional,
537 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200538{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200539 int evaluate = evalarg != NULL
540 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200541 garray_T newargs;
542 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200543 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100544 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200545 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100546 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200547 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100548 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200549 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200550 char_u *s;
551 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200552 int *old_eval_lavars = eval_lavars_used;
553 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100554 char_u *tofree1 = NULL;
555 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100557 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +0100558 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100559
560 if (equal_arrow && !in_vim9script())
561 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200562
563 ga_init(&newargs);
564 ga_init(&newlines);
565
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 // First, check if this is really a lambda expression. "->" or "=>" must
567 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100568 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100569 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100570 types_optional ? &argtypes : NULL, types_optional,
571 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100572 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100573 {
574 if (types_optional)
575 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100576 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100577 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200578
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100579 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200580 if (evaluate)
581 pnewargs = &newargs;
582 else
583 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100584 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100585 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100586 types_optional ? &argtypes : NULL, types_optional,
587 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100588 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100589 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100590 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100591 {
592 if (types_optional)
593 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100594 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100595 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100596 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100597 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200598
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100599 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
600 if (ret_type != NULL)
601 {
602 ret_type = vim_strsave(ret_type);
603 tofree2 = ret_type;
604 }
605
Bram Moolenaare38eab22019-12-05 21:50:01 +0100606 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200607 if (evaluate)
608 eval_lavars_used = &eval_lavars;
609
Bram Moolenaar65c44152020-12-24 15:14:01 +0100610 *arg = skipwhite_and_linebreak(*arg, evalarg);
611
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100612 // Recognize "{" as the start of a function body.
613 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100614 {
615 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100616 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100617 emsg("Lambda function body not supported yet");
618 goto errret;
619 }
620
Bram Moolenaare38eab22019-12-05 21:50:01 +0100621 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200622 start = *arg;
623 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200624 if (ret == FAIL)
625 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200626 if (evalarg != NULL)
627 {
628 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100629 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200630 evalarg->eval_tofree = NULL;
631 }
632
Bram Moolenaar65c44152020-12-24 15:14:01 +0100633 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100634 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100635 *arg = skipwhite_and_linebreak(*arg, evalarg);
636 if (**arg != '}')
637 {
638 semsg(_("E451: Expected }: %s"), *arg);
639 goto errret;
640 }
641 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200643
644 if (evaluate)
645 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200646 int len;
647 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200648 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200649 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200650
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200651 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200652 if (fp == NULL)
653 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200654 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200655 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200656 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200657 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200658
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200659 ga_init2(&newlines, (int)sizeof(char_u *), 1);
660 if (ga_grow(&newlines, 1) == FAIL)
661 goto errret;
662
Bram Moolenaare38eab22019-12-05 21:50:01 +0100663 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200664 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200665 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200666 if (p == NULL)
667 goto errret;
668 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
669 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200670 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200671 if (strstr((char *)p + 7, "a:") == NULL)
672 // No a: variables are used for sure.
673 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200674
675 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100676 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200677 hash_add(&func_hashtab, UF2HIKEY(fp));
678 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200679 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100680 if (types_optional)
681 {
682 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
683 goto errret;
684 if (ret_type != NULL)
685 {
686 fp->uf_ret_type = parse_type(&ret_type,
687 &fp->uf_type_list, TRUE);
688 if (fp->uf_ret_type == NULL)
689 goto errret;
690 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100691 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100692 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100693 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100694
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200695 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200696 if (current_funccal != NULL && eval_lavars)
697 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200698 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200699 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200700 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200701 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200702
703#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200704 if (prof_def_func())
705 func_do_profile(fp);
706#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200707 if (sandbox)
708 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100709 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200710 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200711 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200712 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200713 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100714 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200715
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200716 pt->pt_func = fp;
717 pt->pt_refcount = 1;
718 rettv->vval.v_partial = pt;
719 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200720 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200721
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200722 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200723 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100724 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200725 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100726 vim_free(tofree1);
727 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100728 if (types_optional)
729 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730 return OK;
731
732errret:
733 ga_clear_strings(&newargs);
734 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100735 if (types_optional)
736 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200737 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100738 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200739 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100740 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200741 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100742 vim_free(tofree1);
743 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200744 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200745 return FAIL;
746}
747
748/*
749 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
750 * name it contains, otherwise return "name".
751 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
752 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100753 * If "type" is not NULL and a Vim9 script-local variable is found look up the
754 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200755 */
756 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100757deref_func_name(
758 char_u *name,
759 int *lenp,
760 partial_T **partialp,
761 type_T **type,
762 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200763{
764 dictitem_T *v;
765 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100766 char_u *s = NULL;
767 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200768
769 if (partialp != NULL)
770 *partialp = NULL;
771
772 cc = name[*lenp];
773 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100774 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200775 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100776 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200777 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100778 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200779 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100780 if (v->di_tv.vval.v_string == NULL)
781 {
782 *lenp = 0;
783 return (char_u *)""; // just in case
784 }
785 s = v->di_tv.vval.v_string;
786 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200787 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200788
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100789 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200790 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100791 partial_T *pt = v->di_tv.vval.v_partial;
792
793 if (pt == NULL)
794 {
795 *lenp = 0;
796 return (char_u *)""; // just in case
797 }
798 if (partialp != NULL)
799 *partialp = pt;
800 s = partial_name(pt);
801 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200802 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100803
804 if (s != NULL)
805 {
806 if (type != NULL && ht == get_script_local_ht())
807 {
808 svar_T *sv = find_typval_in_script(&v->di_tv);
809
810 if (sv != NULL)
811 *type = sv->sv_type;
812 }
813 return s;
814 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200815 }
816
817 return name;
818}
819
820/*
821 * Give an error message with a function name. Handle <SNR> things.
822 * "ermsg" is to be passed without translation, use N_() instead of _().
823 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100824 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200825emsg_funcname(char *ermsg, char_u *name)
826{
827 char_u *p;
828
829 if (*name == K_SPECIAL)
830 p = concat_str((char_u *)"<SNR>", name + 3);
831 else
832 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100833 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200834 if (p != name)
835 vim_free(p);
836}
837
838/*
839 * Allocate a variable for the result of a function.
840 * Return OK or FAIL.
841 */
842 int
843get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200844 char_u *name, // name of the function
845 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200846 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200847 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200848 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200849 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200850{
851 char_u *argp;
852 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100853 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
854 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200855 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200856
857 /*
858 * Get the arguments.
859 */
860 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200861 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
862 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200863 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200864 // skip the '(' or ',' and possibly line breaks
865 argp = skipwhite_and_linebreak(argp + 1, evalarg);
866
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200867 if (*argp == ')' || *argp == ',' || *argp == NUL)
868 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200869 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200870 {
871 ret = FAIL;
872 break;
873 }
874 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200875 // The comma should come right after the argument, but this wasn't
876 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200877 if (vim9script)
878 {
879 if (*argp != ',' && *skipwhite(argp) == ',')
880 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +0100881 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200882 ret = FAIL;
883 break;
884 }
885 }
886 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200887 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200888 if (*argp != ',')
889 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200890 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
891 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100892 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200893 ret = FAIL;
894 break;
895 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200896 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200897 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200898 if (*argp == ')')
899 ++argp;
900 else
901 ret = FAIL;
902
903 if (ret == OK)
904 {
905 int i = 0;
906
907 if (get_vim_var_nr(VV_TESTING))
908 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100909 // Prepare for calling test_garbagecollect_now(), need to know
910 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200911 if (funcargs.ga_itemsize == 0)
912 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
913 for (i = 0; i < argcount; ++i)
914 if (ga_grow(&funcargs, 1) == OK)
915 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
916 &argvars[i];
917 }
918
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200919 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200920
921 funcargs.ga_len -= i;
922 }
923 else if (!aborting())
924 {
925 if (argcount == MAX_FUNC_ARGS)
926 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
927 else
928 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
929 }
930
931 while (--argcount >= 0)
932 clear_tv(&argvars[argcount]);
933
Bram Moolenaar8294d492020-08-10 22:40:56 +0200934 if (in_vim9script())
935 *arg = argp;
936 else
937 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200938 return ret;
939}
940
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200941/*
942 * Return TRUE if "p" starts with "<SID>" or "s:".
943 * Only works if eval_fname_script() returned non-zero for "p"!
944 */
945 static int
946eval_fname_sid(char_u *p)
947{
948 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
949}
950
951/*
952 * In a script change <SID>name() and s:name() to K_SNR 123_name().
953 * Change <SNR>123_name() to K_SNR 123_name().
954 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
955 * (slow).
956 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100957 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200958fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
959{
960 int llen;
961 char_u *fname;
962 int i;
963
964 llen = eval_fname_script(name);
965 if (llen > 0)
966 {
967 fname_buf[0] = K_SPECIAL;
968 fname_buf[1] = KS_EXTRA;
969 fname_buf[2] = (int)KE_SNR;
970 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100971 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200972 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200973 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100974 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200975 else
976 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200977 sprintf((char *)fname_buf + 3, "%ld_",
978 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200979 i = (int)STRLEN(fname_buf);
980 }
981 }
982 if (i + STRLEN(name + llen) < FLEN_FIXED)
983 {
984 STRCPY(fname_buf + i, name + llen);
985 fname = fname_buf;
986 }
987 else
988 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200989 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200990 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100991 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200992 else
993 {
994 *tofree = fname;
995 mch_memmove(fname, fname_buf, (size_t)i);
996 STRCPY(fname + i, name + llen);
997 }
998 }
999 }
1000 else
1001 fname = name;
1002 return fname;
1003}
1004
1005/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001006 * Find a function "name" in script "sid".
1007 */
1008 static ufunc_T *
1009find_func_with_sid(char_u *name, int sid)
1010{
1011 hashitem_T *hi;
1012 char_u buffer[200];
1013
1014 buffer[0] = K_SPECIAL;
1015 buffer[1] = KS_EXTRA;
1016 buffer[2] = (int)KE_SNR;
1017 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1018 (long)sid, name);
1019 hi = hash_find(&func_hashtab, buffer);
1020 if (!HASHITEM_EMPTY(hi))
1021 return HI2UF(hi);
1022
1023 return NULL;
1024}
1025
1026/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001027 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001028 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001029 * Return NULL for unknown function.
1030 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001031 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001032find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001033{
1034 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001035 ufunc_T *func;
1036 imported_T *imported;
1037
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001038 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001039 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001040 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001041 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001042 int find_script_local = in_vim9script()
1043 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001044
Bram Moolenaar95006e32020-08-29 17:47:08 +02001045 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001046 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001047 // Find script-local function before global one.
1048 func = find_func_with_sid(name, current_sctx.sc_sid);
1049 if (func != NULL)
1050 return func;
1051 }
1052
Bram Moolenaarefa94442020-08-08 22:16:00 +02001053 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001054 && name[1] == KS_EXTRA
1055 && name[2] == KE_SNR)
1056 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001057 // Caller changes s: to <SNR>99_name.
1058
1059 after_script = name + 3;
1060 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001061 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001062 ++after_script;
1063 else
1064 after_script = NULL;
1065 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001066 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001067 {
1068 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001069 if (after_script != NULL && sid != current_sctx.sc_sid)
1070 imported = find_imported_in_script(after_script, 0, sid);
1071 else
1072 imported = find_imported(after_script == NULL
1073 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001074 if (imported != NULL && imported->imp_funcname != NULL)
1075 {
1076 hi = hash_find(&func_hashtab, imported->imp_funcname);
1077 if (!HASHITEM_EMPTY(hi))
1078 return HI2UF(hi);
1079 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001080 }
1081 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001082
Bram Moolenaara26b9702020-04-18 19:53:28 +02001083 hi = hash_find(&func_hashtab,
1084 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001085 if (!HASHITEM_EMPTY(hi))
1086 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001087
1088 return NULL;
1089}
1090
1091/*
1092 * Find a function by name, return pointer to it in ufuncs.
1093 * "cctx" is passed in a :def function to find imported functions.
1094 * Return NULL for unknown or dead function.
1095 */
1096 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001097find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001098{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001099 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001100
1101 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1102 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001103 return NULL;
1104}
1105
1106/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001107 * Return TRUE if "ufunc" is a global function.
1108 */
1109 int
1110func_is_global(ufunc_T *ufunc)
1111{
1112 return ufunc->uf_name[0] != K_SPECIAL;
1113}
1114
1115/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001116 * Copy the function name of "fp" to buffer "buf".
1117 * "buf" must be able to hold the function name plus three bytes.
1118 * Takes care of script-local function names.
1119 */
1120 static void
1121cat_func_name(char_u *buf, ufunc_T *fp)
1122{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001123 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001124 {
1125 STRCPY(buf, "<SNR>");
1126 STRCAT(buf, fp->uf_name + 3);
1127 }
1128 else
1129 STRCPY(buf, fp->uf_name);
1130}
1131
1132/*
1133 * Add a number variable "name" to dict "dp" with value "nr".
1134 */
1135 static void
1136add_nr_var(
1137 dict_T *dp,
1138 dictitem_T *v,
1139 char *name,
1140 varnumber_T nr)
1141{
1142 STRCPY(v->di_key, name);
1143 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1144 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1145 v->di_tv.v_type = VAR_NUMBER;
1146 v->di_tv.v_lock = VAR_FIXED;
1147 v->di_tv.vval.v_number = nr;
1148}
1149
1150/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001151 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001152 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001153 static void
1154free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001155{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001156 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001157
1158 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1159 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001160 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001161
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001162 // When garbage collecting a funccall_T may be freed before the
1163 // function that references it, clear its uf_scoped field.
1164 // The function may have been redefined and point to another
1165 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001166 if (fp != NULL && fp->uf_scoped == fc)
1167 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001168 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001169 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001170
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001171 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001172 vim_free(fc);
1173}
1174
1175/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001176 * Free "fc" and what it contains.
1177 * Can be called only when "fc" is kept beyond the period of it called,
1178 * i.e. after cleanup_function_call(fc).
1179 */
1180 static void
1181free_funccal_contents(funccall_T *fc)
1182{
1183 listitem_T *li;
1184
1185 // Free all l: variables.
1186 vars_clear(&fc->l_vars.dv_hashtab);
1187
1188 // Free all a: variables.
1189 vars_clear(&fc->l_avars.dv_hashtab);
1190
1191 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001192 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001193 clear_tv(&li->li_tv);
1194
1195 free_funccal(fc);
1196}
1197
1198/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001199 * Handle the last part of returning from a function: free the local hashtable.
1200 * Unless it is still in use by a closure.
1201 */
1202 static void
1203cleanup_function_call(funccall_T *fc)
1204{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001205 int may_free_fc = fc->fc_refcount <= 0;
1206 int free_fc = TRUE;
1207
Bram Moolenaar6914c642017-04-01 21:21:30 +02001208 current_funccal = fc->caller;
1209
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001210 // Free all l: variables if not referred.
1211 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1212 vars_clear(&fc->l_vars.dv_hashtab);
1213 else
1214 free_fc = FALSE;
1215
1216 // If the a:000 list and the l: and a: dicts are not referenced and
1217 // there is no closure using it, we can free the funccall_T and what's
1218 // in it.
1219 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1220 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001221 else
1222 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001223 int todo;
1224 hashitem_T *hi;
1225 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001226
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001227 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001228
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001229 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001230 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1231 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1232 {
1233 if (!HASHITEM_EMPTY(hi))
1234 {
1235 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001236 di = HI2DI(hi);
1237 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001238 }
1239 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001240 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001241
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001242 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1243 fc->l_varlist.lv_first = NULL;
1244 else
1245 {
1246 listitem_T *li;
1247
1248 free_fc = FALSE;
1249
1250 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001251 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001252 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001253 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001254
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001255 if (free_fc)
1256 free_funccal(fc);
1257 else
1258 {
1259 static int made_copy = 0;
1260
1261 // "fc" is still in use. This can happen when returning "a:000",
1262 // assigning "l:" to a global variable or defining a closure.
1263 // Link "fc" in the list for garbage collection later.
1264 fc->caller = previous_funccal;
1265 previous_funccal = fc;
1266
1267 if (want_garbage_collect)
1268 // If garbage collector is ready, clear count.
1269 made_copy = 0;
1270 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001271 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001272 // We have made a lot of copies, worth 4 Mbyte. This can happen
1273 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001274 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001275 // too much memory.
1276 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001277 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001278 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001279 }
1280}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001281
1282/*
1283 * There are two kinds of function names:
1284 * 1. ordinary names, function defined with :function or :def
1285 * 2. numbered functions and lambdas
1286 * For the first we only count the name stored in func_hashtab as a reference,
1287 * using function() does not count as a reference, because the function is
1288 * looked up by name.
1289 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001290 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001291func_name_refcount(char_u *name)
1292{
1293 return isdigit(*name) || *name == '<';
1294}
1295
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001296/*
1297 * Unreference "fc": decrement the reference count and free it when it
1298 * becomes zero. "fp" is detached from "fc".
1299 * When "force" is TRUE we are exiting.
1300 */
1301 static void
1302funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1303{
1304 funccall_T **pfc;
1305 int i;
1306
1307 if (fc == NULL)
1308 return;
1309
1310 if (--fc->fc_refcount <= 0 && (force || (
1311 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1312 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1313 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1314 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1315 {
1316 if (fc == *pfc)
1317 {
1318 *pfc = fc->caller;
1319 free_funccal_contents(fc);
1320 return;
1321 }
1322 }
1323 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1324 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1325 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1326}
1327
1328/*
1329 * Remove the function from the function hashtable. If the function was
1330 * deleted while it still has references this was already done.
1331 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1332 */
1333 static int
1334func_remove(ufunc_T *fp)
1335{
1336 hashitem_T *hi;
1337
1338 // Return if it was already virtually deleted.
1339 if (fp->uf_flags & FC_DEAD)
1340 return FALSE;
1341
1342 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1343 if (!HASHITEM_EMPTY(hi))
1344 {
1345 // When there is a def-function index do not actually remove the
1346 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001347 // Do remove it when it's a copy.
1348 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001349 fp->uf_flags |= FC_DEAD;
1350 else
1351 hash_remove(&func_hashtab, hi);
1352 return TRUE;
1353 }
1354 return FALSE;
1355}
1356
1357 static void
1358func_clear_items(ufunc_T *fp)
1359{
1360 ga_clear_strings(&(fp->uf_args));
1361 ga_clear_strings(&(fp->uf_def_args));
1362 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001363 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001364 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001365 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001366 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001367 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001368
1369 // Increment the refcount of this function to avoid it being freed
1370 // recursively when the partial is freed.
1371 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001372 partial_unref(fp->uf_partial);
1373 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001374 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001375
1376#ifdef FEAT_LUA
1377 if (fp->uf_cb_free != NULL)
1378 {
1379 fp->uf_cb_free(fp->uf_cb_state);
1380 fp->uf_cb_free = NULL;
1381 }
1382
1383 fp->uf_cb_state = NULL;
1384 fp->uf_cb = NULL;
1385#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001386#ifdef FEAT_PROFILE
1387 VIM_CLEAR(fp->uf_tml_count);
1388 VIM_CLEAR(fp->uf_tml_total);
1389 VIM_CLEAR(fp->uf_tml_self);
1390#endif
1391}
1392
1393/*
1394 * Free all things that a function contains. Does not free the function
1395 * itself, use func_free() for that.
1396 * When "force" is TRUE we are exiting.
1397 */
1398 static void
1399func_clear(ufunc_T *fp, int force)
1400{
1401 if (fp->uf_cleared)
1402 return;
1403 fp->uf_cleared = TRUE;
1404
1405 // clear this function
1406 func_clear_items(fp);
1407 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001408 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001409}
1410
1411/*
1412 * Free a function and remove it from the list of functions. Does not free
1413 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001414 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001415 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001416 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001417 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001418func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001419{
1420 // Only remove it when not done already, otherwise we would remove a newer
1421 // version of the function with the same name.
1422 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1423 func_remove(fp);
1424
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001425 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001426 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001427 if (fp->uf_dfunc_idx > 0)
1428 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001429 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001430 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001431 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001432 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001433 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001434}
1435
1436/*
1437 * Free all things that a function contains and free the function itself.
1438 * When "force" is TRUE we are exiting.
1439 */
1440 static void
1441func_clear_free(ufunc_T *fp, int force)
1442{
1443 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001444 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1445 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001446 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001447 else
1448 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001449}
1450
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001451/*
1452 * Copy already defined function "lambda" to a new function with name "global".
1453 * This is for when a compiled function defines a global function.
1454 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001455 int
1456copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001457{
1458 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001459 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001460
1461 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001462 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001463 semsg(_(e_lambda_function_not_found_str), lambda);
1464 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001465 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001466
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001467 fp = find_func(global, TRUE, NULL);
1468 if (fp != NULL)
1469 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001470 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001471 semsg(_(e_funcexts), global);
1472 return FAIL;
1473 }
1474
1475 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1476 if (fp == NULL)
1477 return FAIL;
1478
1479 fp->uf_varargs = ufunc->uf_varargs;
1480 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1481 fp->uf_def_status = ufunc->uf_def_status;
1482 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1483 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1484 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1485 == FAIL
1486 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1487 goto failed;
1488
1489 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1490 : vim_strsave(ufunc->uf_name_exp);
1491 if (ufunc->uf_arg_types != NULL)
1492 {
1493 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1494 if (fp->uf_arg_types == NULL)
1495 goto failed;
1496 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1497 sizeof(type_T *) * fp->uf_args.ga_len);
1498 }
1499 if (ufunc->uf_def_arg_idx != NULL)
1500 {
1501 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1502 if (fp->uf_def_arg_idx == NULL)
1503 goto failed;
1504 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1505 sizeof(int) * fp->uf_def_args.ga_len + 1);
1506 }
1507 if (ufunc->uf_va_name != NULL)
1508 {
1509 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1510 if (fp->uf_va_name == NULL)
1511 goto failed;
1512 }
1513 fp->uf_ret_type = ufunc->uf_ret_type;
1514
1515 fp->uf_refcount = 1;
1516 STRCPY(fp->uf_name, global);
1517 hash_add(&func_hashtab, UF2HIKEY(fp));
1518
1519 // the referenced dfunc_T is now used one more time
1520 link_def_function(fp);
1521
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001522 // Create a partial to store the context of the function where it was
1523 // instantiated. Only needs to be done once. Do this on the original
1524 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001525 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1526 {
1527 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1528
1529 if (pt == NULL)
1530 goto failed;
1531 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001532 {
1533 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001534 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001535 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001536 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001537 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001538 }
1539
1540 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001541
1542failed:
1543 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001544 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001545}
1546
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001547static int funcdepth = 0;
1548
1549/*
1550 * Increment the function call depth count.
1551 * Return FAIL when going over 'maxfuncdepth'.
1552 * Otherwise return OK, must call funcdepth_decrement() later!
1553 */
1554 int
1555funcdepth_increment(void)
1556{
1557 if (funcdepth >= p_mfd)
1558 {
1559 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1560 return FAIL;
1561 }
1562 ++funcdepth;
1563 return OK;
1564}
1565
1566 void
1567funcdepth_decrement(void)
1568{
1569 --funcdepth;
1570}
1571
1572/*
1573 * Get the current function call depth.
1574 */
1575 int
1576funcdepth_get(void)
1577{
1578 return funcdepth;
1579}
1580
1581/*
1582 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001583 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001584 * times as funcdepth_increment().
1585 */
1586 void
1587funcdepth_restore(int depth)
1588{
1589 funcdepth = depth;
1590}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001591
1592/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593 * Call a user function.
1594 */
1595 static void
1596call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001597 ufunc_T *fp, // pointer to function
1598 int argcount, // nr of args
1599 typval_T *argvars, // arguments
1600 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001601 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001602 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001604 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001605 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001606 funccall_T *fc;
1607 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001608 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001610 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611 int i;
1612 int ai;
1613 int islambda = FALSE;
1614 char_u numbuf[NUMBUFLEN];
1615 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001616#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001617 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001619 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620
Bram Moolenaarb2049902021-01-24 12:53:53 +01001621#ifdef FEAT_PROFILE
1622 CLEAR_FIELD(profile_info);
1623#endif
1624
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001625 // If depth of calling is getting too high, don't execute the function.
1626 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628 rettv->v_type = VAR_NUMBER;
1629 rettv->vval.v_number = -1;
1630 return;
1631 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001632
Bram Moolenaare38eab22019-12-05 21:50:01 +01001633 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001635 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001636 if (fc == NULL)
1637 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638 fc->caller = current_funccal;
1639 current_funccal = fc;
1640 fc->func = fp;
1641 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001643 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1645 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001646 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001647 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001648 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001650 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001651 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01001652#ifdef FEAT_PROFILE
1653 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
1654#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001655 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01001656#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001657 if (do_profiling == PROF_YES)
1658 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01001659#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001660 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001661 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01001662#ifdef FEAT_PROFILE
1663 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01001664 || (caller != NULL && caller->uf_profiling)))
1665 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01001666#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001667 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001668 free_funccal(fc);
1669 return;
1670 }
1671
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1673 islambda = TRUE;
1674
1675 /*
1676 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1677 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1678 * each argument variable and saves a lot of time.
1679 */
1680 /*
1681 * Init l: variables.
1682 */
1683 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1684 if (selfdict != NULL)
1685 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001686 // Set l:self to "selfdict". Use "name" to avoid a warning from
1687 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 v = &fc->fixvar[fixvar_idx++].var;
1689 name = v->di_key;
1690 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001691 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1693 v->di_tv.v_type = VAR_DICT;
1694 v->di_tv.v_lock = 0;
1695 v->di_tv.vval.v_dict = selfdict;
1696 ++selfdict->dv_refcount;
1697 }
1698
1699 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001700 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001701 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001702 * Set a:000 to a list with room for the "..." arguments.
1703 */
1704 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001705 if ((fp->uf_flags & FC_NOARGS) == 0)
1706 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001707 (varnumber_T)(argcount >= fp->uf_args.ga_len
1708 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001709 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001710 if ((fp->uf_flags & FC_NOARGS) == 0)
1711 {
1712 // Use "name" to avoid a warning from some compiler that checks the
1713 // destination size.
1714 v = &fc->fixvar[fixvar_idx++].var;
1715 name = v->di_key;
1716 STRCPY(name, "000");
1717 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1718 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1719 v->di_tv.v_type = VAR_LIST;
1720 v->di_tv.v_lock = VAR_FIXED;
1721 v->di_tv.vval.v_list = &fc->l_varlist;
1722 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001723 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001724 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1725 fc->l_varlist.lv_lock = VAR_FIXED;
1726
1727 /*
1728 * Set a:firstline to "firstline" and a:lastline to "lastline".
1729 * Set a:name to named arguments.
1730 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001731 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001733 if ((fp->uf_flags & FC_NOARGS) == 0)
1734 {
1735 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001736 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001737 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001738 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001739 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001740 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 {
1742 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001743 typval_T def_rettv;
1744 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745
1746 ai = i - fp->uf_args.ga_len;
1747 if (ai < 0)
1748 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001749 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 name = FUNCARG(fp, i);
1751 if (islambda)
1752 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001753
1754 // evaluate named argument default expression
1755 isdefault = ai + fp->uf_def_args.ga_len >= 0
1756 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1757 && argvars[i].vval.v_number == VVAL_NONE));
1758 if (isdefault)
1759 {
1760 char_u *default_expr = NULL;
1761 def_rettv.v_type = VAR_NUMBER;
1762 def_rettv.vval.v_number = -1;
1763
1764 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1765 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001766 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001767 {
1768 default_arg_err = 1;
1769 break;
1770 }
1771 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001772 }
1773 else
1774 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001775 if ((fp->uf_flags & FC_NOARGS) != 0)
1776 // Bail out if no a: arguments used (in lambda).
1777 break;
1778
Bram Moolenaare38eab22019-12-05 21:50:01 +01001779 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780 sprintf((char *)numbuf, "%d", ai + 1);
1781 name = numbuf;
1782 }
1783 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1784 {
1785 v = &fc->fixvar[fixvar_idx++].var;
1786 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001787 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 }
1789 else
1790 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001791 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 if (v == NULL)
1793 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001794 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001797 // Note: the values are copied directly to avoid alloc/free.
1798 // "argvars" must have VAR_FIXED for v_lock.
1799 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800 v->di_tv.v_lock = VAR_FIXED;
1801
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802 if (addlocal)
1803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001804 // Named arguments should be accessed without the "a:" prefix in
1805 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001806 copy_tv(&v->di_tv, &v->di_tv);
1807 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001809 else
1810 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811
1812 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1813 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001814 listitem_T *li = &fc->l_listitems[ai];
1815
1816 li->li_tv = argvars[i];
1817 li->li_tv.v_lock = VAR_FIXED;
1818 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819 }
1820 }
1821
Bram Moolenaare38eab22019-12-05 21:50:01 +01001822 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001824
1825 if (fp->uf_flags & FC_SANDBOX)
1826 {
1827 using_sandbox = TRUE;
1828 ++sandbox;
1829 }
1830
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001831 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001832 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001833 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001835 ++no_wait_return;
1836 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001838 smsg(_("calling %s"), SOURCING_NAME);
1839 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001840 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001841 char_u buf[MSG_BUF_LEN];
1842 char_u numbuf2[NUMBUFLEN];
1843 char_u *tofree;
1844 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001846 msg_puts("(");
1847 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001849 if (i > 0)
1850 msg_puts(", ");
1851 if (argvars[i].v_type == VAR_NUMBER)
1852 msg_outnum((long)argvars[i].vval.v_number);
1853 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001855 // Do not want errors such as E724 here.
1856 ++emsg_off;
1857 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1858 --emsg_off;
1859 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001861 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001862 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001863 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1864 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001866 msg_puts((char *)s);
1867 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 }
1869 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001871 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001872 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001873 msg_puts("\n"); // don't overwrite this either
1874
1875 verbose_leave_scroll();
1876 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877 }
1878#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001879 if (do_profiling == PROF_YES)
1880 profile_may_start_func(&profile_info, fp,
1881 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001882#endif
1883
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001884 save_current_sctx = current_sctx;
1885 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001886 save_did_emsg = did_emsg;
1887 did_emsg = FALSE;
1888
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001889 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1890 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001891 else if (islambda)
1892 {
1893 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1894
1895 // A Lambda always has the command "return {expr}". It is much faster
1896 // to evaluate {expr} directly.
1897 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001898 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001899 --ex_nesting_level;
1900 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001901 else
1902 // call do_cmdline() to execute the lines
1903 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001904 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1905
1906 --RedrawingDisabled;
1907
Bram Moolenaare38eab22019-12-05 21:50:01 +01001908 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1910 {
1911 clear_tv(rettv);
1912 rettv->v_type = VAR_NUMBER;
1913 rettv->vval.v_number = -1;
1914 }
1915
1916#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001917 if (do_profiling == PROF_YES)
1918 {
1919 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
1920
1921 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
1922 profile_may_end_func(&profile_info, fp, caller);
1923 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001924#endif
1925
Bram Moolenaare38eab22019-12-05 21:50:01 +01001926 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 if (p_verbose >= 12)
1928 {
1929 ++no_wait_return;
1930 verbose_enter_scroll();
1931
1932 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001933 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001935 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001936 (long)fc->rettv->vval.v_number);
1937 else
1938 {
1939 char_u buf[MSG_BUF_LEN];
1940 char_u numbuf2[NUMBUFLEN];
1941 char_u *tofree;
1942 char_u *s;
1943
Bram Moolenaare38eab22019-12-05 21:50:01 +01001944 // The value may be very long. Skip the middle part, so that we
1945 // have some idea how it starts and ends. smsg() would always
1946 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 ++emsg_off;
1948 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1949 --emsg_off;
1950 if (s != NULL)
1951 {
1952 if (vim_strsize(s) > MSG_BUF_CLEN)
1953 {
1954 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1955 s = buf;
1956 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001957 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958 vim_free(tofree);
1959 }
1960 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001961 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001962
1963 verbose_leave_scroll();
1964 --no_wait_return;
1965 }
1966
Bram Moolenaare31ee862020-01-07 20:59:34 +01001967 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001968 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001969 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001970#ifdef FEAT_PROFILE
1971 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01001972 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001973#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001974 if (using_sandbox)
1975 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001976
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001977 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001978 {
1979 ++no_wait_return;
1980 verbose_enter_scroll();
1981
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001982 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001983 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001984
1985 verbose_leave_scroll();
1986 --no_wait_return;
1987 }
1988
1989 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001990 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001991 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001992}
1993
1994/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001995 * Check the argument count for user function "fp".
1996 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1997 */
1998 int
1999check_user_func_argcount(ufunc_T *fp, int argcount)
2000{
2001 int regular_args = fp->uf_args.ga_len;
2002
2003 if (argcount < regular_args - fp->uf_def_args.ga_len)
2004 return FCERR_TOOFEW;
2005 else if (!has_varargs(fp) && argcount > regular_args)
2006 return FCERR_TOOMANY;
2007 return FCERR_UNKNOWN;
2008}
2009
2010/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002011 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002012 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013 int
2014call_user_func_check(
2015 ufunc_T *fp,
2016 int argcount,
2017 typval_T *argvars,
2018 typval_T *rettv,
2019 funcexe_T *funcexe,
2020 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002021{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002022 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002023
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2025 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002026 error = check_user_func_argcount(fp, argcount);
2027 if (error != FCERR_UNKNOWN)
2028 return error;
2029 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002030 error = FCERR_DICT;
2031 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002032 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002033 int did_save_redo = FALSE;
2034 save_redo_T save_redo;
2035
2036 /*
2037 * Call the user function.
2038 * Save and restore search patterns, script variables and
2039 * redo buffer.
2040 */
2041 save_search_patterns();
2042 if (!ins_compl_active())
2043 {
2044 saveRedobuff(&save_redo);
2045 did_save_redo = TRUE;
2046 }
2047 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002048 call_user_func(fp, argcount, argvars, rettv, funcexe,
2049 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002050 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2051 // Function was unreferenced while being used, free it now.
2052 func_clear_free(fp, FALSE);
2053 if (did_save_redo)
2054 restoreRedobuff(&save_redo);
2055 restore_search_patterns();
2056 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002057 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002058 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002059}
2060
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002061static funccal_entry_T *funccal_stack = NULL;
2062
2063/*
2064 * Save the current function call pointer, and set it to NULL.
2065 * Used when executing autocommands and for ":source".
2066 */
2067 void
2068save_funccal(funccal_entry_T *entry)
2069{
2070 entry->top_funccal = current_funccal;
2071 entry->next = funccal_stack;
2072 funccal_stack = entry;
2073 current_funccal = NULL;
2074}
2075
2076 void
2077restore_funccal(void)
2078{
2079 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002080 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002081 else
2082 {
2083 current_funccal = funccal_stack->top_funccal;
2084 funccal_stack = funccal_stack->next;
2085 }
2086}
2087
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002088 funccall_T *
2089get_current_funccal(void)
2090{
2091 return current_funccal;
2092}
2093
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002094/*
2095 * Mark all functions of script "sid" as deleted.
2096 */
2097 void
2098delete_script_functions(int sid)
2099{
2100 hashitem_T *hi;
2101 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002102 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002103 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002104 size_t len;
2105
2106 buf[0] = K_SPECIAL;
2107 buf[1] = KS_EXTRA;
2108 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002109 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002110 len = STRLEN(buf);
2111
Bram Moolenaarce658352020-07-31 23:47:12 +02002112 while (todo > 0)
2113 {
2114 todo = func_hashtab.ht_used;
2115 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2116 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002117 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002118 fp = HI2UF(hi);
2119 if (STRNCMP(fp->uf_name, buf, len) == 0)
2120 {
2121 int changed = func_hashtab.ht_changed;
2122
2123 fp->uf_flags |= FC_DEAD;
2124 func_clear(fp, TRUE);
2125 // When clearing a function another function can be cleared
2126 // as a side effect. When that happens start over.
2127 if (changed != func_hashtab.ht_changed)
2128 break;
2129 }
2130 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002131 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002132 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002133}
2134
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002135#if defined(EXITFREE) || defined(PROTO)
2136 void
2137free_all_functions(void)
2138{
2139 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002140 ufunc_T *fp;
2141 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002142 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002143 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002144
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002146 while (current_funccal != NULL)
2147 {
2148 clear_tv(current_funccal->rettv);
2149 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002150 if (current_funccal == NULL && funccal_stack != NULL)
2151 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002152 }
2153
Bram Moolenaare38eab22019-12-05 21:50:01 +01002154 // First clear what the functions contain. Since this may lower the
2155 // reference count of a function, it may also free a function and change
2156 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002157 while (todo > 0)
2158 {
2159 todo = func_hashtab.ht_used;
2160 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2161 if (!HASHITEM_EMPTY(hi))
2162 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002163 // clear the def function index now
2164 fp = HI2UF(hi);
2165 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002166 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002167
Bram Moolenaare38eab22019-12-05 21:50:01 +01002168 // Only free functions that are not refcounted, those are
2169 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002170 if (func_name_refcount(fp->uf_name))
2171 ++skipped;
2172 else
2173 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002174 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002175 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002176 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002177 {
2178 skipped = 0;
2179 break;
2180 }
2181 }
2182 --todo;
2183 }
2184 }
2185
Bram Moolenaare38eab22019-12-05 21:50:01 +01002186 // Now actually free the functions. Need to start all over every time,
2187 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002188 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002189 while (func_hashtab.ht_used > skipped)
2190 {
2191 todo = func_hashtab.ht_used;
2192 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002193 if (!HASHITEM_EMPTY(hi))
2194 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002195 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002196 // Only free functions that are not refcounted, those are
2197 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002198 fp = HI2UF(hi);
2199 if (func_name_refcount(fp->uf_name))
2200 ++skipped;
2201 else
2202 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002203 if (func_free(fp, FALSE) == OK)
2204 {
2205 skipped = 0;
2206 break;
2207 }
2208 // did not actually free it
2209 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002210 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002212 }
2213 if (skipped == 0)
2214 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002215
2216 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217}
2218#endif
2219
2220/*
2221 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002222 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002223 * "len" is the length of "name", or -1 for NUL terminated.
2224 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002225 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226builtin_function(char_u *name, int len)
2227{
2228 char_u *p;
2229
Bram Moolenaara26b9702020-04-18 19:53:28 +02002230 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 return FALSE;
2232 p = vim_strchr(name, AUTOLOAD_CHAR);
2233 return p == NULL || (len > 0 && p > name + len);
2234}
2235
2236 int
2237func_call(
2238 char_u *name,
2239 typval_T *args,
2240 partial_T *partial,
2241 dict_T *selfdict,
2242 typval_T *rettv)
2243{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002244 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002245 listitem_T *item;
2246 typval_T argv[MAX_FUNC_ARGS + 1];
2247 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002248 int r = 0;
2249
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002250 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002251 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002252 {
2253 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2254 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002255 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002256 break;
2257 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002258 // Make a copy of each argument. This is needed to be able to set
2259 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002260 copy_tv(&item->li_tv, &argv[argc++]);
2261 }
2262
2263 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002264 {
2265 funcexe_T funcexe;
2266
Bram Moolenaara80faa82020-04-12 19:37:17 +02002267 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002268 funcexe.firstline = curwin->w_cursor.lnum;
2269 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002270 funcexe.evaluate = TRUE;
2271 funcexe.partial = partial;
2272 funcexe.selfdict = selfdict;
2273 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2274 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002275
Bram Moolenaare38eab22019-12-05 21:50:01 +01002276 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 while (argc > 0)
2278 clear_tv(&argv[--argc]);
2279
2280 return r;
2281}
2282
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002283static int callback_depth = 0;
2284
2285 int
2286get_callback_depth(void)
2287{
2288 return callback_depth;
2289}
2290
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002291/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002292 * Invoke call_func() with a callback.
2293 */
2294 int
2295call_callback(
2296 callback_T *callback,
2297 int len, // length of "name" or -1 to use strlen()
2298 typval_T *rettv, // return value goes here
2299 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002300 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002301 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002302{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002303 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002304 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002305
Bram Moolenaara80faa82020-04-12 19:37:17 +02002306 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002307 funcexe.evaluate = TRUE;
2308 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002309 ++callback_depth;
2310 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2311 --callback_depth;
2312 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002313}
2314
2315/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002316 * Give an error message for the result of a function.
2317 * Nothing if "error" is FCERR_NONE.
2318 */
2319 void
2320user_func_error(int error, char_u *name)
2321{
2322 switch (error)
2323 {
2324 case FCERR_UNKNOWN:
2325 emsg_funcname(e_unknownfunc, name);
2326 break;
2327 case FCERR_NOTMETHOD:
2328 emsg_funcname(
2329 N_("E276: Cannot use function as a method: %s"), name);
2330 break;
2331 case FCERR_DELETED:
2332 emsg_funcname(N_(e_func_deleted), name);
2333 break;
2334 case FCERR_TOOMANY:
2335 emsg_funcname((char *)e_toomanyarg, name);
2336 break;
2337 case FCERR_TOOFEW:
2338 emsg_funcname((char *)e_toofewarg, name);
2339 break;
2340 case FCERR_SCRIPT:
2341 emsg_funcname(
2342 N_("E120: Using <SID> not in a script context: %s"), name);
2343 break;
2344 case FCERR_DICT:
2345 emsg_funcname(
2346 N_("E725: Calling dict function without Dictionary: %s"),
2347 name);
2348 break;
2349 }
2350}
2351
2352/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002354 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 * Return FAIL when the function can't be called, OK otherwise.
2356 * Also returns OK when an error was encountered while executing the function.
2357 */
2358 int
2359call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002360 char_u *funcname, // name of the function
2361 int len, // length of "name" or -1 to use strlen()
2362 typval_T *rettv, // return value goes here
2363 int argcount_in, // number of "argvars"
2364 typval_T *argvars_in, // vars for arguments, must have "argcount"
2365 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002366 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367{
2368 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002369 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002370 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002371 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 char_u fname_buf[FLEN_FIXED + 1];
2373 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002374 char_u *fname = NULL;
2375 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 int argcount = argcount_in;
2377 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002378 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002379 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2380 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002382 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002383 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002385 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2386 // even when call_func() returns FAIL.
2387 rettv->v_type = VAR_UNKNOWN;
2388
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002389 if (partial != NULL)
2390 fp = partial->pt_func;
2391 if (fp == NULL)
2392 {
2393 // Make a copy of the name, if it comes from a funcref variable it
2394 // could be changed or deleted in the called function.
2395 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2396 if (name == NULL)
2397 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002399 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2400 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002402 if (funcexe->doesrange != NULL)
2403 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404
2405 if (partial != NULL)
2406 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002407 // When the function has a partial with a dict and there is a dict
2408 // argument, use the dict argument. That is backwards compatible.
2409 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002410 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002412 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002413 {
2414 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002415 {
2416 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2417 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002418 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002419 goto theend;
2420 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002422 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423 for (i = 0; i < argcount_in; ++i)
2424 argv[i + argv_clear] = argvars_in[i];
2425 argvars = argv;
2426 argcount = partial->pt_argc + argcount_in;
2427 }
2428 }
2429
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002430 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2431 {
2432 // Check that the argument types are OK for the types of the funcref.
2433 if (check_argument_types(funcexe->check_type, argvars, argcount,
2434 name) == FAIL)
2435 error = FCERR_OTHER;
2436 }
2437
Bram Moolenaaref140542019-12-31 21:27:13 +01002438 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439 {
2440 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002441 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442
Bram Moolenaar333894b2020-08-01 18:53:07 +02002443 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002444 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002445 {
2446 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002448 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449
Bram Moolenaare38eab22019-12-05 21:50:01 +01002450 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002452 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002454 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455 {
2456 /*
2457 * User defined function.
2458 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002459 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002460 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461
Bram Moolenaare38eab22019-12-05 21:50:01 +01002462 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 if (fp == NULL
2464 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002465 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 && !aborting())
2467 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002468 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002469 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002471 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2473 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002474 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002475 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002477 if (fp == NULL)
2478 {
2479 char_u *p = untrans_function_name(rfname);
2480
2481 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002482 // Don't do this if the name starts with "s:".
2483 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002484 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002485 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002487 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002488 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002489#ifdef FEAT_LUA
2490 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2491 {
2492 cfunc_T cb = fp->uf_cb;
2493
2494 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2495 }
2496#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002497 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002499 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002500 // postponed filling in the arguments, do it now
2501 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002502 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002503
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002504 if (funcexe->basetv != NULL)
2505 {
2506 // Method call: base->Method()
2507 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2508 argv[0] = *funcexe->basetv;
2509 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002510 argvars = argv;
2511 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002512 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002513
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002514 error = call_user_func_check(fp, argcount, argvars, rettv,
2515 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 }
2517 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002518 else if (funcexe->basetv != NULL)
2519 {
2520 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002521 * expr->method(): Find the method name in the table, call its
2522 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002523 */
2524 error = call_internal_method(fname, argcount, argvars, rettv,
2525 funcexe->basetv);
2526 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527 else
2528 {
2529 /*
2530 * Find the function name in the table, call its implementation.
2531 */
2532 error = call_internal_func(fname, argcount, argvars, rettv);
2533 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002534
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 /*
2536 * The function call (or "FuncUndefined" autocommand sequence) might
2537 * have been aborted by an error, an interrupt, or an explicitly thrown
2538 * exception that has not been caught so far. This situation can be
2539 * tested for by calling aborting(). For an error in an internal
2540 * function or for the "E132" error in call_user_func(), however, the
2541 * throw point at which the "force_abort" flag (temporarily reset by
2542 * emsg()) is normally updated has not been reached yet. We need to
2543 * update that flag first to make aborting() reliable.
2544 */
2545 update_force_abort();
2546 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002547 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548 ret = OK;
2549
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002550theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551 /*
2552 * Report an error unless the argument evaluation or function call has been
2553 * cancelled due to an aborting error, an interrupt, or an exception.
2554 */
2555 if (!aborting())
2556 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002557 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 }
2559
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002560 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002562 clear_tv(&argv[--argv_clear + argv_base]);
2563
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 vim_free(tofree);
2565 vim_free(name);
2566
2567 return ret;
2568}
2569
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002570 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002571printable_func_name(ufunc_T *fp)
2572{
2573 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2574}
2575
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002577 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 */
2579 static void
2580list_func_head(ufunc_T *fp, int indent)
2581{
2582 int j;
2583
2584 msg_start();
2585 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002586 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002587 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002588 msg_puts("def ");
2589 else
2590 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002591 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592 msg_putchar('(');
2593 for (j = 0; j < fp->uf_args.ga_len; ++j)
2594 {
2595 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002596 msg_puts(", ");
2597 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002598 if (fp->uf_arg_types != NULL)
2599 {
2600 char *tofree;
2601
2602 msg_puts(": ");
2603 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2604 vim_free(tofree);
2605 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002606 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2607 {
2608 msg_puts(" = ");
2609 msg_puts(((char **)(fp->uf_def_args.ga_data))
2610 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2611 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002612 }
2613 if (fp->uf_varargs)
2614 {
2615 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002616 msg_puts(", ");
2617 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002619 if (fp->uf_va_name != NULL)
2620 {
2621 if (j)
2622 msg_puts(", ");
2623 msg_puts("...");
2624 msg_puts((char *)fp->uf_va_name);
2625 if (fp->uf_va_type)
2626 {
2627 char *tofree;
2628
2629 msg_puts(": ");
2630 msg_puts(type_name(fp->uf_va_type, &tofree));
2631 vim_free(tofree);
2632 }
2633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002635
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002636 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002637 {
2638 if (fp->uf_ret_type != &t_void)
2639 {
2640 char *tofree;
2641
2642 msg_puts(": ");
2643 msg_puts(type_name(fp->uf_ret_type, &tofree));
2644 vim_free(tofree);
2645 }
2646 }
2647 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002648 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002650 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002652 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002653 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002654 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 msg_clr_eos();
2656 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002657 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658}
2659
2660/*
2661 * Get a function name, translating "<SID>" and "<SNR>".
2662 * Also handles a Funcref in a List or Dictionary.
2663 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002664 * Set "*is_global" to TRUE when the function must be global, unless
2665 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 * flags:
2667 * TFN_INT: internal function name OK
2668 * TFN_QUIET: be quiet
2669 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002670 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002671 * Advances "pp" to just after the function name (if no error).
2672 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002673 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674trans_function_name(
2675 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002676 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002677 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002679 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002680 partial_T **partial, // return: partial of a FuncRef
2681 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682{
2683 char_u *name = NULL;
2684 char_u *start;
2685 char_u *end;
2686 int lead;
2687 char_u sid_buf[20];
2688 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002689 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002691 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002692 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693
2694 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002695 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 start = *pp;
2697
Bram Moolenaare38eab22019-12-05 21:50:01 +01002698 // Check for hard coded <SNR>: already translated function ID (from a user
2699 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2701 && (*pp)[2] == (int)KE_SNR)
2702 {
2703 *pp += 3;
2704 len = get_id_len(pp) + 3;
2705 return vim_strnsave(start, len);
2706 }
2707
Bram Moolenaare38eab22019-12-05 21:50:01 +01002708 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2709 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 lead = eval_fname_script(start);
2711 if (lead > 2)
2712 start += lead;
2713
Bram Moolenaare38eab22019-12-05 21:50:01 +01002714 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002715 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 lead > 2 ? 0 : FNE_CHECK_START);
2717 if (end == start)
2718 {
2719 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002720 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 goto theend;
2722 }
2723 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2724 {
2725 /*
2726 * Report an invalid expression in braces, unless the expression
2727 * evaluation has been cancelled due to an aborting error, an
2728 * interrupt, or an exception.
2729 */
2730 if (!aborting())
2731 {
2732 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002733 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734 }
2735 else
2736 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2737 goto theend;
2738 }
2739
2740 if (lv.ll_tv != NULL)
2741 {
2742 if (fdp != NULL)
2743 {
2744 fdp->fd_dict = lv.ll_dict;
2745 fdp->fd_newkey = lv.ll_newkey;
2746 lv.ll_newkey = NULL;
2747 fdp->fd_di = lv.ll_di;
2748 }
2749 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2750 {
2751 name = vim_strsave(lv.ll_tv->vval.v_string);
2752 *pp = end;
2753 }
2754 else if (lv.ll_tv->v_type == VAR_PARTIAL
2755 && lv.ll_tv->vval.v_partial != NULL)
2756 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002757 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 *pp = end;
2759 if (partial != NULL)
2760 *partial = lv.ll_tv->vval.v_partial;
2761 }
2762 else
2763 {
2764 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2765 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002766 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 else
2768 *pp = end;
2769 name = NULL;
2770 }
2771 goto theend;
2772 }
2773
2774 if (lv.ll_name == NULL)
2775 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002776 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 *pp = end;
2778 goto theend;
2779 }
2780
Bram Moolenaare38eab22019-12-05 21:50:01 +01002781 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 if (lv.ll_exp_name != NULL)
2783 {
2784 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002785 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 flags & TFN_NO_AUTOLOAD);
2787 if (name == lv.ll_exp_name)
2788 name = NULL;
2789 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002790 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791 {
2792 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002793 name = deref_func_name(*pp, &len, partial, type,
2794 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 if (name == *pp)
2796 name = NULL;
2797 }
2798 if (name != NULL)
2799 {
2800 name = vim_strsave(name);
2801 *pp = end;
2802 if (STRNCMP(name, "<SNR>", 5) == 0)
2803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002804 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 name[0] = K_SPECIAL;
2806 name[1] = KS_EXTRA;
2807 name[2] = (int)KE_SNR;
2808 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2809 }
2810 goto theend;
2811 }
2812
2813 if (lv.ll_exp_name != NULL)
2814 {
2815 len = (int)STRLEN(lv.ll_exp_name);
2816 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2817 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2818 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002819 // When there was "s:" already or the name expanded to get a
2820 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 lv.ll_name += 2;
2822 len -= 2;
2823 lead = 2;
2824 }
2825 }
2826 else
2827 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002828 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002830 {
2831 if (is_global != NULL && lv.ll_name[0] == 'g')
2832 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002834 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 len = (int)(end - lv.ll_name);
2836 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002837 if (len <= 0)
2838 {
2839 if (!skip)
2840 emsg(_(e_function_name));
2841 goto theend;
2842 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002844 // In Vim9 script a user function is script-local by default, unless it
2845 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002846 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002847 if (vim9script)
2848 {
2849 char_u *p;
2850
2851 // SomeScript#func() is a global function.
2852 for (p = start; *p != NUL && *p != '('; ++p)
2853 if (*p == AUTOLOAD_CHAR)
2854 vim9script = FALSE;
2855 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002856
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 /*
2858 * Copy the function name to allocated memory.
2859 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2860 * Accept <SNR>123_name() outside a script.
2861 */
2862 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002863 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002864 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002866 if (!vim9script)
2867 lead = 3;
2868 if (vim9script || (lv.ll_exp_name != NULL
2869 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870 || eval_fname_sid(*pp))
2871 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002872 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002873 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002875 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 goto theend;
2877 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002878 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002879 if (vim9script)
2880 extra = 3 + (int)STRLEN(sid_buf);
2881 else
2882 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 }
2884 }
2885 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2886 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002887 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 start);
2889 goto theend;
2890 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002891 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892 {
2893 char_u *cp = vim_strchr(lv.ll_name, ':');
2894
2895 if (cp != NULL && cp < end)
2896 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002897 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 goto theend;
2899 }
2900 }
2901
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 if (name != NULL)
2904 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002905 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 {
2907 name[0] = K_SPECIAL;
2908 name[1] = KS_EXTRA;
2909 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002910 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 STRCPY(name + 3, sid_buf);
2912 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002913 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2914 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 }
2916 *pp = end;
2917
2918theend:
2919 clear_lval(&lv);
2920 return name;
2921}
2922
2923/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002924 * Assuming "name" is the result of trans_function_name() and it was prefixed
2925 * to use the script-local name, return the unmodified name (points into
2926 * "name"). Otherwise return NULL.
2927 * This can be used to first search for a script-local function and fall back
2928 * to the global function if not found.
2929 */
2930 char_u *
2931untrans_function_name(char_u *name)
2932{
2933 char_u *p;
2934
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002935 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002936 {
2937 p = vim_strchr(name, '_');
2938 if (p != NULL)
2939 return p + 1;
2940 }
2941 return NULL;
2942}
2943
2944/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002945 * List functions. When "regmatch" is NULL all of then.
2946 * Otherwise functions matching "regmatch".
2947 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002948 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002949list_functions(regmatch_T *regmatch)
2950{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002951 int changed = func_hashtab.ht_changed;
2952 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002953 hashitem_T *hi;
2954
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002955 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002956 {
2957 if (!HASHITEM_EMPTY(hi))
2958 {
2959 ufunc_T *fp = HI2UF(hi);
2960
2961 --todo;
2962 if ((fp->uf_flags & FC_DEAD) == 0
2963 && (regmatch == NULL
2964 ? !message_filtered(fp->uf_name)
2965 && !func_name_refcount(fp->uf_name)
2966 : !isdigit(*fp->uf_name)
2967 && vim_regexec(regmatch, fp->uf_name, 0)))
2968 {
2969 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002970 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002971 {
2972 emsg(_("E454: function list was modified"));
2973 return;
2974 }
2975 }
2976 }
2977 }
2978}
2979
2980/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002981 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2982 * return TRUE.
2983 * Otherwise return FALSE;
2984 * Do not consider "function(" to be a command.
2985 */
2986 static int
2987is_function_cmd(char_u **cmd)
2988{
2989 char_u *p = *cmd;
2990
2991 if (checkforcmd(&p, "function", 2))
2992 {
2993 if (*p == '(')
2994 return FALSE;
2995 *cmd = p;
2996 return TRUE;
2997 }
2998 return FALSE;
2999}
3000
3001/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003002 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003003 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3004 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003005 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003007 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003008define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009{
3010 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003011 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 int j;
3013 int c;
3014 int saved_did_emsg;
3015 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003016 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003017 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018 char_u *p;
3019 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003020 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021 char_u *line_arg = NULL;
3022 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003024 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025 garray_T newlines;
3026 int varargs = FALSE;
3027 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003028 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003029 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003030 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031 int indent;
3032 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033#define MAX_FUNC_NESTING 50
3034 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 dictitem_T *v;
3036 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003037 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003040 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003041 linenr_T sourcing_lnum_off;
3042 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003043 int is_heredoc = FALSE;
3044 char_u *skip_until = NULL;
3045 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003046 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003047 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048
3049 /*
3050 * ":function" without argument: list functions.
3051 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003052 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 {
3054 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003055 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003057 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003058 }
3059
3060 /*
3061 * ":function /pat": list functions matching pattern.
3062 */
3063 if (*eap->arg == '/')
3064 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003065 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 if (!eap->skip)
3067 {
3068 regmatch_T regmatch;
3069
3070 c = *p;
3071 *p = NUL;
3072 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3073 *p = c;
3074 if (regmatch.regprog != NULL)
3075 {
3076 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003077 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003078 vim_regfree(regmatch.regprog);
3079 }
3080 }
3081 if (*p == '/')
3082 ++p;
3083 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003084 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085 }
3086
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003087 ga_init(&newargs);
3088 ga_init(&argtypes);
3089 ga_init(&default_args);
3090
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 /*
3092 * Get the function name. There are these situations:
3093 * func normal function name
3094 * "name" == func, "fudi.fd_dict" == NULL
3095 * dict.func new dictionary entry
3096 * "name" == NULL, "fudi.fd_dict" set,
3097 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3098 * dict.func existing dict entry with a Funcref
3099 * "name" == func, "fudi.fd_dict" set,
3100 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3101 * dict.func existing dict entry that's not a Funcref
3102 * "name" == NULL, "fudi.fd_dict" set,
3103 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3104 * s:func script-local function name
3105 * g:func global function name, same as "func"
3106 */
3107 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003108 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003110 // nested function, argument is (args).
3111 paren = TRUE;
3112 CLEAR_FIELD(fudi);
3113 }
3114 else
3115 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003116 if (STRNCMP(p, "<lambda>", 8) == 0)
3117 {
3118 p += 8;
3119 (void)getdigits(&p);
3120 name = vim_strnsave(eap->arg, p - eap->arg);
3121 CLEAR_FIELD(fudi);
3122 }
3123 else
3124 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003125 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003126 paren = (vim_strchr(p, '(') != NULL);
3127 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003129 /*
3130 * Return on an invalid expression in braces, unless the expression
3131 * evaluation has been cancelled due to an aborting error, an
3132 * interrupt, or an exception.
3133 */
3134 if (!aborting())
3135 {
3136 if (!eap->skip && fudi.fd_newkey != NULL)
3137 semsg(_(e_dictkey), fudi.fd_newkey);
3138 vim_free(fudi.fd_newkey);
3139 return NULL;
3140 }
3141 else
3142 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 }
3145
Bram Moolenaare38eab22019-12-05 21:50:01 +01003146 // An error in a function call during evaluation of an expression in magic
3147 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 saved_did_emsg = did_emsg;
3149 did_emsg = FALSE;
3150
3151 /*
3152 * ":function func" with only function name: list function.
3153 */
3154 if (!paren)
3155 {
3156 if (!ends_excmd(*skipwhite(p)))
3157 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003158 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159 goto ret_free;
3160 }
3161 eap->nextcmd = check_nextcmd(p);
3162 if (eap->nextcmd != NULL)
3163 *p = NUL;
3164 if (!eap->skip && !got_int)
3165 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003166 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003167 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3168 {
3169 char_u *up = untrans_function_name(name);
3170
3171 // With Vim9 script the name was made script-local, if not
3172 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003173 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003174 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003175 }
3176
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 if (fp != NULL)
3178 {
3179 list_func_head(fp, TRUE);
3180 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3181 {
3182 if (FUNCLINE(fp, j) == NULL)
3183 continue;
3184 msg_putchar('\n');
3185 msg_outnum((long)(j + 1));
3186 if (j < 9)
3187 msg_putchar(' ');
3188 if (j < 99)
3189 msg_putchar(' ');
3190 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003191 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192 ui_breakcheck();
3193 }
3194 if (!got_int)
3195 {
3196 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003197 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003198 msg_puts(" enddef");
3199 else
3200 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 }
3202 }
3203 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003204 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003205 }
3206 goto ret_free;
3207 }
3208
3209 /*
3210 * ":function name(arg1, arg2)" Define function.
3211 */
3212 p = skipwhite(p);
3213 if (*p != '(')
3214 {
3215 if (!eap->skip)
3216 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003217 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218 goto ret_free;
3219 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003220 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003221 if (vim_strchr(p, '(') != NULL)
3222 p = vim_strchr(p, '(');
3223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003224
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003225 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3226 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003227 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003228 goto ret_free;
3229 }
3230
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003231 // In Vim9 script only global functions can be redefined.
3232 if (vim9script && eap->forceit && !is_global)
3233 {
3234 emsg(_(e_nobang));
3235 goto ret_free;
3236 }
3237
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003238 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3239
Bram Moolenaar04b12692020-05-04 23:24:44 +02003240 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003242 // Check the name of the function. Unless it's a dictionary function
3243 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244 if (name != NULL)
3245 arg = name;
3246 else
3247 arg = fudi.fd_newkey;
3248 if (arg != NULL && (fudi.fd_di == NULL
3249 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3250 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3251 {
3252 if (*arg == K_SPECIAL)
3253 j = 3;
3254 else
3255 j = 0;
3256 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3257 : eval_isnamec(arg[j])))
3258 ++j;
3259 if (arg[j] != NUL)
3260 emsg_funcname((char *)e_invarg2, arg);
3261 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003262 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003264 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 }
3266
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003267 // This may get more lines and make the pointers into the first line
3268 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003269 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003271 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003272 &varargs, &default_args, eap->skip,
3273 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003275 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003277 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 // find the return type: :def Func(): type
3280 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003282 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003283 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003285 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003286 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003287 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003289 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003290 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003291 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003292 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003293 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003294 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003295 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003296 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003298 else
3299 // find extra arguments "range", "dict", "abort" and "closure"
3300 for (;;)
3301 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003302 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003303 p = skipwhite(p);
3304 if (STRNCMP(p, "range", 5) == 0)
3305 {
3306 flags |= FC_RANGE;
3307 p += 5;
3308 }
3309 else if (STRNCMP(p, "dict", 4) == 0)
3310 {
3311 flags |= FC_DICT;
3312 p += 4;
3313 }
3314 else if (STRNCMP(p, "abort", 5) == 0)
3315 {
3316 flags |= FC_ABORT;
3317 p += 5;
3318 }
3319 else if (STRNCMP(p, "closure", 7) == 0)
3320 {
3321 flags |= FC_CLOSURE;
3322 p += 7;
3323 if (current_funccal == NULL)
3324 {
3325 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3326 name == NULL ? (char_u *)"" : name);
3327 goto erret;
3328 }
3329 }
3330 else
3331 break;
3332 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333
Bram Moolenaare38eab22019-12-05 21:50:01 +01003334 // When there is a line break use what follows for the function body.
3335 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 if (*p == '\n')
3337 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003338 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003339 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3340 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003341 && !(VIM_ISWHITE(*whitep) && *p == '#'
3342 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003343 && !eap->skip
3344 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003345 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346
3347 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003348 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3349 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 */
3351 if (KeyTyped)
3352 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 // Check if the function already exists, don't let the user type the
3354 // whole function before telling him it doesn't work! For a script we
3355 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356 if (!eap->skip && !eap->forceit)
3357 {
3358 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003359 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003360 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003361 emsg_funcname(e_funcexts, name);
3362 }
3363
3364 if (!eap->skip && did_emsg)
3365 goto erret;
3366
Bram Moolenaare38eab22019-12-05 21:50:01 +01003367 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 cmdline_row = msg_row;
3369 }
3370
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003371 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003372 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003373
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003374 // Detect having skipped over comment lines to find the return
3375 // type. Add NULL lines to keep the line count correct.
3376 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3377 if (SOURCING_LNUM < sourcing_lnum_off)
3378 {
3379 sourcing_lnum_off -= SOURCING_LNUM;
3380 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3381 goto erret;
3382 while (sourcing_lnum_off-- > 0)
3383 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3384 }
3385
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 indent = 2;
3387 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003388 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003389 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003390 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 for (;;)
3392 {
3393 if (KeyTyped)
3394 {
3395 msg_scroll = TRUE;
3396 saved_wait_return = FALSE;
3397 }
3398 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399
3400 if (line_arg != NULL)
3401 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003402 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 theline = line_arg;
3404 p = vim_strchr(theline, '\n');
3405 if (p == NULL)
3406 line_arg += STRLEN(line_arg);
3407 else
3408 {
3409 *p = NUL;
3410 line_arg = p + 1;
3411 }
3412 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003414 {
3415 vim_free(line_to_free);
3416 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003417 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003418 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003419 theline = eap->getline(':', eap->cookie, indent,
3420 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003421 line_to_free = theline;
3422 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 if (KeyTyped)
3424 lines_left = Rows - 1;
3425 if (theline == NULL)
3426 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003427 // Use the start of the function for the line number.
3428 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003429 if (skip_until != NULL)
3430 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3431 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003432 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003433 else
3434 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 goto erret;
3436 }
3437
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003438 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003439 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003440 if (SOURCING_LNUM < sourcing_lnum_off)
3441 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 else
3443 sourcing_lnum_off = 0;
3444
3445 if (skip_until != NULL)
3446 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003447 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003448 // * ":append" and "."
3449 // * ":python <<EOF" and "EOF"
3450 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3451 if (heredoc_trimmed == NULL
3452 || (is_heredoc && skipwhite(theline) == theline)
3453 || STRNCMP(theline, heredoc_trimmed,
3454 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003455 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003456 if (heredoc_trimmed == NULL)
3457 p = theline;
3458 else if (is_heredoc)
3459 p = skipwhite(theline) == theline
3460 ? theline : theline + STRLEN(heredoc_trimmed);
3461 else
3462 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003463 if (STRCMP(p, skip_until) == 0)
3464 {
3465 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003466 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003467 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003468 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003469 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003470 }
3471 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 }
3473 else
3474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003475 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003476 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477 ;
3478
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003479 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003480 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003481 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003482 ? "enddef" : "endfunction", 4)
3483 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003485 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003486 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003487 char_u *nextcmd = NULL;
3488
3489 if (*p == '|')
3490 nextcmd = p + 1;
3491 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3492 nextcmd = line_arg;
3493 else if (*p != NUL && *p != '"' && p_verbose > 0)
3494 give_warning2(eap->cmdidx == CMD_def
3495 ? (char_u *)_("W1001: Text found after :enddef: %s")
3496 : (char_u *)_("W22: Text found after :endfunction: %s"),
3497 p, TRUE);
3498 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003499 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003500 // Another command follows. If the line came from "eap"
3501 // we can simply point into it, otherwise we need to
3502 // change "eap->cmdlinep".
3503 eap->nextcmd = nextcmd;
3504 if (line_to_free != NULL)
3505 {
3506 vim_free(*eap->cmdlinep);
3507 *eap->cmdlinep = line_to_free;
3508 line_to_free = NULL;
3509 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003510 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003511 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003512 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 }
3514
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003515 // Check for mismatched "endfunc" or "enddef".
3516 // We don't check for "def" inside "func" thus we also can't check
3517 // for "enddef".
3518 // We continue to find the end of the function, although we might
3519 // not find it.
3520 else if (nesting_def[nesting])
3521 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003522 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003523 emsg(_(e_mismatched_endfunction));
3524 }
3525 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3526 emsg(_(e_mismatched_enddef));
3527
Bram Moolenaare38eab22019-12-05 21:50:01 +01003528 // Increase indent inside "if", "while", "for" and "try", decrease
3529 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003530 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531 indent -= 2;
3532 else if (STRNCMP(p, "if", 2) == 0
3533 || STRNCMP(p, "wh", 2) == 0
3534 || STRNCMP(p, "for", 3) == 0
3535 || STRNCMP(p, "try", 3) == 0)
3536 indent += 2;
3537
Bram Moolenaare38eab22019-12-05 21:50:01 +01003538 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003539 // Only recognize "def" inside "def", not inside "function",
3540 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003541 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003542 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003543 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544 {
3545 if (*p == '!')
3546 p = skipwhite(p + 1);
3547 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003548 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3549 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 if (*skipwhite(p) == '(')
3551 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003552 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003553 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003554 else
3555 {
3556 ++nesting;
3557 nesting_def[nesting] = (c == 'd');
3558 indent += 2;
3559 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 }
3561 }
3562
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003563 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003564 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003565 if (eap->cmdidx != CMD_def
3566 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003567 || (p[0] == 'c'
3568 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3569 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3570 && (STRNCMP(&p[3], "nge", 3) != 0
3571 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 || (p[0] == 'i'
3573 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003574 && (!ASCII_ISALPHA(p[2])
3575 || (p[2] == 's'
3576 && (!ASCII_ISALPHA(p[3])
3577 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 skip_until = vim_strsave((char_u *)".");
3579
Bram Moolenaare38eab22019-12-05 21:50:01 +01003580 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 arg = skipwhite(skiptowhite(p));
3582 if (arg[0] == '<' && arg[1] =='<'
3583 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003584 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3585 || ((p[2] == '3' || p[2] == 'x')
3586 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 || (p[0] == 'p' && p[1] == 'e'
3588 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3589 || (p[0] == 't' && p[1] == 'c'
3590 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3591 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3592 && !ASCII_ISALPHA(p[3]))
3593 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3594 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3595 || (p[0] == 'm' && p[1] == 'z'
3596 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3597 ))
3598 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003599 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003601 if (STRNCMP(p, "trim", 4) == 0)
3602 {
3603 // Ignore leading white space.
3604 p = skipwhite(p + 4);
3605 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003606 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003607 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 if (*p == NUL)
3609 skip_until = vim_strsave((char_u *)".");
3610 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003611 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003612 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003613 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003615
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003616 // Check for ":cmd v =<< [trim] EOF"
3617 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003618 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003619 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003620 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003621 if (*arg == '[')
3622 arg = vim_strchr(arg, ']');
3623 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003624 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003625 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3626 && arg[1] == '<' && arg[2] =='<');
3627
3628 if (!found)
3629 // skip over the argument after "cmd"
3630 arg = skipwhite(skiptowhite(arg));
3631 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003632 && (checkforcmd(&p, "let", 2)
3633 || checkforcmd(&p, "var", 3)
3634 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003635 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003636 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003637 p = skipwhite(arg + 3);
3638 if (STRNCMP(p, "trim", 4) == 0)
3639 {
3640 // Ignore leading white space.
3641 p = skipwhite(p + 4);
3642 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003643 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003644 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003645 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003646 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003647 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003648 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003649 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 }
3651
Bram Moolenaare38eab22019-12-05 21:50:01 +01003652 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655
Bram Moolenaare38eab22019-12-05 21:50:01 +01003656 // Copy the line to newly allocated memory. get_one_sourceline()
3657 // allocates 250 bytes per line, this saves 80% on average. The cost
3658 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003660 if (p == NULL)
3661 goto erret;
3662 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663
Bram Moolenaare38eab22019-12-05 21:50:01 +01003664 // Add NULL lines for continuation lines, so that the line count is
3665 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666 while (sourcing_lnum_off-- > 0)
3667 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3668
Bram Moolenaare38eab22019-12-05 21:50:01 +01003669 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 if (line_arg != NULL && *line_arg == NUL)
3671 line_arg = NULL;
3672 }
3673
Bram Moolenaare38eab22019-12-05 21:50:01 +01003674 // Don't define the function when skipping commands or when an error was
3675 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 if (eap->skip || did_emsg)
3677 goto erret;
3678
3679 /*
3680 * If there are no errors, add the function
3681 */
3682 if (fudi.fd_dict == NULL)
3683 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003684 hashtab_T *ht;
3685
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003686 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3688 {
3689 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3690 name);
3691 goto erret;
3692 }
3693
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003694 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003695 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003697 char_u *uname = untrans_function_name(name);
3698
3699 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3700 }
3701
3702 if (fp != NULL || import != NULL)
3703 {
3704 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003705
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003706 // Function can be replaced with "function!" and when sourcing the
3707 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003708 // A name that is used by an import can not be overruled.
3709 if (import != NULL
3710 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003711 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003712 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003714 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003715 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003716 else
3717 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718 goto erret;
3719 }
3720 if (fp->uf_calls > 0)
3721 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003722 emsg_funcname(
3723 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 name);
3725 goto erret;
3726 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003727 if (fp->uf_refcount > 1)
3728 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003729 // This function is referenced somewhere, don't redefine it but
3730 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003731 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003732 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003733 fp = NULL;
3734 overwrite = TRUE;
3735 }
3736 else
3737 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003738 char_u *exp_name = fp->uf_name_exp;
3739
3740 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003741 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003742 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003743 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003744 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003745 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003746#ifdef FEAT_PROFILE
3747 fp->uf_profiling = FALSE;
3748 fp->uf_prof_initialized = FALSE;
3749#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003750 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003751 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 }
3753 }
3754 else
3755 {
3756 char numbuf[20];
3757
3758 fp = NULL;
3759 if (fudi.fd_newkey == NULL && !eap->forceit)
3760 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003761 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 goto erret;
3763 }
3764 if (fudi.fd_di == NULL)
3765 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003766 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003767 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768 goto erret;
3769 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003770 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003771 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 goto erret;
3773
Bram Moolenaare38eab22019-12-05 21:50:01 +01003774 // Give the function a sequential number. Can only be used with a
3775 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 vim_free(name);
3777 sprintf(numbuf, "%d", ++func_nr);
3778 name = vim_strsave((char_u *)numbuf);
3779 if (name == NULL)
3780 goto erret;
3781 }
3782
3783 if (fp == NULL)
3784 {
3785 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3786 {
3787 int slen, plen;
3788 char_u *scriptname;
3789
Bram Moolenaare38eab22019-12-05 21:50:01 +01003790 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003792 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 {
3794 scriptname = autoload_name(name);
3795 if (scriptname != NULL)
3796 {
3797 p = vim_strchr(scriptname, '/');
3798 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003799 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003801 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 j = OK;
3803 vim_free(scriptname);
3804 }
3805 }
3806 if (j == FAIL)
3807 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003808 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 goto erret;
3810 }
3811 }
3812
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003813 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 if (fp == NULL)
3815 goto erret;
3816
3817 if (fudi.fd_dict != NULL)
3818 {
3819 if (fudi.fd_di == NULL)
3820 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003821 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3823 if (fudi.fd_di == NULL)
3824 {
3825 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003826 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 goto erret;
3828 }
3829 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3830 {
3831 vim_free(fudi.fd_di);
3832 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003833 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834 goto erret;
3835 }
3836 }
3837 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003838 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003839 clear_tv(&fudi.fd_di->di_tv);
3840 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003841 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842
Bram Moolenaare38eab22019-12-05 21:50:01 +01003843 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 flags |= FC_DICT;
3845 }
3846
Bram Moolenaare38eab22019-12-05 21:50:01 +01003847 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003848 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003849 if (overwrite)
3850 {
3851 hi = hash_find(&func_hashtab, name);
3852 hi->hi_key = UF2HIKEY(fp);
3853 }
3854 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 {
3856 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003857 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 goto erret;
3859 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003860 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 }
3862 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003863 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003864 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003865 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003866
3867 if (eap->cmdidx == CMD_def)
3868 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003869 int lnum_save = SOURCING_LNUM;
3870 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003871
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003872 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003873
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003874 // error messages are for the first function line
3875 SOURCING_LNUM = sourcing_lnum_top;
3876
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003877 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003878 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003879 int count = cstack->cs_idx + 1;
3880 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003881
3882 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003883 // a block that is visible now but not when the function is called
3884 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003885 fp->uf_block_ids = ALLOC_MULT(int, count);
3886 if (fp->uf_block_ids != NULL)
3887 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003888 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003889 sizeof(int) * count);
3890 fp->uf_block_depth = count;
3891 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003892
3893 // Set flag in each block to indicate a function was defined. This
3894 // is used to keep the variable when leaving the block, see
3895 // hide_script_var().
3896 for (i = 0; i <= cstack->cs_idx; ++i)
3897 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003898 }
3899
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003900 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003901 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003902 SOURCING_LNUM = lnum_save;
3903 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003904 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003905 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003906
3907 // parse the return type, if any
3908 if (ret_type == NULL)
3909 fp->uf_ret_type = &t_void;
3910 else
3911 {
3912 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003913 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003914 if (fp->uf_ret_type == NULL)
3915 {
3916 fp->uf_ret_type = &t_void;
3917 SOURCING_LNUM = lnum_save;
3918 goto erret;
3919 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003920 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003921 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003922 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003923 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003924 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003925
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003927 if ((flags & FC_CLOSURE) != 0)
3928 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003929 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003930 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003931 }
3932 else
3933 fp->uf_scoped = NULL;
3934
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 if (prof_def_func())
3937 func_do_profile(fp);
3938#endif
3939 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003940 if (sandbox)
3941 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003942 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003943 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 fp->uf_flags = flags;
3945 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003946 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003947 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003948 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003949 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003950 if (is_export)
3951 {
3952 fp->uf_flags |= FC_EXPORT;
3953 // let ex_export() know the export worked.
3954 is_export = FALSE;
3955 }
3956
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003957 if (eap->cmdidx == CMD_def)
3958 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003959 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3960 // :func does not use Vim9 script syntax, even in a Vim9 script file
3961 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003962
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963 goto ret_free;
3964
3965erret:
3966 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003967 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01003968 if (fp != NULL)
3969 {
3970 ga_init(&fp->uf_args);
3971 ga_init(&fp->uf_def_args);
3972 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973errret_2:
3974 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01003975 if (fp != NULL)
3976 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003978 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003980 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003981 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003983 if (name != name_arg)
3984 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003985 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 did_emsg |= saved_did_emsg;
3987 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003988
3989 return fp;
3990}
3991
3992/*
3993 * ":function"
3994 */
3995 void
3996ex_function(exarg_T *eap)
3997{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003998 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003999}
4000
4001/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004002 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004003 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004004 */
4005 void
4006ex_defcompile(exarg_T *eap UNUSED)
4007{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004008 long todo = (long)func_hashtab.ht_used;
4009 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004010 hashitem_T *hi;
4011 ufunc_T *ufunc;
4012
4013 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4014 {
4015 if (!HASHITEM_EMPTY(hi))
4016 {
4017 --todo;
4018 ufunc = HI2UF(hi);
4019 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004020 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4021 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004022 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004023 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004024
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004025 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004026 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004027 // a function has been added or removed, need to start over
4028 todo = (long)func_hashtab.ht_used;
4029 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004030 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004031 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004032 }
4033 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004034 }
4035 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036}
4037
4038/*
4039 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4040 * Return 2 if "p" starts with "s:".
4041 * Return 0 otherwise.
4042 */
4043 int
4044eval_fname_script(char_u *p)
4045{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004046 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4047 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4049 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4050 return 5;
4051 if (p[0] == 's' && p[1] == ':')
4052 return 2;
4053 return 0;
4054}
4055
4056 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004057translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058{
4059 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004060 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004061 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004062}
4063
4064/*
4065 * Return TRUE when "ufunc" has old-style "..." varargs
4066 * or named varargs "...name: type".
4067 */
4068 int
4069has_varargs(ufunc_T *ufunc)
4070{
4071 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072}
4073
4074/*
4075 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004076 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 */
4078 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004079function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080{
4081 char_u *nm = name;
4082 char_u *p;
4083 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004084 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004085 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004087 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4088 if (no_deref)
4089 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004090 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091 nm = skipwhite(nm);
4092
Bram Moolenaare38eab22019-12-05 21:50:01 +01004093 // Only accept "funcname", "funcname ", "funcname (..." and
4094 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004096 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 vim_free(p);
4098 return n;
4099}
4100
Bram Moolenaar113e1072019-01-20 15:30:40 +01004101#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 char_u *
4103get_expanded_name(char_u *name, int check)
4104{
4105 char_u *nm = name;
4106 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004107 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004109 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004110 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004112 if (p != NULL && *nm == NUL
4113 && (!check || translated_function_exists(p, is_global)))
4114 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115
4116 vim_free(p);
4117 return NULL;
4118}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004119#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121/*
4122 * Function given to ExpandGeneric() to obtain the list of user defined
4123 * function names.
4124 */
4125 char_u *
4126get_user_func_name(expand_T *xp, int idx)
4127{
4128 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004129 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 static hashitem_T *hi;
4131 ufunc_T *fp;
4132
4133 if (idx == 0)
4134 {
4135 done = 0;
4136 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004137 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004139 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 {
4141 if (done++ > 0)
4142 ++hi;
4143 while (HASHITEM_EMPTY(hi))
4144 ++hi;
4145 fp = HI2UF(hi);
4146
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004147 // don't show dead, dict and lambda functions
4148 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004149 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004150 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151
4152 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004153 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154
4155 cat_func_name(IObuff, fp);
4156 if (xp->xp_context != EXPAND_USER_FUNC)
4157 {
4158 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004159 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160 STRCAT(IObuff, ")");
4161 }
4162 return IObuff;
4163 }
4164 return NULL;
4165}
4166
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167/*
4168 * ":delfunction {name}"
4169 */
4170 void
4171ex_delfunction(exarg_T *eap)
4172{
4173 ufunc_T *fp = NULL;
4174 char_u *p;
4175 char_u *name;
4176 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004177 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178
4179 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004180 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4181 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 vim_free(fudi.fd_newkey);
4183 if (name == NULL)
4184 {
4185 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004186 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 return;
4188 }
4189 if (!ends_excmd(*skipwhite(p)))
4190 {
4191 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004192 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 return;
4194 }
4195 eap->nextcmd = check_nextcmd(p);
4196 if (eap->nextcmd != NULL)
4197 *p = NUL;
4198
4199 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004200 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 vim_free(name);
4202
4203 if (!eap->skip)
4204 {
4205 if (fp == NULL)
4206 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004207 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004208 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 return;
4210 }
4211 if (fp->uf_calls > 0)
4212 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004213 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 return;
4215 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004216 if (fp->uf_flags & FC_VIM9)
4217 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004218 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004219 return;
4220 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221
4222 if (fudi.fd_dict != NULL)
4223 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004224 // Delete the dict item that refers to the function, it will
4225 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4227 }
4228 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004229 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004230 // A normal function (not a numbered function or lambda) has a
4231 // refcount of 1 for the entry in the hashtable. When deleting
4232 // it and the refcount is more than one, it should be kept.
4233 // A numbered function and lambda should be kept if the refcount is
4234 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004235 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004236 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004237 // Function is still referenced somewhere. Don't free it but
4238 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004239 if (func_remove(fp))
4240 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004241 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004242 }
4243 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004244 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004245 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004246 }
4247}
4248
4249/*
4250 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004251 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 */
4253 void
4254func_unref(char_u *name)
4255{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004256 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004258 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004260 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004261 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004262 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004264 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004266 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004268 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004269}
4270
4271/*
4272 * Unreference a Function: decrement the reference count and free it when it
4273 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004274 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004275 */
4276 void
4277func_ptr_unref(ufunc_T *fp)
4278{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004279 if (fp != NULL && (--fp->uf_refcount <= 0
4280 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4281 && fp->uf_partial->pt_refcount <= 1
4282 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004283 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004284 // Only delete it when it's not being used. Otherwise it's done
4285 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004286 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004287 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288 }
4289}
4290
4291/*
4292 * Count a reference to a Function.
4293 */
4294 void
4295func_ref(char_u *name)
4296{
4297 ufunc_T *fp;
4298
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004299 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004301 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004302 if (fp != NULL)
4303 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004305 // Only give an error for a numbered function.
4306 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004307 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004308}
4309
4310/*
4311 * Count a reference to a Function.
4312 */
4313 void
4314func_ptr_ref(ufunc_T *fp)
4315{
4316 if (fp != NULL)
4317 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318}
4319
4320/*
4321 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4322 * referenced from anywhere that is in use.
4323 */
4324 static int
4325can_free_funccal(funccall_T *fc, int copyID)
4326{
4327 return (fc->l_varlist.lv_copyID != copyID
4328 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004329 && fc->l_avars.dv_copyID != copyID
4330 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331}
4332
4333/*
4334 * ":return [expr]"
4335 */
4336 void
4337ex_return(exarg_T *eap)
4338{
4339 char_u *arg = eap->arg;
4340 typval_T rettv;
4341 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004342 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343
4344 if (current_funccal == NULL)
4345 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004346 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 return;
4348 }
4349
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004350 CLEAR_FIELD(evalarg);
4351 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4352
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353 if (eap->skip)
4354 ++emsg_skip;
4355
4356 eap->nextcmd = NULL;
4357 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004358 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359 {
4360 if (!eap->skip)
4361 returning = do_return(eap, FALSE, TRUE, &rettv);
4362 else
4363 clear_tv(&rettv);
4364 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004365 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366 else if (!eap->skip)
4367 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004368 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004369 update_force_abort();
4370
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004371 /*
4372 * Return unless the expression evaluation has been cancelled due to an
4373 * aborting error, an interrupt, or an exception.
4374 */
4375 if (!aborting())
4376 returning = do_return(eap, FALSE, TRUE, NULL);
4377 }
4378
Bram Moolenaare38eab22019-12-05 21:50:01 +01004379 // When skipping or the return gets pending, advance to the next command
4380 // in this line (!returning). Otherwise, ignore the rest of the line.
4381 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 if (returning)
4383 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004384 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385 eap->nextcmd = check_nextcmd(arg);
4386
4387 if (eap->skip)
4388 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004389 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390}
4391
4392/*
4393 * ":1,25call func(arg1, arg2)" function call.
4394 */
4395 void
4396ex_call(exarg_T *eap)
4397{
4398 char_u *arg = eap->arg;
4399 char_u *startarg;
4400 char_u *name;
4401 char_u *tofree;
4402 int len;
4403 typval_T rettv;
4404 linenr_T lnum;
4405 int doesrange;
4406 int failed = FALSE;
4407 funcdict_T fudi;
4408 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004409 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004410 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411
Bram Moolenaare6b53242020-07-01 17:28:33 +02004412 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 if (eap->skip)
4414 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004415 // trans_function_name() doesn't work well when skipping, use eval0()
4416 // instead to skip to any following command, e.g. for:
4417 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004419 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 clear_tv(&rettv);
4421 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004422 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 return;
4424 }
4425
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004426 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4427 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428 if (fudi.fd_newkey != NULL)
4429 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004430 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004431 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004432 vim_free(fudi.fd_newkey);
4433 }
4434 if (tofree == NULL)
4435 return;
4436
Bram Moolenaare38eab22019-12-05 21:50:01 +01004437 // Increase refcount on dictionary, it could get deleted when evaluating
4438 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 if (fudi.fd_dict != NULL)
4440 ++fudi.fd_dict->dv_refcount;
4441
Bram Moolenaare38eab22019-12-05 21:50:01 +01004442 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4443 // contents. For VAR_PARTIAL get its partial, unless we already have one
4444 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004445 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004446 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4447 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448
Bram Moolenaare38eab22019-12-05 21:50:01 +01004449 // Skip white space to allow ":call func ()". Not good, but required for
4450 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004451 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004452 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453
4454 if (*startarg != '(')
4455 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004456 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 goto end;
4458 }
4459
4460 /*
4461 * When skipping, evaluate the function once, to find the end of the
4462 * arguments.
4463 * When the function takes a range, this is discovered after the first
4464 * call, and the loop is broken.
4465 */
4466 if (eap->skip)
4467 {
4468 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004469 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 }
4471 else
4472 lnum = eap->line1;
4473 for ( ; lnum <= eap->line2; ++lnum)
4474 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004475 funcexe_T funcexe;
4476
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 if (!eap->skip && eap->addr_count > 0)
4478 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004479 if (lnum > curbuf->b_ml.ml_line_count)
4480 {
4481 // If the function deleted lines or switched to another buffer
4482 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004483 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004484 break;
4485 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 curwin->w_cursor.lnum = lnum;
4487 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 }
4490 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004491
Bram Moolenaara80faa82020-04-12 19:37:17 +02004492 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004493 funcexe.firstline = eap->line1;
4494 funcexe.lastline = eap->line2;
4495 funcexe.doesrange = &doesrange;
4496 funcexe.evaluate = !eap->skip;
4497 funcexe.partial = partial;
4498 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004499 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004500 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 {
4502 failed = TRUE;
4503 break;
4504 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004505 if (has_watchexpr())
4506 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004508 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004509 if (handle_subscript(&arg, &rettv,
4510 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 {
4512 failed = TRUE;
4513 break;
4514 }
4515
4516 clear_tv(&rettv);
4517 if (doesrange || eap->skip)
4518 break;
4519
Bram Moolenaare38eab22019-12-05 21:50:01 +01004520 // Stop when immediately aborting on error, or when an interrupt
4521 // occurred or an exception was thrown but not caught.
4522 // get_func_tv() returned OK, so that the check for trailing
4523 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 if (aborting())
4525 break;
4526 }
4527 if (eap->skip)
4528 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004529 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530
Bram Moolenaare51bb172020-02-16 19:42:23 +01004531 // When inside :try we need to check for following "| catch".
4532 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004534 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004535 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004536 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004538 if (!failed)
4539 {
4540 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004541 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004542 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543 }
4544 else
4545 eap->nextcmd = check_nextcmd(arg);
4546 }
4547
4548end:
4549 dict_unref(fudi.fd_dict);
4550 vim_free(tofree);
4551}
4552
4553/*
4554 * Return from a function. Possibly makes the return pending. Also called
4555 * for a pending return at the ":endtry" or after returning from an extra
4556 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4557 * when called due to a ":return" command. "rettv" may point to a typval_T
4558 * with the return rettv. Returns TRUE when the return can be carried out,
4559 * FALSE when the return gets pending.
4560 */
4561 int
4562do_return(
4563 exarg_T *eap,
4564 int reanimate,
4565 int is_cmd,
4566 void *rettv)
4567{
4568 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004569 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570
4571 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004572 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 current_funccal->returned = FALSE;
4574
4575 /*
4576 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4577 * not in its finally clause (which then is to be executed next) is found.
4578 * In this case, make the ":return" pending for execution at the ":endtry".
4579 * Otherwise, return normally.
4580 */
4581 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4582 if (idx >= 0)
4583 {
4584 cstack->cs_pending[idx] = CSTP_RETURN;
4585
4586 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004587 // A pending return again gets pending. "rettv" points to an
4588 // allocated variable with the rettv of the original ":return"'s
4589 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 cstack->cs_rettv[idx] = rettv;
4591 else
4592 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004593 // When undoing a return in order to make it pending, get the stored
4594 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 if (reanimate)
4596 rettv = current_funccal->rettv;
4597
4598 if (rettv != NULL)
4599 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004600 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4602 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4603 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004604 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004605 }
4606 else
4607 cstack->cs_rettv[idx] = NULL;
4608
4609 if (reanimate)
4610 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004611 // The pending return value could be overwritten by a ":return"
4612 // without argument in a finally clause; reset the default
4613 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 current_funccal->rettv->v_type = VAR_NUMBER;
4615 current_funccal->rettv->vval.v_number = 0;
4616 }
4617 }
4618 report_make_pending(CSTP_RETURN, rettv);
4619 }
4620 else
4621 {
4622 current_funccal->returned = TRUE;
4623
Bram Moolenaare38eab22019-12-05 21:50:01 +01004624 // If the return is carried out now, store the return value. For
4625 // a return immediately after reanimation, the value is already
4626 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627 if (!reanimate && rettv != NULL)
4628 {
4629 clear_tv(current_funccal->rettv);
4630 *current_funccal->rettv = *(typval_T *)rettv;
4631 if (!is_cmd)
4632 vim_free(rettv);
4633 }
4634 }
4635
4636 return idx < 0;
4637}
4638
4639/*
4640 * Free the variable with a pending return value.
4641 */
4642 void
4643discard_pending_return(void *rettv)
4644{
4645 free_tv((typval_T *)rettv);
4646}
4647
4648/*
4649 * Generate a return command for producing the value of "rettv". The result
4650 * is an allocated string. Used by report_pending() for verbose messages.
4651 */
4652 char_u *
4653get_return_cmd(void *rettv)
4654{
4655 char_u *s = NULL;
4656 char_u *tofree = NULL;
4657 char_u numbuf[NUMBUFLEN];
4658
4659 if (rettv != NULL)
4660 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4661 if (s == NULL)
4662 s = (char_u *)"";
4663
4664 STRCPY(IObuff, ":return ");
4665 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4666 if (STRLEN(s) + 8 >= IOSIZE)
4667 STRCPY(IObuff + IOSIZE - 4, "...");
4668 vim_free(tofree);
4669 return vim_strsave(IObuff);
4670}
4671
4672/*
4673 * Get next function line.
4674 * Called by do_cmdline() to get the next line.
4675 * Returns allocated string, or NULL for end of function.
4676 */
4677 char_u *
4678get_func_line(
4679 int c UNUSED,
4680 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004681 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004682 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004683{
4684 funccall_T *fcp = (funccall_T *)cookie;
4685 ufunc_T *fp = fcp->func;
4686 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004687 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688
Bram Moolenaare38eab22019-12-05 21:50:01 +01004689 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 if (fcp->dbg_tick != debug_tick)
4691 {
4692 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004693 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 fcp->dbg_tick = debug_tick;
4695 }
4696#ifdef FEAT_PROFILE
4697 if (do_profiling == PROF_YES)
4698 func_line_end(cookie);
4699#endif
4700
4701 gap = &fp->uf_lines;
4702 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4703 || fcp->returned)
4704 retval = NULL;
4705 else
4706 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004707 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 while (fcp->linenr < gap->ga_len
4709 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4710 ++fcp->linenr;
4711 if (fcp->linenr >= gap->ga_len)
4712 retval = NULL;
4713 else
4714 {
4715 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004716 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717#ifdef FEAT_PROFILE
4718 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004719 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004720#endif
4721 }
4722 }
4723
Bram Moolenaare38eab22019-12-05 21:50:01 +01004724 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004725 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004727 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004728 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004730 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 fcp->dbg_tick = debug_tick;
4732 }
4733
4734 return retval;
4735}
4736
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004737/*
4738 * Return TRUE if the currently active function should be ended, because a
4739 * return was encountered or an error occurred. Used inside a ":while".
4740 */
4741 int
4742func_has_ended(void *cookie)
4743{
4744 funccall_T *fcp = (funccall_T *)cookie;
4745
Bram Moolenaare38eab22019-12-05 21:50:01 +01004746 // Ignore the "abort" flag if the abortion behavior has been changed due to
4747 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4749 || fcp->returned);
4750}
4751
4752/*
4753 * return TRUE if cookie indicates a function which "abort"s on errors.
4754 */
4755 int
4756func_has_abort(
4757 void *cookie)
4758{
4759 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4760}
4761
4762
4763/*
4764 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4765 * Don't do this when "Func" is already a partial that was bound
4766 * explicitly (pt_auto is FALSE).
4767 * Changes "rettv" in-place.
4768 * Returns the updated "selfdict_in".
4769 */
4770 dict_T *
4771make_partial(dict_T *selfdict_in, typval_T *rettv)
4772{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004773 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 char_u *tofree = NULL;
4775 ufunc_T *fp;
4776 char_u fname_buf[FLEN_FIXED + 1];
4777 int error;
4778 dict_T *selfdict = selfdict_in;
4779
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004780 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4781 fp = rettv->vval.v_partial->pt_func;
4782 else
4783 {
4784 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4785 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004786 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004787 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004788 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004789 vim_free(tofree);
4790 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004791
4792 if (fp != NULL && (fp->uf_flags & FC_DICT))
4793 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004794 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795
4796 if (pt != NULL)
4797 {
4798 pt->pt_refcount = 1;
4799 pt->pt_dict = selfdict;
4800 pt->pt_auto = TRUE;
4801 selfdict = NULL;
4802 if (rettv->v_type == VAR_FUNC)
4803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004804 // Just a function: Take over the function name and use
4805 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 pt->pt_name = rettv->vval.v_string;
4807 }
4808 else
4809 {
4810 partial_T *ret_pt = rettv->vval.v_partial;
4811 int i;
4812
Bram Moolenaare38eab22019-12-05 21:50:01 +01004813 // Partial: copy the function name, use selfdict and copy
4814 // args. Can't take over name or args, the partial might
4815 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004816 if (ret_pt->pt_name != NULL)
4817 {
4818 pt->pt_name = vim_strsave(ret_pt->pt_name);
4819 func_ref(pt->pt_name);
4820 }
4821 else
4822 {
4823 pt->pt_func = ret_pt->pt_func;
4824 func_ptr_ref(pt->pt_func);
4825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 if (ret_pt->pt_argc > 0)
4827 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004828 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004830 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831 pt->pt_argc = 0;
4832 else
4833 {
4834 pt->pt_argc = ret_pt->pt_argc;
4835 for (i = 0; i < pt->pt_argc; i++)
4836 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4837 }
4838 }
4839 partial_unref(ret_pt);
4840 }
4841 rettv->v_type = VAR_PARTIAL;
4842 rettv->vval.v_partial = pt;
4843 }
4844 }
4845 return selfdict;
4846}
4847
4848/*
4849 * Return the name of the executed function.
4850 */
4851 char_u *
4852func_name(void *cookie)
4853{
4854 return ((funccall_T *)cookie)->func->uf_name;
4855}
4856
4857/*
4858 * Return the address holding the next breakpoint line for a funccall cookie.
4859 */
4860 linenr_T *
4861func_breakpoint(void *cookie)
4862{
4863 return &((funccall_T *)cookie)->breakpoint;
4864}
4865
4866/*
4867 * Return the address holding the debug tick for a funccall cookie.
4868 */
4869 int *
4870func_dbg_tick(void *cookie)
4871{
4872 return &((funccall_T *)cookie)->dbg_tick;
4873}
4874
4875/*
4876 * Return the nesting level for a funccall cookie.
4877 */
4878 int
4879func_level(void *cookie)
4880{
4881 return ((funccall_T *)cookie)->level;
4882}
4883
4884/*
4885 * Return TRUE when a function was ended by a ":return" command.
4886 */
4887 int
4888current_func_returned(void)
4889{
4890 return current_funccal->returned;
4891}
4892
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004893 int
4894free_unref_funccal(int copyID, int testing)
4895{
4896 int did_free = FALSE;
4897 int did_free_funccal = FALSE;
4898 funccall_T *fc, **pfc;
4899
4900 for (pfc = &previous_funccal; *pfc != NULL; )
4901 {
4902 if (can_free_funccal(*pfc, copyID))
4903 {
4904 fc = *pfc;
4905 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004906 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 did_free = TRUE;
4908 did_free_funccal = TRUE;
4909 }
4910 else
4911 pfc = &(*pfc)->caller;
4912 }
4913 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004914 // When a funccal was freed some more items might be garbage
4915 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916 (void)garbage_collect(testing);
4917
4918 return did_free;
4919}
4920
4921/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004922 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923 */
4924 static funccall_T *
4925get_funccal(void)
4926{
4927 int i;
4928 funccall_T *funccal;
4929 funccall_T *temp_funccal;
4930
4931 funccal = current_funccal;
4932 if (debug_backtrace_level > 0)
4933 {
4934 for (i = 0; i < debug_backtrace_level; i++)
4935 {
4936 temp_funccal = funccal->caller;
4937 if (temp_funccal)
4938 funccal = temp_funccal;
4939 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004940 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004941 debug_backtrace_level = i;
4942 }
4943 }
4944 return funccal;
4945}
4946
4947/*
4948 * Return the hashtable used for local variables in the current funccal.
4949 * Return NULL if there is no current funccal.
4950 */
4951 hashtab_T *
4952get_funccal_local_ht()
4953{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004954 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 return NULL;
4956 return &get_funccal()->l_vars.dv_hashtab;
4957}
4958
4959/*
4960 * Return the l: scope variable.
4961 * Return NULL if there is no current funccal.
4962 */
4963 dictitem_T *
4964get_funccal_local_var()
4965{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004966 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967 return NULL;
4968 return &get_funccal()->l_vars_var;
4969}
4970
4971/*
4972 * Return the hashtable used for argument in the current funccal.
4973 * Return NULL if there is no current funccal.
4974 */
4975 hashtab_T *
4976get_funccal_args_ht()
4977{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004978 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979 return NULL;
4980 return &get_funccal()->l_avars.dv_hashtab;
4981}
4982
4983/*
4984 * Return the a: scope variable.
4985 * Return NULL if there is no current funccal.
4986 */
4987 dictitem_T *
4988get_funccal_args_var()
4989{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004990 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004991 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004992 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993}
4994
4995/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996 * List function variables, if there is a function.
4997 */
4998 void
4999list_func_vars(int *first)
5000{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005001 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005002 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005003 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004}
5005
5006/*
5007 * If "ht" is the hashtable for local variables in the current funccal, return
5008 * the dict that contains it.
5009 * Otherwise return NULL.
5010 */
5011 dict_T *
5012get_current_funccal_dict(hashtab_T *ht)
5013{
5014 if (current_funccal != NULL
5015 && ht == &current_funccal->l_vars.dv_hashtab)
5016 return &current_funccal->l_vars;
5017 return NULL;
5018}
5019
5020/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005021 * Search hashitem in parent scope.
5022 */
5023 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005024find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005025{
5026 funccall_T *old_current_funccal = current_funccal;
5027 hashtab_T *ht;
5028 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005029 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005030
5031 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5032 return NULL;
5033
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005034 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005035 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005036 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005037 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005038 ht = find_var_ht(name, &varname);
5039 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005040 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005041 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005042 if (!HASHITEM_EMPTY(hi))
5043 {
5044 *pht = ht;
5045 break;
5046 }
5047 }
5048 if (current_funccal == current_funccal->func->uf_scoped)
5049 break;
5050 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005051 }
5052 current_funccal = old_current_funccal;
5053
5054 return hi;
5055}
5056
5057/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005058 * Search variable in parent scope.
5059 */
5060 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005061find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005062{
5063 dictitem_T *v = NULL;
5064 funccall_T *old_current_funccal = current_funccal;
5065 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005066 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005067
5068 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5069 return NULL;
5070
Bram Moolenaare38eab22019-12-05 21:50:01 +01005071 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005072 current_funccal = current_funccal->func->uf_scoped;
5073 while (current_funccal)
5074 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005075 ht = find_var_ht(name, &varname);
5076 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005077 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005078 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005079 if (v != NULL)
5080 break;
5081 }
5082 if (current_funccal == current_funccal->func->uf_scoped)
5083 break;
5084 current_funccal = current_funccal->func->uf_scoped;
5085 }
5086 current_funccal = old_current_funccal;
5087
5088 return v;
5089}
5090
5091/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005092 * Set "copyID + 1" in previous_funccal and callers.
5093 */
5094 int
5095set_ref_in_previous_funccal(int copyID)
5096{
5097 int abort = FALSE;
5098 funccall_T *fc;
5099
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005100 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005101 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005102 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005103 abort = abort
5104 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5105 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005106 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005107 }
5108 return abort;
5109}
5110
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005111 static int
5112set_ref_in_funccal(funccall_T *fc, int copyID)
5113{
5114 int abort = FALSE;
5115
5116 if (fc->fc_copyID != copyID)
5117 {
5118 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005119 abort = abort
5120 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5121 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005122 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005123 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005124 }
5125 return abort;
5126}
5127
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128/*
5129 * Set "copyID" in all local vars and arguments in the call stack.
5130 */
5131 int
5132set_ref_in_call_stack(int copyID)
5133{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005134 int abort = FALSE;
5135 funccall_T *fc;
5136 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005138 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005139 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005140
5141 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005142 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5143 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005144 abort = abort || set_ref_in_funccal(fc, copyID);
5145
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005146 return abort;
5147}
5148
5149/*
5150 * Set "copyID" in all functions available by name.
5151 */
5152 int
5153set_ref_in_functions(int copyID)
5154{
5155 int todo;
5156 hashitem_T *hi = NULL;
5157 int abort = FALSE;
5158 ufunc_T *fp;
5159
5160 todo = (int)func_hashtab.ht_used;
5161 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005163 if (!HASHITEM_EMPTY(hi))
5164 {
5165 --todo;
5166 fp = HI2UF(hi);
5167 if (!func_name_refcount(fp->uf_name))
5168 abort = abort || set_ref_in_func(NULL, fp, copyID);
5169 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170 }
5171 return abort;
5172}
5173
5174/*
5175 * Set "copyID" in all function arguments.
5176 */
5177 int
5178set_ref_in_func_args(int copyID)
5179{
5180 int i;
5181 int abort = FALSE;
5182
5183 for (i = 0; i < funcargs.ga_len; ++i)
5184 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5185 copyID, NULL, NULL);
5186 return abort;
5187}
5188
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005189/*
5190 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005191 * Returns TRUE if setting references failed somehow.
5192 */
5193 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005194set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005195{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005196 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005197 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005198 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005199 char_u fname_buf[FLEN_FIXED + 1];
5200 char_u *tofree = NULL;
5201 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005202 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005203
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005204 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005205 return FALSE;
5206
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005207 if (fp_in == NULL)
5208 {
5209 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005210 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005211 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005212 if (fp != NULL)
5213 {
5214 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005215 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005216 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005217
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005218 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005219 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005220}
5221
Bram Moolenaare38eab22019-12-05 21:50:01 +01005222#endif // FEAT_EVAL