blob: b49cef17846a90f15db4527c0a73462ac9baca38 [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 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010083
84 // Vim9 script: cannot use script var name for argument.
Bram Moolenaarbc327cc2021-02-23 12:05:46 +010085 if (!skip && argtypes != NULL && script_var_exists(arg, p - arg,
86 FALSE, NULL) == OK)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010087 {
88 semsg(_(e_variable_already_declared_in_script), arg);
89 return arg;
90 }
91
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010092 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
93 return arg;
94 if (newargs != NULL)
95 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 int c;
97 int i;
98
99 c = *p;
100 *p = NUL;
101 arg_copy = vim_strsave(arg);
102 if (arg_copy == NULL)
103 {
104 *p = c;
105 return arg;
106 }
107
108 // Check for duplicate argument name.
109 for (i = 0; i < newargs->ga_len; ++i)
110 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
111 {
112 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
113 vim_free(arg_copy);
114 return arg;
115 }
116 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
117 newargs->ga_len++;
118
119 *p = c;
120 }
121
122 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100123 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 {
125 char_u *type = NULL;
126
Bram Moolenaar6e949782020-04-13 17:21:00 +0200127 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
128 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200129 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200130 arg_copy == NULL ? arg : arg_copy);
131 p = skipwhite(p);
132 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100133 if (*p == ':')
134 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200135 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100136 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200137 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100138 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 return arg;
140 }
141 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200142 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100146 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200147 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200148 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200149 arg_copy == NULL ? arg : arg_copy);
150 return arg;
151 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100152 if (!skip)
153 {
154 if (type == NULL && types_optional)
155 // lambda arguments default to "any" type
156 type = vim_strsave((char_u *)"any");
157 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
158 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100159 }
160
161 return p;
162}
163
164/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200165 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100166 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100167 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200168 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100169 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170get_function_args(
171 char_u **argp,
172 char_u endchar,
173 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100174 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100175 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200177 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200178 int skip,
179 exarg_T *eap,
180 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200181{
182 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100183 char_u *arg;
184 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200185 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200186 int any_default = FALSE;
187 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100188 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200189
190 if (newargs != NULL)
191 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100192 if (argtypes != NULL)
193 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200194 if (default_args != NULL)
195 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (varargs != NULL)
198 *varargs = FALSE;
199
200 /*
201 * Isolate the arguments: "arg1, arg2, ...)"
202 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100203 arg = skipwhite(*argp);
204 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200205 while (*p != endchar)
206 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200207 while (eap != NULL && eap->getline != NULL
208 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200209 {
210 char_u *theline;
211
212 // End of the line, get the next one.
213 theline = eap->getline(':', eap->cookie, 0, TRUE);
214 if (theline == NULL)
215 break;
216 vim_free(*line_to_free);
217 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200218 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200219 p = skipwhite(theline);
220 }
221
222 if (mustend && *p != endchar)
223 {
224 if (!skip)
225 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100226 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200227 }
228 if (*p == endchar)
229 break;
230
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200231 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
232 {
233 if (varargs != NULL)
234 *varargs = TRUE;
235 p += 3;
236 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100237
238 if (argtypes != NULL)
239 {
240 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200241 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100243 if (!skip)
244 emsg(_(e_missing_name_after_dots));
245 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100246 }
247
248 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100249 p = one_function_arg(p, newargs, argtypes, types_optional,
250 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100251 if (p == arg)
252 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100253 if (*skipwhite(p) == '=')
254 {
255 emsg(_(e_cannot_use_default_for_variable_arguments));
256 break;
257 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200259 }
260 else
261 {
262 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100263 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100264 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200265 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200267 if (*skipwhite(p) == '=' && default_args != NULL)
268 {
269 typval_T rettv;
270
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100271 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200272 any_default = TRUE;
273 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200274 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200275 p = skipwhite(p);
276 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200277 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200278 {
279 if (ga_grow(default_args, 1) == FAIL)
280 goto err_ret;
281
282 // trim trailing whitespace
283 while (p > expr && VIM_ISWHITE(p[-1]))
284 p--;
285 c = *p;
286 *p = NUL;
287 expr = vim_strsave(expr);
288 if (expr == NULL)
289 {
290 *p = c;
291 goto err_ret;
292 }
293 ((char_u **)(default_args->ga_data))
294 [default_args->ga_len] = expr;
295 default_args->ga_len++;
296 *p = c;
297 }
298 else
299 mustend = TRUE;
300 }
301 else if (any_default)
302 {
303 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200304 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200305 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200306 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200307 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200309 // Don't give this error when skipping, it makes the "->" not
310 // found in "{k,v -> x}" and give a confusing error.
311 if (!skip && in_vim9script()
312 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
313 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100314 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200315 goto err_ret;
316 }
317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200318 else
319 mustend = TRUE;
320 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200321 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200322 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200324
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200325 if (*p != endchar)
326 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100327 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200328
329 *argp = p;
330 return OK;
331
332err_ret:
333 if (newargs != NULL)
334 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200335 if (default_args != NULL)
336 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200337 return FAIL;
338}
339
340/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100341 * Parse the argument types, filling "fp->uf_arg_types".
342 * Return OK or FAIL.
343 */
344 static int
345parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
346{
347 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
348 if (argtypes->ga_len > 0)
349 {
350 // When "varargs" is set the last name/type goes into uf_va_name
351 // and uf_va_type.
352 int len = argtypes->ga_len - (varargs ? 1 : 0);
353
354 if (len > 0)
355 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
356 if (fp->uf_arg_types != NULL)
357 {
358 int i;
359 type_T *type;
360
361 for (i = 0; i < len; ++ i)
362 {
363 char_u *p = ((char_u **)argtypes->ga_data)[i];
364
365 if (p == NULL)
366 // will get the type from the default value
367 type = &t_unknown;
368 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100369 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 if (type == NULL)
371 return FAIL;
372 fp->uf_arg_types[i] = type;
373 }
374 }
375 if (varargs)
376 {
377 char_u *p;
378
379 // Move the last argument "...name: type" to uf_va_name and
380 // uf_va_type.
381 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
382 [fp->uf_args.ga_len - 1];
383 --fp->uf_args.ga_len;
384 p = ((char_u **)argtypes->ga_data)[len];
385 if (p == NULL)
386 // todo: get type from default value
387 fp->uf_va_type = &t_any;
388 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100389 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100390 if (fp->uf_va_type == NULL)
391 return FAIL;
392 }
393 }
394 return OK;
395}
396
397/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200398 * Register function "fp" as using "current_funccal" as its scope.
399 */
400 static int
401register_closure(ufunc_T *fp)
402{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200403 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100404 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200405 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200406 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200407 fp->uf_scoped = current_funccal;
408 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200409
Bram Moolenaar58016442016-07-31 18:30:22 +0200410 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
411 return FAIL;
412 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
413 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200414 return OK;
415}
416
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100417 static void
418set_ufunc_name(ufunc_T *fp, char_u *name)
419{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100420 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
421 // actually extends beyond the struct.
422 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100423
424 if (name[0] == K_SPECIAL)
425 {
426 fp->uf_name_exp = alloc(STRLEN(name) + 3);
427 if (fp->uf_name_exp != NULL)
428 {
429 STRCPY(fp->uf_name_exp, "<SNR>");
430 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
431 }
432 }
433}
434
Bram Moolenaar58016442016-07-31 18:30:22 +0200435/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200436 * Get a name for a lambda. Returned in static memory.
437 */
438 char_u *
439get_lambda_name(void)
440{
441 static char_u name[30];
442 static int lambda_no = 0;
443
444 sprintf((char*)name, "<lambda>%d", ++lambda_no);
445 return name;
446}
447
Bram Moolenaar801ab062020-06-25 19:27:56 +0200448#if defined(FEAT_LUA) || defined(PROTO)
449/*
450 * Registers a native C callback which can be called from Vim script.
451 * Returns the name of the Vim script function.
452 */
453 char_u *
454register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
455{
456 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200457 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200458
459 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
460 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200461 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200462
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200463 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200464 fp->uf_refcount = 1;
465 fp->uf_varargs = TRUE;
466 fp->uf_flags = FC_CFUNC;
467 fp->uf_calls = 0;
468 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200469 fp->uf_cb = cb;
470 fp->uf_cb_free = cb_free;
471 fp->uf_cb_state = state;
472
473 set_ufunc_name(fp, name);
474 hash_add(&func_hashtab, UF2HIKEY(fp));
475
476 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200477}
478#endif
479
Bram Moolenaar04b12692020-05-04 23:24:44 +0200480/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100481 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100482 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100483 * If "white_error" is not NULL check for correct use of white space and set
484 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100485 * Return NULL if no valid arrow found.
486 */
487 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100488skip_arrow(
489 char_u *start,
490 int equal_arrow,
491 char_u **ret_type,
492 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100493{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100494 char_u *s = start;
495 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100496
497 if (equal_arrow)
498 {
499 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100500 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100501 if (white_error != NULL && !VIM_ISWHITE(s[1]))
502 {
503 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100504 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100505 return NULL;
506 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100507 s = skipwhite(s + 1);
508 *ret_type = s;
509 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100510 if (s == *ret_type)
511 {
512 emsg(_(e_missing_return_type));
513 return NULL;
514 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100515 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100516 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100517 s = skipwhite(s);
518 if (*s != '=')
519 return NULL;
520 ++s;
521 }
522 if (*s != '>')
523 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100524 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
525 || !IS_WHITE_OR_NUL(s[1])))
526 {
527 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100528 semsg(_(e_white_space_required_before_and_after_str_at_str),
529 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100530 return NULL;
531 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100532 return skipwhite(s + 1);
533}
534
535/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200536 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100537 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100538 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200539 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
540 */
541 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100542get_lambda_tv(
543 char_u **arg,
544 typval_T *rettv,
545 int types_optional,
546 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200547{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200548 int evaluate = evalarg != NULL
549 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200550 garray_T newargs;
551 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200552 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100553 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200554 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100555 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200556 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100557 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200558 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200559 char_u *s;
560 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200561 int *old_eval_lavars = eval_lavars_used;
562 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100563 char_u *tofree1 = NULL;
564 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100565 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100566 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +0100567 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100568
569 if (equal_arrow && !in_vim9script())
570 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200571
572 ga_init(&newargs);
573 ga_init(&newlines);
574
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 // First, check if this is really a lambda expression. "->" or "=>" must
576 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100577 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100578 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100579 types_optional ? &argtypes : NULL, types_optional,
580 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100581 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100582 {
583 if (types_optional)
584 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100585 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100586 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200587
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100588 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200589 if (evaluate)
590 pnewargs = &newargs;
591 else
592 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100593 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100594 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100595 types_optional ? &argtypes : NULL, types_optional,
596 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100597 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100598 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100599 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100600 {
601 if (types_optional)
602 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100603 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100604 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100605 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100606 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200607
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100608 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
609 if (ret_type != NULL)
610 {
611 ret_type = vim_strsave(ret_type);
612 tofree2 = ret_type;
613 }
614
Bram Moolenaare38eab22019-12-05 21:50:01 +0100615 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200616 if (evaluate)
617 eval_lavars_used = &eval_lavars;
618
Bram Moolenaar65c44152020-12-24 15:14:01 +0100619 *arg = skipwhite_and_linebreak(*arg, evalarg);
620
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100621 // Recognize "{" as the start of a function body.
622 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100623 {
624 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100625 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100626 emsg("Lambda function body not supported yet");
627 goto errret;
628 }
629
Bram Moolenaare38eab22019-12-05 21:50:01 +0100630 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200631 start = *arg;
632 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200633 if (ret == FAIL)
634 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200635 if (evalarg != NULL)
636 {
637 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100638 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200639 evalarg->eval_tofree = NULL;
640 }
641
Bram Moolenaar65c44152020-12-24 15:14:01 +0100642 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100643 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100644 *arg = skipwhite_and_linebreak(*arg, evalarg);
645 if (**arg != '}')
646 {
647 semsg(_("E451: Expected }: %s"), *arg);
648 goto errret;
649 }
650 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100651 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200652
653 if (evaluate)
654 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200655 int len;
656 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200657 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200658 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200659
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200660 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200661 if (fp == NULL)
662 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200663 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200664 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200665 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200666 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200667
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200668 ga_init2(&newlines, (int)sizeof(char_u *), 1);
669 if (ga_grow(&newlines, 1) == FAIL)
670 goto errret;
671
Bram Moolenaare38eab22019-12-05 21:50:01 +0100672 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200673 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200674 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200675 if (p == NULL)
676 goto errret;
677 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
678 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200679 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200680 if (strstr((char *)p + 7, "a:") == NULL)
681 // No a: variables are used for sure.
682 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200683
684 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100685 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200686 hash_add(&func_hashtab, UF2HIKEY(fp));
687 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200688 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100689 if (types_optional)
690 {
691 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
692 goto errret;
693 if (ret_type != NULL)
694 {
695 fp->uf_ret_type = parse_type(&ret_type,
696 &fp->uf_type_list, TRUE);
697 if (fp->uf_ret_type == NULL)
698 goto errret;
699 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100700 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100701 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100702 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100703
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200704 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200705 if (current_funccal != NULL && eval_lavars)
706 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200707 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200708 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200709 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200710 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200711
712#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200713 if (prof_def_func())
714 func_do_profile(fp);
715#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200716 if (sandbox)
717 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100718 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200719 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200720 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200721 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200722 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100723 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200724
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200725 pt->pt_func = fp;
726 pt->pt_refcount = 1;
727 rettv->vval.v_partial = pt;
728 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200729 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200731 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200732 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100733 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200734 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100735 vim_free(tofree1);
736 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100737 if (types_optional)
738 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200739 return OK;
740
741errret:
742 ga_clear_strings(&newargs);
743 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100744 if (types_optional)
745 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200746 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100747 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200748 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100749 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200750 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100751 vim_free(tofree1);
752 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200753 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200754 return FAIL;
755}
756
757/*
758 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
759 * name it contains, otherwise return "name".
760 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
761 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100762 * If "type" is not NULL and a Vim9 script-local variable is found look up the
763 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200764 */
765 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100766deref_func_name(
767 char_u *name,
768 int *lenp,
769 partial_T **partialp,
770 type_T **type,
771 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200772{
773 dictitem_T *v;
774 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100775 char_u *s = NULL;
776 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200777
778 if (partialp != NULL)
779 *partialp = NULL;
780
781 cc = name[*lenp];
782 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100783 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200784 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100785 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200786 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100787 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200788 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100789 if (v->di_tv.vval.v_string == NULL)
790 {
791 *lenp = 0;
792 return (char_u *)""; // just in case
793 }
794 s = v->di_tv.vval.v_string;
795 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200796 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200797
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100798 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200799 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100800 partial_T *pt = v->di_tv.vval.v_partial;
801
802 if (pt == NULL)
803 {
804 *lenp = 0;
805 return (char_u *)""; // just in case
806 }
807 if (partialp != NULL)
808 *partialp = pt;
809 s = partial_name(pt);
810 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200811 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100812
813 if (s != NULL)
814 {
815 if (type != NULL && ht == get_script_local_ht())
816 {
817 svar_T *sv = find_typval_in_script(&v->di_tv);
818
819 if (sv != NULL)
820 *type = sv->sv_type;
821 }
822 return s;
823 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200824 }
825
826 return name;
827}
828
829/*
830 * Give an error message with a function name. Handle <SNR> things.
831 * "ermsg" is to be passed without translation, use N_() instead of _().
832 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100833 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200834emsg_funcname(char *ermsg, char_u *name)
835{
836 char_u *p;
837
838 if (*name == K_SPECIAL)
839 p = concat_str((char_u *)"<SNR>", name + 3);
840 else
841 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100842 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200843 if (p != name)
844 vim_free(p);
845}
846
847/*
848 * Allocate a variable for the result of a function.
849 * Return OK or FAIL.
850 */
851 int
852get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200853 char_u *name, // name of the function
854 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200855 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200856 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200857 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200858 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200859{
860 char_u *argp;
861 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100862 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
863 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200864 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200865
866 /*
867 * Get the arguments.
868 */
869 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200870 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
871 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200872 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200873 // skip the '(' or ',' and possibly line breaks
874 argp = skipwhite_and_linebreak(argp + 1, evalarg);
875
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200876 if (*argp == ')' || *argp == ',' || *argp == NUL)
877 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200878 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200879 {
880 ret = FAIL;
881 break;
882 }
883 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200884 // The comma should come right after the argument, but this wasn't
885 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200886 if (vim9script)
887 {
888 if (*argp != ',' && *skipwhite(argp) == ',')
889 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +0100890 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200891 ret = FAIL;
892 break;
893 }
894 }
895 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200896 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200897 if (*argp != ',')
898 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200899 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
900 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100901 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200902 ret = FAIL;
903 break;
904 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200905 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200906 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200907 if (*argp == ')')
908 ++argp;
909 else
910 ret = FAIL;
911
912 if (ret == OK)
913 {
914 int i = 0;
915
916 if (get_vim_var_nr(VV_TESTING))
917 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100918 // Prepare for calling test_garbagecollect_now(), need to know
919 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200920 if (funcargs.ga_itemsize == 0)
921 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
922 for (i = 0; i < argcount; ++i)
923 if (ga_grow(&funcargs, 1) == OK)
924 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
925 &argvars[i];
926 }
927
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200928 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200929
930 funcargs.ga_len -= i;
931 }
932 else if (!aborting())
933 {
934 if (argcount == MAX_FUNC_ARGS)
935 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
936 else
937 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
938 }
939
940 while (--argcount >= 0)
941 clear_tv(&argvars[argcount]);
942
Bram Moolenaar8294d492020-08-10 22:40:56 +0200943 if (in_vim9script())
944 *arg = argp;
945 else
946 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200947 return ret;
948}
949
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200950/*
951 * Return TRUE if "p" starts with "<SID>" or "s:".
952 * Only works if eval_fname_script() returned non-zero for "p"!
953 */
954 static int
955eval_fname_sid(char_u *p)
956{
957 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
958}
959
960/*
961 * In a script change <SID>name() and s:name() to K_SNR 123_name().
962 * Change <SNR>123_name() to K_SNR 123_name().
963 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
964 * (slow).
965 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100966 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200967fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
968{
969 int llen;
970 char_u *fname;
971 int i;
972
973 llen = eval_fname_script(name);
974 if (llen > 0)
975 {
976 fname_buf[0] = K_SPECIAL;
977 fname_buf[1] = KS_EXTRA;
978 fname_buf[2] = (int)KE_SNR;
979 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100980 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200981 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200982 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100983 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200984 else
985 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200986 sprintf((char *)fname_buf + 3, "%ld_",
987 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200988 i = (int)STRLEN(fname_buf);
989 }
990 }
991 if (i + STRLEN(name + llen) < FLEN_FIXED)
992 {
993 STRCPY(fname_buf + i, name + llen);
994 fname = fname_buf;
995 }
996 else
997 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200998 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200999 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001000 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001001 else
1002 {
1003 *tofree = fname;
1004 mch_memmove(fname, fname_buf, (size_t)i);
1005 STRCPY(fname + i, name + llen);
1006 }
1007 }
1008 }
1009 else
1010 fname = name;
1011 return fname;
1012}
1013
1014/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001015 * Find a function "name" in script "sid".
1016 */
1017 static ufunc_T *
1018find_func_with_sid(char_u *name, int sid)
1019{
1020 hashitem_T *hi;
1021 char_u buffer[200];
1022
1023 buffer[0] = K_SPECIAL;
1024 buffer[1] = KS_EXTRA;
1025 buffer[2] = (int)KE_SNR;
1026 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1027 (long)sid, name);
1028 hi = hash_find(&func_hashtab, buffer);
1029 if (!HASHITEM_EMPTY(hi))
1030 return HI2UF(hi);
1031
1032 return NULL;
1033}
1034
1035/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001036 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001037 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001038 * Return NULL for unknown function.
1039 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001040 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001041find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001042{
1043 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001044 ufunc_T *func;
1045 imported_T *imported;
1046
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001047 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001048 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001049 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001050 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001051 int find_script_local = in_vim9script()
1052 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001053
Bram Moolenaar95006e32020-08-29 17:47:08 +02001054 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001055 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001056 // Find script-local function before global one.
1057 func = find_func_with_sid(name, current_sctx.sc_sid);
1058 if (func != NULL)
1059 return func;
1060 }
1061
Bram Moolenaarefa94442020-08-08 22:16:00 +02001062 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001063 && name[1] == KS_EXTRA
1064 && name[2] == KE_SNR)
1065 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001066 // Caller changes s: to <SNR>99_name.
1067
1068 after_script = name + 3;
1069 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001070 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001071 ++after_script;
1072 else
1073 after_script = NULL;
1074 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001075 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001076 {
1077 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001078 if (after_script != NULL && sid != current_sctx.sc_sid)
1079 imported = find_imported_in_script(after_script, 0, sid);
1080 else
1081 imported = find_imported(after_script == NULL
1082 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001083 if (imported != NULL && imported->imp_funcname != NULL)
1084 {
1085 hi = hash_find(&func_hashtab, imported->imp_funcname);
1086 if (!HASHITEM_EMPTY(hi))
1087 return HI2UF(hi);
1088 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001089 }
1090 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001091
Bram Moolenaara26b9702020-04-18 19:53:28 +02001092 hi = hash_find(&func_hashtab,
1093 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001094 if (!HASHITEM_EMPTY(hi))
1095 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001096
1097 return NULL;
1098}
1099
1100/*
1101 * Find a function by name, return pointer to it in ufuncs.
1102 * "cctx" is passed in a :def function to find imported functions.
1103 * Return NULL for unknown or dead function.
1104 */
1105 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001106find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001107{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001108 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001109
1110 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1111 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001112 return NULL;
1113}
1114
1115/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001116 * Return TRUE if "ufunc" is a global function.
1117 */
1118 int
1119func_is_global(ufunc_T *ufunc)
1120{
1121 return ufunc->uf_name[0] != K_SPECIAL;
1122}
1123
1124/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001125 * Copy the function name of "fp" to buffer "buf".
1126 * "buf" must be able to hold the function name plus three bytes.
1127 * Takes care of script-local function names.
1128 */
1129 static void
1130cat_func_name(char_u *buf, ufunc_T *fp)
1131{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001132 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001133 {
1134 STRCPY(buf, "<SNR>");
1135 STRCAT(buf, fp->uf_name + 3);
1136 }
1137 else
1138 STRCPY(buf, fp->uf_name);
1139}
1140
1141/*
1142 * Add a number variable "name" to dict "dp" with value "nr".
1143 */
1144 static void
1145add_nr_var(
1146 dict_T *dp,
1147 dictitem_T *v,
1148 char *name,
1149 varnumber_T nr)
1150{
1151 STRCPY(v->di_key, name);
1152 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1153 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1154 v->di_tv.v_type = VAR_NUMBER;
1155 v->di_tv.v_lock = VAR_FIXED;
1156 v->di_tv.vval.v_number = nr;
1157}
1158
1159/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001160 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001161 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001162 static void
1163free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001164{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001165 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001166
1167 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1168 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001169 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001170
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001171 // When garbage collecting a funccall_T may be freed before the
1172 // function that references it, clear its uf_scoped field.
1173 // The function may have been redefined and point to another
1174 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001175 if (fp != NULL && fp->uf_scoped == fc)
1176 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001177 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001178 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001179
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001180 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001181 vim_free(fc);
1182}
1183
1184/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001185 * Free "fc" and what it contains.
1186 * Can be called only when "fc" is kept beyond the period of it called,
1187 * i.e. after cleanup_function_call(fc).
1188 */
1189 static void
1190free_funccal_contents(funccall_T *fc)
1191{
1192 listitem_T *li;
1193
1194 // Free all l: variables.
1195 vars_clear(&fc->l_vars.dv_hashtab);
1196
1197 // Free all a: variables.
1198 vars_clear(&fc->l_avars.dv_hashtab);
1199
1200 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001201 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001202 clear_tv(&li->li_tv);
1203
1204 free_funccal(fc);
1205}
1206
1207/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001208 * Handle the last part of returning from a function: free the local hashtable.
1209 * Unless it is still in use by a closure.
1210 */
1211 static void
1212cleanup_function_call(funccall_T *fc)
1213{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001214 int may_free_fc = fc->fc_refcount <= 0;
1215 int free_fc = TRUE;
1216
Bram Moolenaar6914c642017-04-01 21:21:30 +02001217 current_funccal = fc->caller;
1218
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001219 // Free all l: variables if not referred.
1220 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1221 vars_clear(&fc->l_vars.dv_hashtab);
1222 else
1223 free_fc = FALSE;
1224
1225 // If the a:000 list and the l: and a: dicts are not referenced and
1226 // there is no closure using it, we can free the funccall_T and what's
1227 // in it.
1228 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1229 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001230 else
1231 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001232 int todo;
1233 hashitem_T *hi;
1234 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001235
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001236 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001237
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001238 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001239 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1240 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1241 {
1242 if (!HASHITEM_EMPTY(hi))
1243 {
1244 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001245 di = HI2DI(hi);
1246 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001247 }
1248 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001249 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001250
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001251 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1252 fc->l_varlist.lv_first = NULL;
1253 else
1254 {
1255 listitem_T *li;
1256
1257 free_fc = FALSE;
1258
1259 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001260 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001261 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001262 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001263
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001264 if (free_fc)
1265 free_funccal(fc);
1266 else
1267 {
1268 static int made_copy = 0;
1269
1270 // "fc" is still in use. This can happen when returning "a:000",
1271 // assigning "l:" to a global variable or defining a closure.
1272 // Link "fc" in the list for garbage collection later.
1273 fc->caller = previous_funccal;
1274 previous_funccal = fc;
1275
1276 if (want_garbage_collect)
1277 // If garbage collector is ready, clear count.
1278 made_copy = 0;
1279 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001280 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001281 // We have made a lot of copies, worth 4 Mbyte. This can happen
1282 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001283 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001284 // too much memory.
1285 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001286 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001287 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001288 }
1289}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001290
1291/*
1292 * There are two kinds of function names:
1293 * 1. ordinary names, function defined with :function or :def
1294 * 2. numbered functions and lambdas
1295 * For the first we only count the name stored in func_hashtab as a reference,
1296 * using function() does not count as a reference, because the function is
1297 * looked up by name.
1298 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001299 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001300func_name_refcount(char_u *name)
1301{
1302 return isdigit(*name) || *name == '<';
1303}
1304
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001305/*
1306 * Unreference "fc": decrement the reference count and free it when it
1307 * becomes zero. "fp" is detached from "fc".
1308 * When "force" is TRUE we are exiting.
1309 */
1310 static void
1311funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1312{
1313 funccall_T **pfc;
1314 int i;
1315
1316 if (fc == NULL)
1317 return;
1318
1319 if (--fc->fc_refcount <= 0 && (force || (
1320 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1321 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1322 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1323 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1324 {
1325 if (fc == *pfc)
1326 {
1327 *pfc = fc->caller;
1328 free_funccal_contents(fc);
1329 return;
1330 }
1331 }
1332 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1333 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1334 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1335}
1336
1337/*
1338 * Remove the function from the function hashtable. If the function was
1339 * deleted while it still has references this was already done.
1340 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1341 */
1342 static int
1343func_remove(ufunc_T *fp)
1344{
1345 hashitem_T *hi;
1346
1347 // Return if it was already virtually deleted.
1348 if (fp->uf_flags & FC_DEAD)
1349 return FALSE;
1350
1351 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1352 if (!HASHITEM_EMPTY(hi))
1353 {
1354 // When there is a def-function index do not actually remove the
1355 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001356 // Do remove it when it's a copy.
1357 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001358 fp->uf_flags |= FC_DEAD;
1359 else
1360 hash_remove(&func_hashtab, hi);
1361 return TRUE;
1362 }
1363 return FALSE;
1364}
1365
1366 static void
1367func_clear_items(ufunc_T *fp)
1368{
1369 ga_clear_strings(&(fp->uf_args));
1370 ga_clear_strings(&(fp->uf_def_args));
1371 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001372 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001373 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001374 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001375 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001376 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001377
1378 // Increment the refcount of this function to avoid it being freed
1379 // recursively when the partial is freed.
1380 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001381 partial_unref(fp->uf_partial);
1382 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001383 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001384
1385#ifdef FEAT_LUA
1386 if (fp->uf_cb_free != NULL)
1387 {
1388 fp->uf_cb_free(fp->uf_cb_state);
1389 fp->uf_cb_free = NULL;
1390 }
1391
1392 fp->uf_cb_state = NULL;
1393 fp->uf_cb = NULL;
1394#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001395#ifdef FEAT_PROFILE
1396 VIM_CLEAR(fp->uf_tml_count);
1397 VIM_CLEAR(fp->uf_tml_total);
1398 VIM_CLEAR(fp->uf_tml_self);
1399#endif
1400}
1401
1402/*
1403 * Free all things that a function contains. Does not free the function
1404 * itself, use func_free() for that.
1405 * When "force" is TRUE we are exiting.
1406 */
1407 static void
1408func_clear(ufunc_T *fp, int force)
1409{
1410 if (fp->uf_cleared)
1411 return;
1412 fp->uf_cleared = TRUE;
1413
1414 // clear this function
1415 func_clear_items(fp);
1416 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001417 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001418}
1419
1420/*
1421 * Free a function and remove it from the list of functions. Does not free
1422 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001423 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001424 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001425 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001426 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001427func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001428{
1429 // Only remove it when not done already, otherwise we would remove a newer
1430 // version of the function with the same name.
1431 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1432 func_remove(fp);
1433
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001434 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001435 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001436 if (fp->uf_dfunc_idx > 0)
1437 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001438 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001439 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001440 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001441 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001442 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001443}
1444
1445/*
1446 * Free all things that a function contains and free the function itself.
1447 * When "force" is TRUE we are exiting.
1448 */
1449 static void
1450func_clear_free(ufunc_T *fp, int force)
1451{
1452 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001453 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1454 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001455 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001456 else
1457 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001458}
1459
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001460/*
1461 * Copy already defined function "lambda" to a new function with name "global".
1462 * This is for when a compiled function defines a global function.
1463 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001464 int
1465copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001466{
1467 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001468 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001469
1470 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001471 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001472 semsg(_(e_lambda_function_not_found_str), lambda);
1473 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001474 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001475
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001476 fp = find_func(global, TRUE, NULL);
1477 if (fp != NULL)
1478 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001479 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001480 semsg(_(e_funcexts), global);
1481 return FAIL;
1482 }
1483
1484 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1485 if (fp == NULL)
1486 return FAIL;
1487
1488 fp->uf_varargs = ufunc->uf_varargs;
1489 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1490 fp->uf_def_status = ufunc->uf_def_status;
1491 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1492 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1493 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1494 == FAIL
1495 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1496 goto failed;
1497
1498 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1499 : vim_strsave(ufunc->uf_name_exp);
1500 if (ufunc->uf_arg_types != NULL)
1501 {
1502 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1503 if (fp->uf_arg_types == NULL)
1504 goto failed;
1505 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1506 sizeof(type_T *) * fp->uf_args.ga_len);
1507 }
1508 if (ufunc->uf_def_arg_idx != NULL)
1509 {
1510 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1511 if (fp->uf_def_arg_idx == NULL)
1512 goto failed;
1513 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1514 sizeof(int) * fp->uf_def_args.ga_len + 1);
1515 }
1516 if (ufunc->uf_va_name != NULL)
1517 {
1518 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1519 if (fp->uf_va_name == NULL)
1520 goto failed;
1521 }
1522 fp->uf_ret_type = ufunc->uf_ret_type;
1523
1524 fp->uf_refcount = 1;
1525 STRCPY(fp->uf_name, global);
1526 hash_add(&func_hashtab, UF2HIKEY(fp));
1527
1528 // the referenced dfunc_T is now used one more time
1529 link_def_function(fp);
1530
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001531 // Create a partial to store the context of the function where it was
1532 // instantiated. Only needs to be done once. Do this on the original
1533 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001534 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1535 {
1536 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1537
1538 if (pt == NULL)
1539 goto failed;
1540 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001541 {
1542 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001543 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001544 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001545 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001546 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001547 }
1548
1549 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001550
1551failed:
1552 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001553 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001554}
1555
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001556static int funcdepth = 0;
1557
1558/*
1559 * Increment the function call depth count.
1560 * Return FAIL when going over 'maxfuncdepth'.
1561 * Otherwise return OK, must call funcdepth_decrement() later!
1562 */
1563 int
1564funcdepth_increment(void)
1565{
1566 if (funcdepth >= p_mfd)
1567 {
1568 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1569 return FAIL;
1570 }
1571 ++funcdepth;
1572 return OK;
1573}
1574
1575 void
1576funcdepth_decrement(void)
1577{
1578 --funcdepth;
1579}
1580
1581/*
1582 * Get the current function call depth.
1583 */
1584 int
1585funcdepth_get(void)
1586{
1587 return funcdepth;
1588}
1589
1590/*
1591 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001592 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001593 * times as funcdepth_increment().
1594 */
1595 void
1596funcdepth_restore(int depth)
1597{
1598 funcdepth = depth;
1599}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001600
1601/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001602 * Call a user function.
1603 */
1604 static void
1605call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001606 ufunc_T *fp, // pointer to function
1607 int argcount, // nr of args
1608 typval_T *argvars, // arguments
1609 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001610 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001611 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001613 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001614 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 funccall_T *fc;
1616 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001617 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001619 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620 int i;
1621 int ai;
1622 int islambda = FALSE;
1623 char_u numbuf[NUMBUFLEN];
1624 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001626 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001628 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629
Bram Moolenaarb2049902021-01-24 12:53:53 +01001630#ifdef FEAT_PROFILE
1631 CLEAR_FIELD(profile_info);
1632#endif
1633
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001634 // If depth of calling is getting too high, don't execute the function.
1635 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 rettv->v_type = VAR_NUMBER;
1638 rettv->vval.v_number = -1;
1639 return;
1640 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001641
Bram Moolenaare38eab22019-12-05 21:50:01 +01001642 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001644 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001645 if (fc == NULL)
1646 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 fc->caller = current_funccal;
1648 current_funccal = fc;
1649 fc->func = fp;
1650 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001651 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001652 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1654 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001655 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001656 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001657 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001659 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001660 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01001661#ifdef FEAT_PROFILE
1662 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
1663#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001664 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01001665#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001666 if (do_profiling == PROF_YES)
1667 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01001668#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001669 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001670 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01001671#ifdef FEAT_PROFILE
1672 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01001673 || (caller != NULL && caller->uf_profiling)))
1674 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01001675#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001676 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001677 free_funccal(fc);
1678 return;
1679 }
1680
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1682 islambda = TRUE;
1683
1684 /*
1685 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1686 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1687 * each argument variable and saves a lot of time.
1688 */
1689 /*
1690 * Init l: variables.
1691 */
1692 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1693 if (selfdict != NULL)
1694 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001695 // Set l:self to "selfdict". Use "name" to avoid a warning from
1696 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 v = &fc->fixvar[fixvar_idx++].var;
1698 name = v->di_key;
1699 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001700 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1702 v->di_tv.v_type = VAR_DICT;
1703 v->di_tv.v_lock = 0;
1704 v->di_tv.vval.v_dict = selfdict;
1705 ++selfdict->dv_refcount;
1706 }
1707
1708 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001709 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001710 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001711 * Set a:000 to a list with room for the "..." arguments.
1712 */
1713 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001714 if ((fp->uf_flags & FC_NOARGS) == 0)
1715 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001716 (varnumber_T)(argcount >= fp->uf_args.ga_len
1717 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001718 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001719 if ((fp->uf_flags & FC_NOARGS) == 0)
1720 {
1721 // Use "name" to avoid a warning from some compiler that checks the
1722 // destination size.
1723 v = &fc->fixvar[fixvar_idx++].var;
1724 name = v->di_key;
1725 STRCPY(name, "000");
1726 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1727 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1728 v->di_tv.v_type = VAR_LIST;
1729 v->di_tv.v_lock = VAR_FIXED;
1730 v->di_tv.vval.v_list = &fc->l_varlist;
1731 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001732 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1734 fc->l_varlist.lv_lock = VAR_FIXED;
1735
1736 /*
1737 * Set a:firstline to "firstline" and a:lastline to "lastline".
1738 * Set a:name to named arguments.
1739 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001740 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001742 if ((fp->uf_flags & FC_NOARGS) == 0)
1743 {
1744 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001745 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001746 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001747 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001748 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001749 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 {
1751 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001752 typval_T def_rettv;
1753 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754
1755 ai = i - fp->uf_args.ga_len;
1756 if (ai < 0)
1757 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001758 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 name = FUNCARG(fp, i);
1760 if (islambda)
1761 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001762
1763 // evaluate named argument default expression
1764 isdefault = ai + fp->uf_def_args.ga_len >= 0
1765 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1766 && argvars[i].vval.v_number == VVAL_NONE));
1767 if (isdefault)
1768 {
1769 char_u *default_expr = NULL;
1770 def_rettv.v_type = VAR_NUMBER;
1771 def_rettv.vval.v_number = -1;
1772
1773 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1774 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001775 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001776 {
1777 default_arg_err = 1;
1778 break;
1779 }
1780 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781 }
1782 else
1783 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001784 if ((fp->uf_flags & FC_NOARGS) != 0)
1785 // Bail out if no a: arguments used (in lambda).
1786 break;
1787
Bram Moolenaare38eab22019-12-05 21:50:01 +01001788 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789 sprintf((char *)numbuf, "%d", ai + 1);
1790 name = numbuf;
1791 }
1792 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1793 {
1794 v = &fc->fixvar[fixvar_idx++].var;
1795 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001796 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001797 }
1798 else
1799 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001800 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801 if (v == NULL)
1802 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001803 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001806 // Note: the values are copied directly to avoid alloc/free.
1807 // "argvars" must have VAR_FIXED for v_lock.
1808 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001809 v->di_tv.v_lock = VAR_FIXED;
1810
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811 if (addlocal)
1812 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001813 // Named arguments should be accessed without the "a:" prefix in
1814 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001815 copy_tv(&v->di_tv, &v->di_tv);
1816 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001817 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001818 else
1819 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820
1821 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1822 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001823 listitem_T *li = &fc->l_listitems[ai];
1824
1825 li->li_tv = argvars[i];
1826 li->li_tv.v_lock = VAR_FIXED;
1827 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828 }
1829 }
1830
Bram Moolenaare38eab22019-12-05 21:50:01 +01001831 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001832 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001833
1834 if (fp->uf_flags & FC_SANDBOX)
1835 {
1836 using_sandbox = TRUE;
1837 ++sandbox;
1838 }
1839
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001840 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001841 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001842 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001844 ++no_wait_return;
1845 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001847 smsg(_("calling %s"), SOURCING_NAME);
1848 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001850 char_u buf[MSG_BUF_LEN];
1851 char_u numbuf2[NUMBUFLEN];
1852 char_u *tofree;
1853 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001855 msg_puts("(");
1856 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001857 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001858 if (i > 0)
1859 msg_puts(", ");
1860 if (argvars[i].v_type == VAR_NUMBER)
1861 msg_outnum((long)argvars[i].vval.v_number);
1862 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001863 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001864 // Do not want errors such as E724 here.
1865 ++emsg_off;
1866 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1867 --emsg_off;
1868 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001869 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001870 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001871 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001872 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1873 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001874 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001875 msg_puts((char *)s);
1876 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877 }
1878 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001879 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001880 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001881 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001882 msg_puts("\n"); // don't overwrite this either
1883
1884 verbose_leave_scroll();
1885 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001886 }
1887#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001888 if (do_profiling == PROF_YES)
1889 profile_may_start_func(&profile_info, fp,
1890 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001891#endif
1892
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001893 save_current_sctx = current_sctx;
1894 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001895 save_did_emsg = did_emsg;
1896 did_emsg = FALSE;
1897
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001898 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1899 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001900 else if (islambda)
1901 {
1902 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1903
1904 // A Lambda always has the command "return {expr}". It is much faster
1905 // to evaluate {expr} directly.
1906 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001907 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001908 --ex_nesting_level;
1909 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001910 else
1911 // call do_cmdline() to execute the lines
1912 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001913 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1914
1915 --RedrawingDisabled;
1916
Bram Moolenaare38eab22019-12-05 21:50:01 +01001917 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1919 {
1920 clear_tv(rettv);
1921 rettv->v_type = VAR_NUMBER;
1922 rettv->vval.v_number = -1;
1923 }
1924
1925#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001926 if (do_profiling == PROF_YES)
1927 {
1928 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
1929
1930 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
1931 profile_may_end_func(&profile_info, fp, caller);
1932 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001933#endif
1934
Bram Moolenaare38eab22019-12-05 21:50:01 +01001935 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001936 if (p_verbose >= 12)
1937 {
1938 ++no_wait_return;
1939 verbose_enter_scroll();
1940
1941 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001942 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001944 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945 (long)fc->rettv->vval.v_number);
1946 else
1947 {
1948 char_u buf[MSG_BUF_LEN];
1949 char_u numbuf2[NUMBUFLEN];
1950 char_u *tofree;
1951 char_u *s;
1952
Bram Moolenaare38eab22019-12-05 21:50:01 +01001953 // The value may be very long. Skip the middle part, so that we
1954 // have some idea how it starts and ends. smsg() would always
1955 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956 ++emsg_off;
1957 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1958 --emsg_off;
1959 if (s != NULL)
1960 {
1961 if (vim_strsize(s) > MSG_BUF_CLEN)
1962 {
1963 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1964 s = buf;
1965 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001966 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967 vim_free(tofree);
1968 }
1969 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001970 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001971
1972 verbose_leave_scroll();
1973 --no_wait_return;
1974 }
1975
Bram Moolenaare31ee862020-01-07 20:59:34 +01001976 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001977 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001978 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001979#ifdef FEAT_PROFILE
1980 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01001981 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001982#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001983 if (using_sandbox)
1984 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001985
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001986 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001987 {
1988 ++no_wait_return;
1989 verbose_enter_scroll();
1990
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001991 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001992 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001993
1994 verbose_leave_scroll();
1995 --no_wait_return;
1996 }
1997
1998 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001999 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002000 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002001}
2002
2003/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002004 * Check the argument count for user function "fp".
2005 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2006 */
2007 int
2008check_user_func_argcount(ufunc_T *fp, int argcount)
2009{
2010 int regular_args = fp->uf_args.ga_len;
2011
2012 if (argcount < regular_args - fp->uf_def_args.ga_len)
2013 return FCERR_TOOFEW;
2014 else if (!has_varargs(fp) && argcount > regular_args)
2015 return FCERR_TOOMANY;
2016 return FCERR_UNKNOWN;
2017}
2018
2019/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002020 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002021 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002022 int
2023call_user_func_check(
2024 ufunc_T *fp,
2025 int argcount,
2026 typval_T *argvars,
2027 typval_T *rettv,
2028 funcexe_T *funcexe,
2029 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002030{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002032
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002033 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2034 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002035 error = check_user_func_argcount(fp, argcount);
2036 if (error != FCERR_UNKNOWN)
2037 return error;
2038 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002039 error = FCERR_DICT;
2040 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002041 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002042 int did_save_redo = FALSE;
2043 save_redo_T save_redo;
2044
2045 /*
2046 * Call the user function.
2047 * Save and restore search patterns, script variables and
2048 * redo buffer.
2049 */
2050 save_search_patterns();
2051 if (!ins_compl_active())
2052 {
2053 saveRedobuff(&save_redo);
2054 did_save_redo = TRUE;
2055 }
2056 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002057 call_user_func(fp, argcount, argvars, rettv, funcexe,
2058 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002059 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2060 // Function was unreferenced while being used, free it now.
2061 func_clear_free(fp, FALSE);
2062 if (did_save_redo)
2063 restoreRedobuff(&save_redo);
2064 restore_search_patterns();
2065 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002066 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002067 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002068}
2069
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002070static funccal_entry_T *funccal_stack = NULL;
2071
2072/*
2073 * Save the current function call pointer, and set it to NULL.
2074 * Used when executing autocommands and for ":source".
2075 */
2076 void
2077save_funccal(funccal_entry_T *entry)
2078{
2079 entry->top_funccal = current_funccal;
2080 entry->next = funccal_stack;
2081 funccal_stack = entry;
2082 current_funccal = NULL;
2083}
2084
2085 void
2086restore_funccal(void)
2087{
2088 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002089 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002090 else
2091 {
2092 current_funccal = funccal_stack->top_funccal;
2093 funccal_stack = funccal_stack->next;
2094 }
2095}
2096
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002097 funccall_T *
2098get_current_funccal(void)
2099{
2100 return current_funccal;
2101}
2102
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002103/*
2104 * Mark all functions of script "sid" as deleted.
2105 */
2106 void
2107delete_script_functions(int sid)
2108{
2109 hashitem_T *hi;
2110 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002111 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002112 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002113 size_t len;
2114
2115 buf[0] = K_SPECIAL;
2116 buf[1] = KS_EXTRA;
2117 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002118 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002119 len = STRLEN(buf);
2120
Bram Moolenaarce658352020-07-31 23:47:12 +02002121 while (todo > 0)
2122 {
2123 todo = func_hashtab.ht_used;
2124 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2125 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002126 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002127 fp = HI2UF(hi);
2128 if (STRNCMP(fp->uf_name, buf, len) == 0)
2129 {
2130 int changed = func_hashtab.ht_changed;
2131
2132 fp->uf_flags |= FC_DEAD;
2133 func_clear(fp, TRUE);
2134 // When clearing a function another function can be cleared
2135 // as a side effect. When that happens start over.
2136 if (changed != func_hashtab.ht_changed)
2137 break;
2138 }
2139 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002140 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002141 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002142}
2143
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002144#if defined(EXITFREE) || defined(PROTO)
2145 void
2146free_all_functions(void)
2147{
2148 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002149 ufunc_T *fp;
2150 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002151 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002152 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153
Bram Moolenaare38eab22019-12-05 21:50:01 +01002154 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002155 while (current_funccal != NULL)
2156 {
2157 clear_tv(current_funccal->rettv);
2158 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002159 if (current_funccal == NULL && funccal_stack != NULL)
2160 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002161 }
2162
Bram Moolenaare38eab22019-12-05 21:50:01 +01002163 // First clear what the functions contain. Since this may lower the
2164 // reference count of a function, it may also free a function and change
2165 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002166 while (todo > 0)
2167 {
2168 todo = func_hashtab.ht_used;
2169 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2170 if (!HASHITEM_EMPTY(hi))
2171 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002172 // clear the def function index now
2173 fp = HI2UF(hi);
2174 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002175 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002176
Bram Moolenaare38eab22019-12-05 21:50:01 +01002177 // Only free functions that are not refcounted, those are
2178 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002179 if (func_name_refcount(fp->uf_name))
2180 ++skipped;
2181 else
2182 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002183 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002184 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002185 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002186 {
2187 skipped = 0;
2188 break;
2189 }
2190 }
2191 --todo;
2192 }
2193 }
2194
Bram Moolenaare38eab22019-12-05 21:50:01 +01002195 // Now actually free the functions. Need to start all over every time,
2196 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002197 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002198 while (func_hashtab.ht_used > skipped)
2199 {
2200 todo = func_hashtab.ht_used;
2201 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002202 if (!HASHITEM_EMPTY(hi))
2203 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002204 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002205 // Only free functions that are not refcounted, those are
2206 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002207 fp = HI2UF(hi);
2208 if (func_name_refcount(fp->uf_name))
2209 ++skipped;
2210 else
2211 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002212 if (func_free(fp, FALSE) == OK)
2213 {
2214 skipped = 0;
2215 break;
2216 }
2217 // did not actually free it
2218 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002219 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002220 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002221 }
2222 if (skipped == 0)
2223 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002224
2225 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226}
2227#endif
2228
2229/*
2230 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002231 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232 * "len" is the length of "name", or -1 for NUL terminated.
2233 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002234 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002235builtin_function(char_u *name, int len)
2236{
2237 char_u *p;
2238
Bram Moolenaara26b9702020-04-18 19:53:28 +02002239 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002240 return FALSE;
2241 p = vim_strchr(name, AUTOLOAD_CHAR);
2242 return p == NULL || (len > 0 && p > name + len);
2243}
2244
2245 int
2246func_call(
2247 char_u *name,
2248 typval_T *args,
2249 partial_T *partial,
2250 dict_T *selfdict,
2251 typval_T *rettv)
2252{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002253 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002254 listitem_T *item;
2255 typval_T argv[MAX_FUNC_ARGS + 1];
2256 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002257 int r = 0;
2258
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002259 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002260 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002261 {
2262 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2263 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002264 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 break;
2266 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002267 // Make a copy of each argument. This is needed to be able to set
2268 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 copy_tv(&item->li_tv, &argv[argc++]);
2270 }
2271
2272 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002273 {
2274 funcexe_T funcexe;
2275
Bram Moolenaara80faa82020-04-12 19:37:17 +02002276 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002277 funcexe.firstline = curwin->w_cursor.lnum;
2278 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002279 funcexe.evaluate = TRUE;
2280 funcexe.partial = partial;
2281 funcexe.selfdict = selfdict;
2282 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2283 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284
Bram Moolenaare38eab22019-12-05 21:50:01 +01002285 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 while (argc > 0)
2287 clear_tv(&argv[--argc]);
2288
2289 return r;
2290}
2291
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002292static int callback_depth = 0;
2293
2294 int
2295get_callback_depth(void)
2296{
2297 return callback_depth;
2298}
2299
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002300/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002301 * Invoke call_func() with a callback.
2302 */
2303 int
2304call_callback(
2305 callback_T *callback,
2306 int len, // length of "name" or -1 to use strlen()
2307 typval_T *rettv, // return value goes here
2308 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002309 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002310 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002311{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002312 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002313 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002314
Bram Moolenaara80faa82020-04-12 19:37:17 +02002315 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002316 funcexe.evaluate = TRUE;
2317 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002318 ++callback_depth;
2319 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2320 --callback_depth;
2321 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002322}
2323
2324/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002325 * Give an error message for the result of a function.
2326 * Nothing if "error" is FCERR_NONE.
2327 */
2328 void
2329user_func_error(int error, char_u *name)
2330{
2331 switch (error)
2332 {
2333 case FCERR_UNKNOWN:
2334 emsg_funcname(e_unknownfunc, name);
2335 break;
2336 case FCERR_NOTMETHOD:
2337 emsg_funcname(
2338 N_("E276: Cannot use function as a method: %s"), name);
2339 break;
2340 case FCERR_DELETED:
2341 emsg_funcname(N_(e_func_deleted), name);
2342 break;
2343 case FCERR_TOOMANY:
2344 emsg_funcname((char *)e_toomanyarg, name);
2345 break;
2346 case FCERR_TOOFEW:
2347 emsg_funcname((char *)e_toofewarg, name);
2348 break;
2349 case FCERR_SCRIPT:
2350 emsg_funcname(
2351 N_("E120: Using <SID> not in a script context: %s"), name);
2352 break;
2353 case FCERR_DICT:
2354 emsg_funcname(
2355 N_("E725: Calling dict function without Dictionary: %s"),
2356 name);
2357 break;
2358 }
2359}
2360
2361/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002363 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364 * Return FAIL when the function can't be called, OK otherwise.
2365 * Also returns OK when an error was encountered while executing the function.
2366 */
2367 int
2368call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002369 char_u *funcname, // name of the function
2370 int len, // length of "name" or -1 to use strlen()
2371 typval_T *rettv, // return value goes here
2372 int argcount_in, // number of "argvars"
2373 typval_T *argvars_in, // vars for arguments, must have "argcount"
2374 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002375 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376{
2377 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002378 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002380 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381 char_u fname_buf[FLEN_FIXED + 1];
2382 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002383 char_u *fname = NULL;
2384 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 int argcount = argcount_in;
2386 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002387 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002388 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2389 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002391 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002392 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002394 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2395 // even when call_func() returns FAIL.
2396 rettv->v_type = VAR_UNKNOWN;
2397
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002398 if (partial != NULL)
2399 fp = partial->pt_func;
2400 if (fp == NULL)
2401 {
2402 // Make a copy of the name, if it comes from a funcref variable it
2403 // could be changed or deleted in the called function.
2404 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2405 if (name == NULL)
2406 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002408 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2409 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002411 if (funcexe->doesrange != NULL)
2412 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002413
2414 if (partial != NULL)
2415 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002416 // When the function has a partial with a dict and there is a dict
2417 // argument, use the dict argument. That is backwards compatible.
2418 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002419 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002421 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 {
2423 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002424 {
2425 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2426 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002427 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002428 goto theend;
2429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432 for (i = 0; i < argcount_in; ++i)
2433 argv[i + argv_clear] = argvars_in[i];
2434 argvars = argv;
2435 argcount = partial->pt_argc + argcount_in;
2436 }
2437 }
2438
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002439 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2440 {
2441 // Check that the argument types are OK for the types of the funcref.
2442 if (check_argument_types(funcexe->check_type, argvars, argcount,
2443 name) == FAIL)
2444 error = FCERR_OTHER;
2445 }
2446
Bram Moolenaaref140542019-12-31 21:27:13 +01002447 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 {
2449 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002450 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451
Bram Moolenaar333894b2020-08-01 18:53:07 +02002452 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002453 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002454 {
2455 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002456 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458
Bram Moolenaare38eab22019-12-05 21:50:01 +01002459 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002461 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002462
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002463 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464 {
2465 /*
2466 * User defined function.
2467 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002468 if (fp == NULL)
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 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472 if (fp == NULL
2473 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002474 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 && !aborting())
2476 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002477 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002478 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002480 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2482 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002483 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002484 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002486 if (fp == NULL)
2487 {
2488 char_u *p = untrans_function_name(rfname);
2489
2490 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002491 // Don't do this if the name starts with "s:".
2492 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002493 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002494 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002496 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002497 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002498#ifdef FEAT_LUA
2499 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2500 {
2501 cfunc_T cb = fp->uf_cb;
2502
2503 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2504 }
2505#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002506 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002508 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002509 // postponed filling in the arguments, do it now
2510 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002511 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002512
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002513 if (funcexe->basetv != NULL)
2514 {
2515 // Method call: base->Method()
2516 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2517 argv[0] = *funcexe->basetv;
2518 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002519 argvars = argv;
2520 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002521 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002522
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002523 error = call_user_func_check(fp, argcount, argvars, rettv,
2524 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 }
2526 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002527 else if (funcexe->basetv != NULL)
2528 {
2529 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002530 * expr->method(): Find the method name in the table, call its
2531 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002532 */
2533 error = call_internal_method(fname, argcount, argvars, rettv,
2534 funcexe->basetv);
2535 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 else
2537 {
2538 /*
2539 * Find the function name in the table, call its implementation.
2540 */
2541 error = call_internal_func(fname, argcount, argvars, rettv);
2542 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002543
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 /*
2545 * The function call (or "FuncUndefined" autocommand sequence) might
2546 * have been aborted by an error, an interrupt, or an explicitly thrown
2547 * exception that has not been caught so far. This situation can be
2548 * tested for by calling aborting(). For an error in an internal
2549 * function or for the "E132" error in call_user_func(), however, the
2550 * throw point at which the "force_abort" flag (temporarily reset by
2551 * emsg()) is normally updated has not been reached yet. We need to
2552 * update that flag first to make aborting() reliable.
2553 */
2554 update_force_abort();
2555 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002556 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 ret = OK;
2558
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002559theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002560 /*
2561 * Report an error unless the argument evaluation or function call has been
2562 * cancelled due to an aborting error, an interrupt, or an exception.
2563 */
2564 if (!aborting())
2565 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002566 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002567 }
2568
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002569 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002571 clear_tv(&argv[--argv_clear + argv_base]);
2572
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 vim_free(tofree);
2574 vim_free(name);
2575
2576 return ret;
2577}
2578
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002579 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002580printable_func_name(ufunc_T *fp)
2581{
2582 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2583}
2584
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002586 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 */
2588 static void
2589list_func_head(ufunc_T *fp, int indent)
2590{
2591 int j;
2592
2593 msg_start();
2594 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002595 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002596 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002597 msg_puts("def ");
2598 else
2599 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002600 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 msg_putchar('(');
2602 for (j = 0; j < fp->uf_args.ga_len; ++j)
2603 {
2604 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002605 msg_puts(", ");
2606 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002607 if (fp->uf_arg_types != NULL)
2608 {
2609 char *tofree;
2610
2611 msg_puts(": ");
2612 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2613 vim_free(tofree);
2614 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002615 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2616 {
2617 msg_puts(" = ");
2618 msg_puts(((char **)(fp->uf_def_args.ga_data))
2619 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2620 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 }
2622 if (fp->uf_varargs)
2623 {
2624 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002625 msg_puts(", ");
2626 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002627 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002628 if (fp->uf_va_name != NULL)
2629 {
2630 if (j)
2631 msg_puts(", ");
2632 msg_puts("...");
2633 msg_puts((char *)fp->uf_va_name);
2634 if (fp->uf_va_type)
2635 {
2636 char *tofree;
2637
2638 msg_puts(": ");
2639 msg_puts(type_name(fp->uf_va_type, &tofree));
2640 vim_free(tofree);
2641 }
2642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002644
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002645 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002646 {
2647 if (fp->uf_ret_type != &t_void)
2648 {
2649 char *tofree;
2650
2651 msg_puts(": ");
2652 msg_puts(type_name(fp->uf_ret_type, &tofree));
2653 vim_free(tofree);
2654 }
2655 }
2656 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002657 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002659 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002661 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002662 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002663 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 msg_clr_eos();
2665 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002666 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667}
2668
2669/*
2670 * Get a function name, translating "<SID>" and "<SNR>".
2671 * Also handles a Funcref in a List or Dictionary.
2672 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002673 * Set "*is_global" to TRUE when the function must be global, unless
2674 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 * flags:
2676 * TFN_INT: internal function name OK
2677 * TFN_QUIET: be quiet
2678 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002679 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680 * Advances "pp" to just after the function name (if no error).
2681 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002682 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683trans_function_name(
2684 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002685 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002686 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002688 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002689 partial_T **partial, // return: partial of a FuncRef
2690 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691{
2692 char_u *name = NULL;
2693 char_u *start;
2694 char_u *end;
2695 int lead;
2696 char_u sid_buf[20];
2697 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002698 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002700 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002701 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702
2703 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002704 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 start = *pp;
2706
Bram Moolenaare38eab22019-12-05 21:50:01 +01002707 // Check for hard coded <SNR>: already translated function ID (from a user
2708 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2710 && (*pp)[2] == (int)KE_SNR)
2711 {
2712 *pp += 3;
2713 len = get_id_len(pp) + 3;
2714 return vim_strnsave(start, len);
2715 }
2716
Bram Moolenaare38eab22019-12-05 21:50:01 +01002717 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2718 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 lead = eval_fname_script(start);
2720 if (lead > 2)
2721 start += lead;
2722
Bram Moolenaare38eab22019-12-05 21:50:01 +01002723 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002724 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 lead > 2 ? 0 : FNE_CHECK_START);
2726 if (end == start)
2727 {
2728 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002729 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 goto theend;
2731 }
2732 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2733 {
2734 /*
2735 * Report an invalid expression in braces, unless the expression
2736 * evaluation has been cancelled due to an aborting error, an
2737 * interrupt, or an exception.
2738 */
2739 if (!aborting())
2740 {
2741 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002742 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 }
2744 else
2745 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2746 goto theend;
2747 }
2748
2749 if (lv.ll_tv != NULL)
2750 {
2751 if (fdp != NULL)
2752 {
2753 fdp->fd_dict = lv.ll_dict;
2754 fdp->fd_newkey = lv.ll_newkey;
2755 lv.ll_newkey = NULL;
2756 fdp->fd_di = lv.ll_di;
2757 }
2758 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2759 {
2760 name = vim_strsave(lv.ll_tv->vval.v_string);
2761 *pp = end;
2762 }
2763 else if (lv.ll_tv->v_type == VAR_PARTIAL
2764 && lv.ll_tv->vval.v_partial != NULL)
2765 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002766 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 *pp = end;
2768 if (partial != NULL)
2769 *partial = lv.ll_tv->vval.v_partial;
2770 }
2771 else
2772 {
2773 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2774 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002775 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 else
2777 *pp = end;
2778 name = NULL;
2779 }
2780 goto theend;
2781 }
2782
2783 if (lv.ll_name == NULL)
2784 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002785 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 *pp = end;
2787 goto theend;
2788 }
2789
Bram Moolenaare38eab22019-12-05 21:50:01 +01002790 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791 if (lv.ll_exp_name != NULL)
2792 {
2793 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002794 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 flags & TFN_NO_AUTOLOAD);
2796 if (name == lv.ll_exp_name)
2797 name = NULL;
2798 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002799 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 {
2801 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002802 name = deref_func_name(*pp, &len, partial, type,
2803 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 if (name == *pp)
2805 name = NULL;
2806 }
2807 if (name != NULL)
2808 {
2809 name = vim_strsave(name);
2810 *pp = end;
2811 if (STRNCMP(name, "<SNR>", 5) == 0)
2812 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002813 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 name[0] = K_SPECIAL;
2815 name[1] = KS_EXTRA;
2816 name[2] = (int)KE_SNR;
2817 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2818 }
2819 goto theend;
2820 }
2821
2822 if (lv.ll_exp_name != NULL)
2823 {
2824 len = (int)STRLEN(lv.ll_exp_name);
2825 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2826 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2827 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002828 // When there was "s:" already or the name expanded to get a
2829 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830 lv.ll_name += 2;
2831 len -= 2;
2832 lead = 2;
2833 }
2834 }
2835 else
2836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002837 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002839 {
2840 if (is_global != NULL && lv.ll_name[0] == 'g')
2841 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002843 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 len = (int)(end - lv.ll_name);
2845 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002846 if (len <= 0)
2847 {
2848 if (!skip)
2849 emsg(_(e_function_name));
2850 goto theend;
2851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002853 // In Vim9 script a user function is script-local by default, unless it
2854 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002855 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002856 if (vim9script)
2857 {
2858 char_u *p;
2859
2860 // SomeScript#func() is a global function.
2861 for (p = start; *p != NUL && *p != '('; ++p)
2862 if (*p == AUTOLOAD_CHAR)
2863 vim9script = FALSE;
2864 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002865
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 /*
2867 * Copy the function name to allocated memory.
2868 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2869 * Accept <SNR>123_name() outside a script.
2870 */
2871 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002872 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002873 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002875 if (!vim9script)
2876 lead = 3;
2877 if (vim9script || (lv.ll_exp_name != NULL
2878 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002879 || eval_fname_sid(*pp))
2880 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002882 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002884 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002885 goto theend;
2886 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002887 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002888 if (vim9script)
2889 extra = 3 + (int)STRLEN(sid_buf);
2890 else
2891 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892 }
2893 }
2894 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2895 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002896 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897 start);
2898 goto theend;
2899 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002900 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 {
2902 char_u *cp = vim_strchr(lv.ll_name, ':');
2903
2904 if (cp != NULL && cp < end)
2905 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002906 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 goto theend;
2908 }
2909 }
2910
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002911 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912 if (name != NULL)
2913 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002914 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 {
2916 name[0] = K_SPECIAL;
2917 name[1] = KS_EXTRA;
2918 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002919 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 STRCPY(name + 3, sid_buf);
2921 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002922 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2923 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 }
2925 *pp = end;
2926
2927theend:
2928 clear_lval(&lv);
2929 return name;
2930}
2931
2932/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002933 * Assuming "name" is the result of trans_function_name() and it was prefixed
2934 * to use the script-local name, return the unmodified name (points into
2935 * "name"). Otherwise return NULL.
2936 * This can be used to first search for a script-local function and fall back
2937 * to the global function if not found.
2938 */
2939 char_u *
2940untrans_function_name(char_u *name)
2941{
2942 char_u *p;
2943
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002944 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002945 {
2946 p = vim_strchr(name, '_');
2947 if (p != NULL)
2948 return p + 1;
2949 }
2950 return NULL;
2951}
2952
2953/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002954 * List functions. When "regmatch" is NULL all of then.
2955 * Otherwise functions matching "regmatch".
2956 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002957 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002958list_functions(regmatch_T *regmatch)
2959{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002960 int changed = func_hashtab.ht_changed;
2961 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002962 hashitem_T *hi;
2963
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002964 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002965 {
2966 if (!HASHITEM_EMPTY(hi))
2967 {
2968 ufunc_T *fp = HI2UF(hi);
2969
2970 --todo;
2971 if ((fp->uf_flags & FC_DEAD) == 0
2972 && (regmatch == NULL
2973 ? !message_filtered(fp->uf_name)
2974 && !func_name_refcount(fp->uf_name)
2975 : !isdigit(*fp->uf_name)
2976 && vim_regexec(regmatch, fp->uf_name, 0)))
2977 {
2978 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002979 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002980 {
2981 emsg(_("E454: function list was modified"));
2982 return;
2983 }
2984 }
2985 }
2986 }
2987}
2988
2989/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002990 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2991 * return TRUE.
2992 * Otherwise return FALSE;
2993 * Do not consider "function(" to be a command.
2994 */
2995 static int
2996is_function_cmd(char_u **cmd)
2997{
2998 char_u *p = *cmd;
2999
3000 if (checkforcmd(&p, "function", 2))
3001 {
3002 if (*p == '(')
3003 return FALSE;
3004 *cmd = p;
3005 return TRUE;
3006 }
3007 return FALSE;
3008}
3009
3010/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003011 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003012 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3013 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003014 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003015 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003016 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003017define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018{
3019 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003020 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021 int j;
3022 int c;
3023 int saved_did_emsg;
3024 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003025 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003026 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027 char_u *p;
3028 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003029 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 char_u *line_arg = NULL;
3031 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003032 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003033 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 garray_T newlines;
3035 int varargs = FALSE;
3036 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003037 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003038 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003039 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003040 int indent;
3041 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003042#define MAX_FUNC_NESTING 50
3043 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044 dictitem_T *v;
3045 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003046 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003049 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003050 linenr_T sourcing_lnum_off;
3051 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003052 int is_heredoc = FALSE;
3053 char_u *skip_until = NULL;
3054 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003055 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003056 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057
3058 /*
3059 * ":function" without argument: list functions.
3060 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003061 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 {
3063 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003064 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003065 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003066 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003067 }
3068
3069 /*
3070 * ":function /pat": list functions matching pattern.
3071 */
3072 if (*eap->arg == '/')
3073 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003074 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003075 if (!eap->skip)
3076 {
3077 regmatch_T regmatch;
3078
3079 c = *p;
3080 *p = NUL;
3081 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3082 *p = c;
3083 if (regmatch.regprog != NULL)
3084 {
3085 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003086 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 vim_regfree(regmatch.regprog);
3088 }
3089 }
3090 if (*p == '/')
3091 ++p;
3092 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003093 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094 }
3095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003096 ga_init(&newargs);
3097 ga_init(&argtypes);
3098 ga_init(&default_args);
3099
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003100 /*
3101 * Get the function name. There are these situations:
3102 * func normal function name
3103 * "name" == func, "fudi.fd_dict" == NULL
3104 * dict.func new dictionary entry
3105 * "name" == NULL, "fudi.fd_dict" set,
3106 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3107 * dict.func existing dict entry with a Funcref
3108 * "name" == func, "fudi.fd_dict" set,
3109 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3110 * dict.func existing dict entry that's not a Funcref
3111 * "name" == NULL, "fudi.fd_dict" set,
3112 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3113 * s:func script-local function name
3114 * g:func global function name, same as "func"
3115 */
3116 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003117 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003119 // nested function, argument is (args).
3120 paren = TRUE;
3121 CLEAR_FIELD(fudi);
3122 }
3123 else
3124 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003125 if (STRNCMP(p, "<lambda>", 8) == 0)
3126 {
3127 p += 8;
3128 (void)getdigits(&p);
3129 name = vim_strnsave(eap->arg, p - eap->arg);
3130 CLEAR_FIELD(fudi);
3131 }
3132 else
3133 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003134 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003135 paren = (vim_strchr(p, '(') != NULL);
3136 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003137 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003138 /*
3139 * Return on an invalid expression in braces, unless the expression
3140 * evaluation has been cancelled due to an aborting error, an
3141 * interrupt, or an exception.
3142 */
3143 if (!aborting())
3144 {
3145 if (!eap->skip && fudi.fd_newkey != NULL)
3146 semsg(_(e_dictkey), fudi.fd_newkey);
3147 vim_free(fudi.fd_newkey);
3148 return NULL;
3149 }
3150 else
3151 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003153 }
3154
Bram Moolenaare38eab22019-12-05 21:50:01 +01003155 // An error in a function call during evaluation of an expression in magic
3156 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 saved_did_emsg = did_emsg;
3158 did_emsg = FALSE;
3159
3160 /*
3161 * ":function func" with only function name: list function.
3162 */
3163 if (!paren)
3164 {
3165 if (!ends_excmd(*skipwhite(p)))
3166 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003167 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003168 goto ret_free;
3169 }
3170 eap->nextcmd = check_nextcmd(p);
3171 if (eap->nextcmd != NULL)
3172 *p = NUL;
3173 if (!eap->skip && !got_int)
3174 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003175 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003176 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3177 {
3178 char_u *up = untrans_function_name(name);
3179
3180 // With Vim9 script the name was made script-local, if not
3181 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003182 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003183 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003184 }
3185
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 if (fp != NULL)
3187 {
3188 list_func_head(fp, TRUE);
3189 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3190 {
3191 if (FUNCLINE(fp, j) == NULL)
3192 continue;
3193 msg_putchar('\n');
3194 msg_outnum((long)(j + 1));
3195 if (j < 9)
3196 msg_putchar(' ');
3197 if (j < 99)
3198 msg_putchar(' ');
3199 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003200 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 ui_breakcheck();
3202 }
3203 if (!got_int)
3204 {
3205 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003206 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003207 msg_puts(" enddef");
3208 else
3209 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 }
3211 }
3212 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003213 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 }
3215 goto ret_free;
3216 }
3217
3218 /*
3219 * ":function name(arg1, arg2)" Define function.
3220 */
3221 p = skipwhite(p);
3222 if (*p != '(')
3223 {
3224 if (!eap->skip)
3225 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003226 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227 goto ret_free;
3228 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 if (vim_strchr(p, '(') != NULL)
3231 p = vim_strchr(p, '(');
3232 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003234 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3235 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003236 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003237 goto ret_free;
3238 }
3239
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003240 // In Vim9 script only global functions can be redefined.
3241 if (vim9script && eap->forceit && !is_global)
3242 {
3243 emsg(_(e_nobang));
3244 goto ret_free;
3245 }
3246
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3248
Bram Moolenaar04b12692020-05-04 23:24:44 +02003249 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003251 // Check the name of the function. Unless it's a dictionary function
3252 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 if (name != NULL)
3254 arg = name;
3255 else
3256 arg = fudi.fd_newkey;
3257 if (arg != NULL && (fudi.fd_di == NULL
3258 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3259 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3260 {
3261 if (*arg == K_SPECIAL)
3262 j = 3;
3263 else
3264 j = 0;
3265 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3266 : eval_isnamec(arg[j])))
3267 ++j;
3268 if (arg[j] != NUL)
3269 emsg_funcname((char *)e_invarg2, arg);
3270 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003271 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003272 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003273 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 }
3275
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003276 // This may get more lines and make the pointers into the first line
3277 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003278 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003280 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003281 &varargs, &default_args, eap->skip,
3282 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003283 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003284 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003286 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 // find the return type: :def Func(): type
3289 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003290 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003291 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003292 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003294 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003295 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003296 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003297 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003298 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003300 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003301 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003302 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003305 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307 else
3308 // find extra arguments "range", "dict", "abort" and "closure"
3309 for (;;)
3310 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003311 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003312 p = skipwhite(p);
3313 if (STRNCMP(p, "range", 5) == 0)
3314 {
3315 flags |= FC_RANGE;
3316 p += 5;
3317 }
3318 else if (STRNCMP(p, "dict", 4) == 0)
3319 {
3320 flags |= FC_DICT;
3321 p += 4;
3322 }
3323 else if (STRNCMP(p, "abort", 5) == 0)
3324 {
3325 flags |= FC_ABORT;
3326 p += 5;
3327 }
3328 else if (STRNCMP(p, "closure", 7) == 0)
3329 {
3330 flags |= FC_CLOSURE;
3331 p += 7;
3332 if (current_funccal == NULL)
3333 {
3334 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3335 name == NULL ? (char_u *)"" : name);
3336 goto erret;
3337 }
3338 }
3339 else
3340 break;
3341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342
Bram Moolenaare38eab22019-12-05 21:50:01 +01003343 // When there is a line break use what follows for the function body.
3344 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 if (*p == '\n')
3346 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003347 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003348 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3349 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003350 && !(VIM_ISWHITE(*whitep) && *p == '#'
3351 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003352 && !eap->skip
3353 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003354 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355
3356 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003357 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3358 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 */
3360 if (KeyTyped)
3361 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003362 // Check if the function already exists, don't let the user type the
3363 // whole function before telling him it doesn't work! For a script we
3364 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365 if (!eap->skip && !eap->forceit)
3366 {
3367 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003368 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003369 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 emsg_funcname(e_funcexts, name);
3371 }
3372
3373 if (!eap->skip && did_emsg)
3374 goto erret;
3375
Bram Moolenaare38eab22019-12-05 21:50:01 +01003376 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 cmdline_row = msg_row;
3378 }
3379
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003380 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003381 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003382
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003383 // Detect having skipped over comment lines to find the return
3384 // type. Add NULL lines to keep the line count correct.
3385 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3386 if (SOURCING_LNUM < sourcing_lnum_off)
3387 {
3388 sourcing_lnum_off -= SOURCING_LNUM;
3389 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3390 goto erret;
3391 while (sourcing_lnum_off-- > 0)
3392 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3393 }
3394
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395 indent = 2;
3396 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003397 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003398 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003399 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 for (;;)
3401 {
3402 if (KeyTyped)
3403 {
3404 msg_scroll = TRUE;
3405 saved_wait_return = FALSE;
3406 }
3407 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408
3409 if (line_arg != NULL)
3410 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003411 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412 theline = line_arg;
3413 p = vim_strchr(theline, '\n');
3414 if (p == NULL)
3415 line_arg += STRLEN(line_arg);
3416 else
3417 {
3418 *p = NUL;
3419 line_arg = p + 1;
3420 }
3421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003423 {
3424 vim_free(line_to_free);
3425 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003426 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003427 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003428 theline = eap->getline(':', eap->cookie, indent,
3429 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003430 line_to_free = theline;
3431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 if (KeyTyped)
3433 lines_left = Rows - 1;
3434 if (theline == NULL)
3435 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003436 // Use the start of the function for the line number.
3437 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003438 if (skip_until != NULL)
3439 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3440 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003441 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003442 else
3443 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 goto erret;
3445 }
3446
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003447 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003448 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003449 if (SOURCING_LNUM < sourcing_lnum_off)
3450 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003451 else
3452 sourcing_lnum_off = 0;
3453
3454 if (skip_until != NULL)
3455 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003456 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003457 // * ":append" and "."
3458 // * ":python <<EOF" and "EOF"
3459 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3460 if (heredoc_trimmed == NULL
3461 || (is_heredoc && skipwhite(theline) == theline)
3462 || STRNCMP(theline, heredoc_trimmed,
3463 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003464 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003465 if (heredoc_trimmed == NULL)
3466 p = theline;
3467 else if (is_heredoc)
3468 p = skipwhite(theline) == theline
3469 ? theline : theline + STRLEN(heredoc_trimmed);
3470 else
3471 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003472 if (STRCMP(p, skip_until) == 0)
3473 {
3474 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003475 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003476 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003477 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003478 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003479 }
3480 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003481 }
3482 else
3483 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003484 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003485 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 ;
3487
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003488 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003489 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003490 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003491 ? "enddef" : "endfunction", 4)
3492 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003494 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003495 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003496 char_u *nextcmd = NULL;
3497
3498 if (*p == '|')
3499 nextcmd = p + 1;
3500 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3501 nextcmd = line_arg;
3502 else if (*p != NUL && *p != '"' && p_verbose > 0)
3503 give_warning2(eap->cmdidx == CMD_def
3504 ? (char_u *)_("W1001: Text found after :enddef: %s")
3505 : (char_u *)_("W22: Text found after :endfunction: %s"),
3506 p, TRUE);
3507 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003508 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003509 // Another command follows. If the line came from "eap"
3510 // we can simply point into it, otherwise we need to
3511 // change "eap->cmdlinep".
3512 eap->nextcmd = nextcmd;
3513 if (line_to_free != NULL)
3514 {
3515 vim_free(*eap->cmdlinep);
3516 *eap->cmdlinep = line_to_free;
3517 line_to_free = NULL;
3518 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003519 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003520 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003521 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003522 }
3523
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003524 // Check for mismatched "endfunc" or "enddef".
3525 // We don't check for "def" inside "func" thus we also can't check
3526 // for "enddef".
3527 // We continue to find the end of the function, although we might
3528 // not find it.
3529 else if (nesting_def[nesting])
3530 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003531 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003532 emsg(_(e_mismatched_endfunction));
3533 }
3534 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3535 emsg(_(e_mismatched_enddef));
3536
Bram Moolenaare38eab22019-12-05 21:50:01 +01003537 // Increase indent inside "if", "while", "for" and "try", decrease
3538 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003539 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540 indent -= 2;
3541 else if (STRNCMP(p, "if", 2) == 0
3542 || STRNCMP(p, "wh", 2) == 0
3543 || STRNCMP(p, "for", 3) == 0
3544 || STRNCMP(p, "try", 3) == 0)
3545 indent += 2;
3546
Bram Moolenaare38eab22019-12-05 21:50:01 +01003547 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003548 // Only recognize "def" inside "def", not inside "function",
3549 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003550 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003551 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003552 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 {
3554 if (*p == '!')
3555 p = skipwhite(p + 1);
3556 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003557 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3558 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559 if (*skipwhite(p) == '(')
3560 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003561 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003562 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003563 else
3564 {
3565 ++nesting;
3566 nesting_def[nesting] = (c == 'd');
3567 indent += 2;
3568 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003569 }
3570 }
3571
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003572 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003573 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003574 if (eap->cmdidx != CMD_def
3575 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003576 || (p[0] == 'c'
3577 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3578 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3579 && (STRNCMP(&p[3], "nge", 3) != 0
3580 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 || (p[0] == 'i'
3582 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003583 && (!ASCII_ISALPHA(p[2])
3584 || (p[2] == 's'
3585 && (!ASCII_ISALPHA(p[3])
3586 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 skip_until = vim_strsave((char_u *)".");
3588
Bram Moolenaare38eab22019-12-05 21:50:01 +01003589 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 arg = skipwhite(skiptowhite(p));
3591 if (arg[0] == '<' && arg[1] =='<'
3592 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003593 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3594 || ((p[2] == '3' || p[2] == 'x')
3595 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 || (p[0] == 'p' && p[1] == 'e'
3597 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3598 || (p[0] == 't' && p[1] == 'c'
3599 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3600 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3601 && !ASCII_ISALPHA(p[3]))
3602 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3603 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3604 || (p[0] == 'm' && p[1] == 'z'
3605 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3606 ))
3607 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003608 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003610 if (STRNCMP(p, "trim", 4) == 0)
3611 {
3612 // Ignore leading white space.
3613 p = skipwhite(p + 4);
3614 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003615 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003616 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 if (*p == NUL)
3618 skip_until = vim_strsave((char_u *)".");
3619 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003620 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003621 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003622 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003623 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003624
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003625 // Check for ":cmd v =<< [trim] EOF"
3626 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003627 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003628 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003629 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003630 if (*arg == '[')
3631 arg = vim_strchr(arg, ']');
3632 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003633 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003634 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3635 && arg[1] == '<' && arg[2] =='<');
3636
3637 if (!found)
3638 // skip over the argument after "cmd"
3639 arg = skipwhite(skiptowhite(arg));
3640 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003641 && (checkforcmd(&p, "let", 2)
3642 || checkforcmd(&p, "var", 3)
3643 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003644 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003645 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003646 p = skipwhite(arg + 3);
3647 if (STRNCMP(p, "trim", 4) == 0)
3648 {
3649 // Ignore leading white space.
3650 p = skipwhite(p + 4);
3651 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003652 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003653 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003654 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003655 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003656 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003657 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003658 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 }
3660
Bram Moolenaare38eab22019-12-05 21:50:01 +01003661 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664
Bram Moolenaare38eab22019-12-05 21:50:01 +01003665 // Copy the line to newly allocated memory. get_one_sourceline()
3666 // allocates 250 bytes per line, this saves 80% on average. The cost
3667 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003669 if (p == NULL)
3670 goto erret;
3671 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672
Bram Moolenaare38eab22019-12-05 21:50:01 +01003673 // Add NULL lines for continuation lines, so that the line count is
3674 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 while (sourcing_lnum_off-- > 0)
3676 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3677
Bram Moolenaare38eab22019-12-05 21:50:01 +01003678 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 if (line_arg != NULL && *line_arg == NUL)
3680 line_arg = NULL;
3681 }
3682
Bram Moolenaare38eab22019-12-05 21:50:01 +01003683 // Don't define the function when skipping commands or when an error was
3684 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 if (eap->skip || did_emsg)
3686 goto erret;
3687
3688 /*
3689 * If there are no errors, add the function
3690 */
3691 if (fudi.fd_dict == NULL)
3692 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003693 hashtab_T *ht;
3694
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003695 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3697 {
3698 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3699 name);
3700 goto erret;
3701 }
3702
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003703 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003704 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003706 char_u *uname = untrans_function_name(name);
3707
3708 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3709 }
3710
3711 if (fp != NULL || import != NULL)
3712 {
3713 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003714
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003715 // Function can be replaced with "function!" and when sourcing the
3716 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003717 // A name that is used by an import can not be overruled.
3718 if (import != NULL
3719 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003720 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003721 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003723 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003724 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003725 else
3726 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 goto erret;
3728 }
3729 if (fp->uf_calls > 0)
3730 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003731 emsg_funcname(
3732 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 name);
3734 goto erret;
3735 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003736 if (fp->uf_refcount > 1)
3737 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003738 // This function is referenced somewhere, don't redefine it but
3739 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003740 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003741 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003742 fp = NULL;
3743 overwrite = TRUE;
3744 }
3745 else
3746 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003747 char_u *exp_name = fp->uf_name_exp;
3748
3749 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003750 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003751 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003752 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003753 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003754 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003755#ifdef FEAT_PROFILE
3756 fp->uf_profiling = FALSE;
3757 fp->uf_prof_initialized = FALSE;
3758#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003759 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 }
3762 }
3763 else
3764 {
3765 char numbuf[20];
3766
3767 fp = NULL;
3768 if (fudi.fd_newkey == NULL && !eap->forceit)
3769 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003770 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 goto erret;
3772 }
3773 if (fudi.fd_di == NULL)
3774 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003776 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 goto erret;
3778 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003779 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003780 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 goto erret;
3782
Bram Moolenaare38eab22019-12-05 21:50:01 +01003783 // Give the function a sequential number. Can only be used with a
3784 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 vim_free(name);
3786 sprintf(numbuf, "%d", ++func_nr);
3787 name = vim_strsave((char_u *)numbuf);
3788 if (name == NULL)
3789 goto erret;
3790 }
3791
3792 if (fp == NULL)
3793 {
3794 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3795 {
3796 int slen, plen;
3797 char_u *scriptname;
3798
Bram Moolenaare38eab22019-12-05 21:50:01 +01003799 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003801 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 {
3803 scriptname = autoload_name(name);
3804 if (scriptname != NULL)
3805 {
3806 p = vim_strchr(scriptname, '/');
3807 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003808 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003810 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 j = OK;
3812 vim_free(scriptname);
3813 }
3814 }
3815 if (j == FAIL)
3816 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003817 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 goto erret;
3819 }
3820 }
3821
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003822 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 if (fp == NULL)
3824 goto erret;
3825
3826 if (fudi.fd_dict != NULL)
3827 {
3828 if (fudi.fd_di == NULL)
3829 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003830 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3832 if (fudi.fd_di == NULL)
3833 {
3834 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003835 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 goto erret;
3837 }
3838 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3839 {
3840 vim_free(fudi.fd_di);
3841 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003842 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 goto erret;
3844 }
3845 }
3846 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003847 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 clear_tv(&fudi.fd_di->di_tv);
3849 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003851
Bram Moolenaare38eab22019-12-05 21:50:01 +01003852 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 flags |= FC_DICT;
3854 }
3855
Bram Moolenaare38eab22019-12-05 21:50:01 +01003856 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003857 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003858 if (overwrite)
3859 {
3860 hi = hash_find(&func_hashtab, name);
3861 hi->hi_key = UF2HIKEY(fp);
3862 }
3863 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 {
3865 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003866 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 goto erret;
3868 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003869 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 }
3871 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003872 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003873 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003874 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003875
3876 if (eap->cmdidx == CMD_def)
3877 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003878 int lnum_save = SOURCING_LNUM;
3879 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003880
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003881 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003882
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003883 // error messages are for the first function line
3884 SOURCING_LNUM = sourcing_lnum_top;
3885
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003886 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003887 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003888 int count = cstack->cs_idx + 1;
3889 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003890
3891 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003892 // a block that is visible now but not when the function is called
3893 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003894 fp->uf_block_ids = ALLOC_MULT(int, count);
3895 if (fp->uf_block_ids != NULL)
3896 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003897 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003898 sizeof(int) * count);
3899 fp->uf_block_depth = count;
3900 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003901
3902 // Set flag in each block to indicate a function was defined. This
3903 // is used to keep the variable when leaving the block, see
3904 // hide_script_var().
3905 for (i = 0; i <= cstack->cs_idx; ++i)
3906 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003907 }
3908
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003909 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003910 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003911 SOURCING_LNUM = lnum_save;
3912 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003913 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003914 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003915
3916 // parse the return type, if any
3917 if (ret_type == NULL)
3918 fp->uf_ret_type = &t_void;
3919 else
3920 {
3921 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003922 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003923 if (fp->uf_ret_type == NULL)
3924 {
3925 fp->uf_ret_type = &t_void;
3926 SOURCING_LNUM = lnum_save;
3927 goto erret;
3928 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003929 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003930 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003931 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003932 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003933 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003934
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003936 if ((flags & FC_CLOSURE) != 0)
3937 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003938 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003939 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003940 }
3941 else
3942 fp->uf_scoped = NULL;
3943
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 if (prof_def_func())
3946 func_do_profile(fp);
3947#endif
3948 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003949 if (sandbox)
3950 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003951 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003952 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 fp->uf_flags = flags;
3954 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003955 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003956 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003957 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003958 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003959 if (is_export)
3960 {
3961 fp->uf_flags |= FC_EXPORT;
3962 // let ex_export() know the export worked.
3963 is_export = FALSE;
3964 }
3965
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003966 if (eap->cmdidx == CMD_def)
3967 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003968 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3969 // :func does not use Vim9 script syntax, even in a Vim9 script file
3970 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003971
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003972 goto ret_free;
3973
3974erret:
3975 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003976 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01003977 if (fp != NULL)
3978 {
3979 ga_init(&fp->uf_args);
3980 ga_init(&fp->uf_def_args);
3981 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982errret_2:
3983 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01003984 if (fp != NULL)
3985 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003987 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003989 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003990 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003992 if (name != name_arg)
3993 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003994 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 did_emsg |= saved_did_emsg;
3996 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003997
3998 return fp;
3999}
4000
4001/*
4002 * ":function"
4003 */
4004 void
4005ex_function(exarg_T *eap)
4006{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004007 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004008}
4009
4010/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004011 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004012 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004013 */
4014 void
4015ex_defcompile(exarg_T *eap UNUSED)
4016{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004017 long todo = (long)func_hashtab.ht_used;
4018 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004019 hashitem_T *hi;
4020 ufunc_T *ufunc;
4021
4022 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4023 {
4024 if (!HASHITEM_EMPTY(hi))
4025 {
4026 --todo;
4027 ufunc = HI2UF(hi);
4028 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004029 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4030 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004031 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004032 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004033
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004034 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004035 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004036 // a function has been added or removed, need to start over
4037 todo = (long)func_hashtab.ht_used;
4038 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004039 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004040 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004041 }
4042 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004043 }
4044 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045}
4046
4047/*
4048 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4049 * Return 2 if "p" starts with "s:".
4050 * Return 0 otherwise.
4051 */
4052 int
4053eval_fname_script(char_u *p)
4054{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004055 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4056 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4058 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4059 return 5;
4060 if (p[0] == 's' && p[1] == ':')
4061 return 2;
4062 return 0;
4063}
4064
4065 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004066translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067{
4068 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004069 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004070 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004071}
4072
4073/*
4074 * Return TRUE when "ufunc" has old-style "..." varargs
4075 * or named varargs "...name: type".
4076 */
4077 int
4078has_varargs(ufunc_T *ufunc)
4079{
4080 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081}
4082
4083/*
4084 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004085 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 */
4087 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004088function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089{
4090 char_u *nm = name;
4091 char_u *p;
4092 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004093 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004094 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004096 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4097 if (no_deref)
4098 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004099 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004100 nm = skipwhite(nm);
4101
Bram Moolenaare38eab22019-12-05 21:50:01 +01004102 // Only accept "funcname", "funcname ", "funcname (..." and
4103 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004105 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 vim_free(p);
4107 return n;
4108}
4109
Bram Moolenaar113e1072019-01-20 15:30:40 +01004110#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 char_u *
4112get_expanded_name(char_u *name, int check)
4113{
4114 char_u *nm = name;
4115 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004116 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004118 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004119 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004121 if (p != NULL && *nm == NUL
4122 && (!check || translated_function_exists(p, is_global)))
4123 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124
4125 vim_free(p);
4126 return NULL;
4127}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004128#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130/*
4131 * Function given to ExpandGeneric() to obtain the list of user defined
4132 * function names.
4133 */
4134 char_u *
4135get_user_func_name(expand_T *xp, int idx)
4136{
4137 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004138 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 static hashitem_T *hi;
4140 ufunc_T *fp;
4141
4142 if (idx == 0)
4143 {
4144 done = 0;
4145 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004146 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004148 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004149 {
4150 if (done++ > 0)
4151 ++hi;
4152 while (HASHITEM_EMPTY(hi))
4153 ++hi;
4154 fp = HI2UF(hi);
4155
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004156 // don't show dead, dict and lambda functions
4157 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004158 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004159 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160
4161 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004162 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163
4164 cat_func_name(IObuff, fp);
4165 if (xp->xp_context != EXPAND_USER_FUNC)
4166 {
4167 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004168 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 STRCAT(IObuff, ")");
4170 }
4171 return IObuff;
4172 }
4173 return NULL;
4174}
4175
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176/*
4177 * ":delfunction {name}"
4178 */
4179 void
4180ex_delfunction(exarg_T *eap)
4181{
4182 ufunc_T *fp = NULL;
4183 char_u *p;
4184 char_u *name;
4185 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004186 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187
4188 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004189 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4190 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191 vim_free(fudi.fd_newkey);
4192 if (name == NULL)
4193 {
4194 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004195 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196 return;
4197 }
4198 if (!ends_excmd(*skipwhite(p)))
4199 {
4200 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004201 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 return;
4203 }
4204 eap->nextcmd = check_nextcmd(p);
4205 if (eap->nextcmd != NULL)
4206 *p = NUL;
4207
4208 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004209 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210 vim_free(name);
4211
4212 if (!eap->skip)
4213 {
4214 if (fp == NULL)
4215 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004216 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004217 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218 return;
4219 }
4220 if (fp->uf_calls > 0)
4221 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004222 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004223 return;
4224 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004225 if (fp->uf_flags & FC_VIM9)
4226 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004227 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004228 return;
4229 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230
4231 if (fudi.fd_dict != NULL)
4232 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004233 // Delete the dict item that refers to the function, it will
4234 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4236 }
4237 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004238 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004239 // A normal function (not a numbered function or lambda) has a
4240 // refcount of 1 for the entry in the hashtable. When deleting
4241 // it and the refcount is more than one, it should be kept.
4242 // A numbered function and lambda should be kept if the refcount is
4243 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004244 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004245 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004246 // Function is still referenced somewhere. Don't free it but
4247 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004248 if (func_remove(fp))
4249 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004250 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004251 }
4252 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004253 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004254 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004255 }
4256}
4257
4258/*
4259 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004260 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 */
4262 void
4263func_unref(char_u *name)
4264{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004265 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004267 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004269 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004270 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004273 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004275 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004277 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004278}
4279
4280/*
4281 * Unreference a Function: decrement the reference count and free it when it
4282 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004283 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004284 */
4285 void
4286func_ptr_unref(ufunc_T *fp)
4287{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004288 if (fp != NULL && (--fp->uf_refcount <= 0
4289 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4290 && fp->uf_partial->pt_refcount <= 1
4291 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004292 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004293 // Only delete it when it's not being used. Otherwise it's done
4294 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004295 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004296 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 }
4298}
4299
4300/*
4301 * Count a reference to a Function.
4302 */
4303 void
4304func_ref(char_u *name)
4305{
4306 ufunc_T *fp;
4307
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004308 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004310 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004311 if (fp != NULL)
4312 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004314 // Only give an error for a numbered function.
4315 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004316 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004317}
4318
4319/*
4320 * Count a reference to a Function.
4321 */
4322 void
4323func_ptr_ref(ufunc_T *fp)
4324{
4325 if (fp != NULL)
4326 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327}
4328
4329/*
4330 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4331 * referenced from anywhere that is in use.
4332 */
4333 static int
4334can_free_funccal(funccall_T *fc, int copyID)
4335{
4336 return (fc->l_varlist.lv_copyID != copyID
4337 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004338 && fc->l_avars.dv_copyID != copyID
4339 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340}
4341
4342/*
4343 * ":return [expr]"
4344 */
4345 void
4346ex_return(exarg_T *eap)
4347{
4348 char_u *arg = eap->arg;
4349 typval_T rettv;
4350 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004351 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352
4353 if (current_funccal == NULL)
4354 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004355 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004356 return;
4357 }
4358
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004359 CLEAR_FIELD(evalarg);
4360 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4361
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004362 if (eap->skip)
4363 ++emsg_skip;
4364
4365 eap->nextcmd = NULL;
4366 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004367 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 {
4369 if (!eap->skip)
4370 returning = do_return(eap, FALSE, TRUE, &rettv);
4371 else
4372 clear_tv(&rettv);
4373 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004374 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375 else if (!eap->skip)
4376 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004377 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004378 update_force_abort();
4379
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004380 /*
4381 * Return unless the expression evaluation has been cancelled due to an
4382 * aborting error, an interrupt, or an exception.
4383 */
4384 if (!aborting())
4385 returning = do_return(eap, FALSE, TRUE, NULL);
4386 }
4387
Bram Moolenaare38eab22019-12-05 21:50:01 +01004388 // When skipping or the return gets pending, advance to the next command
4389 // in this line (!returning). Otherwise, ignore the rest of the line.
4390 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 if (returning)
4392 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004393 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 eap->nextcmd = check_nextcmd(arg);
4395
4396 if (eap->skip)
4397 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004398 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399}
4400
4401/*
4402 * ":1,25call func(arg1, arg2)" function call.
4403 */
4404 void
4405ex_call(exarg_T *eap)
4406{
4407 char_u *arg = eap->arg;
4408 char_u *startarg;
4409 char_u *name;
4410 char_u *tofree;
4411 int len;
4412 typval_T rettv;
4413 linenr_T lnum;
4414 int doesrange;
4415 int failed = FALSE;
4416 funcdict_T fudi;
4417 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004418 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004419 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420
Bram Moolenaare6b53242020-07-01 17:28:33 +02004421 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004422 if (eap->skip)
4423 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004424 // trans_function_name() doesn't work well when skipping, use eval0()
4425 // instead to skip to any following command, e.g. for:
4426 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004428 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 clear_tv(&rettv);
4430 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004431 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004432 return;
4433 }
4434
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004435 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4436 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 if (fudi.fd_newkey != NULL)
4438 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004439 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004440 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004441 vim_free(fudi.fd_newkey);
4442 }
4443 if (tofree == NULL)
4444 return;
4445
Bram Moolenaare38eab22019-12-05 21:50:01 +01004446 // Increase refcount on dictionary, it could get deleted when evaluating
4447 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448 if (fudi.fd_dict != NULL)
4449 ++fudi.fd_dict->dv_refcount;
4450
Bram Moolenaare38eab22019-12-05 21:50:01 +01004451 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4452 // contents. For VAR_PARTIAL get its partial, unless we already have one
4453 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004454 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004455 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4456 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457
Bram Moolenaare38eab22019-12-05 21:50:01 +01004458 // Skip white space to allow ":call func ()". Not good, but required for
4459 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004460 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004461 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462
4463 if (*startarg != '(')
4464 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004465 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 goto end;
4467 }
4468
4469 /*
4470 * When skipping, evaluate the function once, to find the end of the
4471 * arguments.
4472 * When the function takes a range, this is discovered after the first
4473 * call, and the loop is broken.
4474 */
4475 if (eap->skip)
4476 {
4477 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004478 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479 }
4480 else
4481 lnum = eap->line1;
4482 for ( ; lnum <= eap->line2; ++lnum)
4483 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004484 funcexe_T funcexe;
4485
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 if (!eap->skip && eap->addr_count > 0)
4487 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004488 if (lnum > curbuf->b_ml.ml_line_count)
4489 {
4490 // If the function deleted lines or switched to another buffer
4491 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004492 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004493 break;
4494 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 curwin->w_cursor.lnum = lnum;
4496 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004498 }
4499 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004500
Bram Moolenaara80faa82020-04-12 19:37:17 +02004501 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004502 funcexe.firstline = eap->line1;
4503 funcexe.lastline = eap->line2;
4504 funcexe.doesrange = &doesrange;
4505 funcexe.evaluate = !eap->skip;
4506 funcexe.partial = partial;
4507 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004508 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004509 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 {
4511 failed = TRUE;
4512 break;
4513 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004514 if (has_watchexpr())
4515 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004517 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004518 if (handle_subscript(&arg, &rettv,
4519 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520 {
4521 failed = TRUE;
4522 break;
4523 }
4524
4525 clear_tv(&rettv);
4526 if (doesrange || eap->skip)
4527 break;
4528
Bram Moolenaare38eab22019-12-05 21:50:01 +01004529 // Stop when immediately aborting on error, or when an interrupt
4530 // occurred or an exception was thrown but not caught.
4531 // get_func_tv() returned OK, so that the check for trailing
4532 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533 if (aborting())
4534 break;
4535 }
4536 if (eap->skip)
4537 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004538 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539
Bram Moolenaare51bb172020-02-16 19:42:23 +01004540 // When inside :try we need to check for following "| catch".
4541 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004542 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004543 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004544 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004545 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004547 if (!failed)
4548 {
4549 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004550 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 }
4553 else
4554 eap->nextcmd = check_nextcmd(arg);
4555 }
4556
4557end:
4558 dict_unref(fudi.fd_dict);
4559 vim_free(tofree);
4560}
4561
4562/*
4563 * Return from a function. Possibly makes the return pending. Also called
4564 * for a pending return at the ":endtry" or after returning from an extra
4565 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4566 * when called due to a ":return" command. "rettv" may point to a typval_T
4567 * with the return rettv. Returns TRUE when the return can be carried out,
4568 * FALSE when the return gets pending.
4569 */
4570 int
4571do_return(
4572 exarg_T *eap,
4573 int reanimate,
4574 int is_cmd,
4575 void *rettv)
4576{
4577 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004578 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579
4580 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004581 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 current_funccal->returned = FALSE;
4583
4584 /*
4585 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4586 * not in its finally clause (which then is to be executed next) is found.
4587 * In this case, make the ":return" pending for execution at the ":endtry".
4588 * Otherwise, return normally.
4589 */
4590 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4591 if (idx >= 0)
4592 {
4593 cstack->cs_pending[idx] = CSTP_RETURN;
4594
4595 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004596 // A pending return again gets pending. "rettv" points to an
4597 // allocated variable with the rettv of the original ":return"'s
4598 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 cstack->cs_rettv[idx] = rettv;
4600 else
4601 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004602 // When undoing a return in order to make it pending, get the stored
4603 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 if (reanimate)
4605 rettv = current_funccal->rettv;
4606
4607 if (rettv != NULL)
4608 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004609 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4611 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4612 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004613 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 }
4615 else
4616 cstack->cs_rettv[idx] = NULL;
4617
4618 if (reanimate)
4619 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004620 // The pending return value could be overwritten by a ":return"
4621 // without argument in a finally clause; reset the default
4622 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004623 current_funccal->rettv->v_type = VAR_NUMBER;
4624 current_funccal->rettv->vval.v_number = 0;
4625 }
4626 }
4627 report_make_pending(CSTP_RETURN, rettv);
4628 }
4629 else
4630 {
4631 current_funccal->returned = TRUE;
4632
Bram Moolenaare38eab22019-12-05 21:50:01 +01004633 // If the return is carried out now, store the return value. For
4634 // a return immediately after reanimation, the value is already
4635 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004636 if (!reanimate && rettv != NULL)
4637 {
4638 clear_tv(current_funccal->rettv);
4639 *current_funccal->rettv = *(typval_T *)rettv;
4640 if (!is_cmd)
4641 vim_free(rettv);
4642 }
4643 }
4644
4645 return idx < 0;
4646}
4647
4648/*
4649 * Free the variable with a pending return value.
4650 */
4651 void
4652discard_pending_return(void *rettv)
4653{
4654 free_tv((typval_T *)rettv);
4655}
4656
4657/*
4658 * Generate a return command for producing the value of "rettv". The result
4659 * is an allocated string. Used by report_pending() for verbose messages.
4660 */
4661 char_u *
4662get_return_cmd(void *rettv)
4663{
4664 char_u *s = NULL;
4665 char_u *tofree = NULL;
4666 char_u numbuf[NUMBUFLEN];
4667
4668 if (rettv != NULL)
4669 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4670 if (s == NULL)
4671 s = (char_u *)"";
4672
4673 STRCPY(IObuff, ":return ");
4674 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4675 if (STRLEN(s) + 8 >= IOSIZE)
4676 STRCPY(IObuff + IOSIZE - 4, "...");
4677 vim_free(tofree);
4678 return vim_strsave(IObuff);
4679}
4680
4681/*
4682 * Get next function line.
4683 * Called by do_cmdline() to get the next line.
4684 * Returns allocated string, or NULL for end of function.
4685 */
4686 char_u *
4687get_func_line(
4688 int c UNUSED,
4689 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004690 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004691 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692{
4693 funccall_T *fcp = (funccall_T *)cookie;
4694 ufunc_T *fp = fcp->func;
4695 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004696 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697
Bram Moolenaare38eab22019-12-05 21:50:01 +01004698 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 if (fcp->dbg_tick != debug_tick)
4700 {
4701 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004702 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 fcp->dbg_tick = debug_tick;
4704 }
4705#ifdef FEAT_PROFILE
4706 if (do_profiling == PROF_YES)
4707 func_line_end(cookie);
4708#endif
4709
4710 gap = &fp->uf_lines;
4711 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4712 || fcp->returned)
4713 retval = NULL;
4714 else
4715 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004716 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 while (fcp->linenr < gap->ga_len
4718 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4719 ++fcp->linenr;
4720 if (fcp->linenr >= gap->ga_len)
4721 retval = NULL;
4722 else
4723 {
4724 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004725 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726#ifdef FEAT_PROFILE
4727 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004728 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729#endif
4730 }
4731 }
4732
Bram Moolenaare38eab22019-12-05 21:50:01 +01004733 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004734 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004736 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004737 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004739 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004740 fcp->dbg_tick = debug_tick;
4741 }
4742
4743 return retval;
4744}
4745
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746/*
4747 * Return TRUE if the currently active function should be ended, because a
4748 * return was encountered or an error occurred. Used inside a ":while".
4749 */
4750 int
4751func_has_ended(void *cookie)
4752{
4753 funccall_T *fcp = (funccall_T *)cookie;
4754
Bram Moolenaare38eab22019-12-05 21:50:01 +01004755 // Ignore the "abort" flag if the abortion behavior has been changed due to
4756 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4758 || fcp->returned);
4759}
4760
4761/*
4762 * return TRUE if cookie indicates a function which "abort"s on errors.
4763 */
4764 int
4765func_has_abort(
4766 void *cookie)
4767{
4768 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4769}
4770
4771
4772/*
4773 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4774 * Don't do this when "Func" is already a partial that was bound
4775 * explicitly (pt_auto is FALSE).
4776 * Changes "rettv" in-place.
4777 * Returns the updated "selfdict_in".
4778 */
4779 dict_T *
4780make_partial(dict_T *selfdict_in, typval_T *rettv)
4781{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004782 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 char_u *tofree = NULL;
4784 ufunc_T *fp;
4785 char_u fname_buf[FLEN_FIXED + 1];
4786 int error;
4787 dict_T *selfdict = selfdict_in;
4788
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004789 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4790 fp = rettv->vval.v_partial->pt_func;
4791 else
4792 {
4793 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4794 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004795 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004796 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004797 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004798 vim_free(tofree);
4799 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800
4801 if (fp != NULL && (fp->uf_flags & FC_DICT))
4802 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004803 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804
4805 if (pt != NULL)
4806 {
4807 pt->pt_refcount = 1;
4808 pt->pt_dict = selfdict;
4809 pt->pt_auto = TRUE;
4810 selfdict = NULL;
4811 if (rettv->v_type == VAR_FUNC)
4812 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004813 // Just a function: Take over the function name and use
4814 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815 pt->pt_name = rettv->vval.v_string;
4816 }
4817 else
4818 {
4819 partial_T *ret_pt = rettv->vval.v_partial;
4820 int i;
4821
Bram Moolenaare38eab22019-12-05 21:50:01 +01004822 // Partial: copy the function name, use selfdict and copy
4823 // args. Can't take over name or args, the partial might
4824 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004825 if (ret_pt->pt_name != NULL)
4826 {
4827 pt->pt_name = vim_strsave(ret_pt->pt_name);
4828 func_ref(pt->pt_name);
4829 }
4830 else
4831 {
4832 pt->pt_func = ret_pt->pt_func;
4833 func_ptr_ref(pt->pt_func);
4834 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004835 if (ret_pt->pt_argc > 0)
4836 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004837 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004839 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840 pt->pt_argc = 0;
4841 else
4842 {
4843 pt->pt_argc = ret_pt->pt_argc;
4844 for (i = 0; i < pt->pt_argc; i++)
4845 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4846 }
4847 }
4848 partial_unref(ret_pt);
4849 }
4850 rettv->v_type = VAR_PARTIAL;
4851 rettv->vval.v_partial = pt;
4852 }
4853 }
4854 return selfdict;
4855}
4856
4857/*
4858 * Return the name of the executed function.
4859 */
4860 char_u *
4861func_name(void *cookie)
4862{
4863 return ((funccall_T *)cookie)->func->uf_name;
4864}
4865
4866/*
4867 * Return the address holding the next breakpoint line for a funccall cookie.
4868 */
4869 linenr_T *
4870func_breakpoint(void *cookie)
4871{
4872 return &((funccall_T *)cookie)->breakpoint;
4873}
4874
4875/*
4876 * Return the address holding the debug tick for a funccall cookie.
4877 */
4878 int *
4879func_dbg_tick(void *cookie)
4880{
4881 return &((funccall_T *)cookie)->dbg_tick;
4882}
4883
4884/*
4885 * Return the nesting level for a funccall cookie.
4886 */
4887 int
4888func_level(void *cookie)
4889{
4890 return ((funccall_T *)cookie)->level;
4891}
4892
4893/*
4894 * Return TRUE when a function was ended by a ":return" command.
4895 */
4896 int
4897current_func_returned(void)
4898{
4899 return current_funccal->returned;
4900}
4901
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902 int
4903free_unref_funccal(int copyID, int testing)
4904{
4905 int did_free = FALSE;
4906 int did_free_funccal = FALSE;
4907 funccall_T *fc, **pfc;
4908
4909 for (pfc = &previous_funccal; *pfc != NULL; )
4910 {
4911 if (can_free_funccal(*pfc, copyID))
4912 {
4913 fc = *pfc;
4914 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004915 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916 did_free = TRUE;
4917 did_free_funccal = TRUE;
4918 }
4919 else
4920 pfc = &(*pfc)->caller;
4921 }
4922 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004923 // When a funccal was freed some more items might be garbage
4924 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925 (void)garbage_collect(testing);
4926
4927 return did_free;
4928}
4929
4930/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004931 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932 */
4933 static funccall_T *
4934get_funccal(void)
4935{
4936 int i;
4937 funccall_T *funccal;
4938 funccall_T *temp_funccal;
4939
4940 funccal = current_funccal;
4941 if (debug_backtrace_level > 0)
4942 {
4943 for (i = 0; i < debug_backtrace_level; i++)
4944 {
4945 temp_funccal = funccal->caller;
4946 if (temp_funccal)
4947 funccal = temp_funccal;
4948 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004949 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950 debug_backtrace_level = i;
4951 }
4952 }
4953 return funccal;
4954}
4955
4956/*
4957 * Return the hashtable used for local variables in the current funccal.
4958 * Return NULL if there is no current funccal.
4959 */
4960 hashtab_T *
4961get_funccal_local_ht()
4962{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004963 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004964 return NULL;
4965 return &get_funccal()->l_vars.dv_hashtab;
4966}
4967
4968/*
4969 * Return the l: scope variable.
4970 * Return NULL if there is no current funccal.
4971 */
4972 dictitem_T *
4973get_funccal_local_var()
4974{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004975 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976 return NULL;
4977 return &get_funccal()->l_vars_var;
4978}
4979
4980/*
4981 * Return the hashtable used for argument in the current funccal.
4982 * Return NULL if there is no current funccal.
4983 */
4984 hashtab_T *
4985get_funccal_args_ht()
4986{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004987 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 return NULL;
4989 return &get_funccal()->l_avars.dv_hashtab;
4990}
4991
4992/*
4993 * Return the a: scope variable.
4994 * Return NULL if there is no current funccal.
4995 */
4996 dictitem_T *
4997get_funccal_args_var()
4998{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004999 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005001 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005002}
5003
5004/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005 * List function variables, if there is a function.
5006 */
5007 void
5008list_func_vars(int *first)
5009{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005010 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005012 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005013}
5014
5015/*
5016 * If "ht" is the hashtable for local variables in the current funccal, return
5017 * the dict that contains it.
5018 * Otherwise return NULL.
5019 */
5020 dict_T *
5021get_current_funccal_dict(hashtab_T *ht)
5022{
5023 if (current_funccal != NULL
5024 && ht == &current_funccal->l_vars.dv_hashtab)
5025 return &current_funccal->l_vars;
5026 return NULL;
5027}
5028
5029/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005030 * Search hashitem in parent scope.
5031 */
5032 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005033find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005034{
5035 funccall_T *old_current_funccal = current_funccal;
5036 hashtab_T *ht;
5037 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005038 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005039
5040 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5041 return NULL;
5042
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005043 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005044 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005045 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005046 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005047 ht = find_var_ht(name, &varname);
5048 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005049 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005050 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005051 if (!HASHITEM_EMPTY(hi))
5052 {
5053 *pht = ht;
5054 break;
5055 }
5056 }
5057 if (current_funccal == current_funccal->func->uf_scoped)
5058 break;
5059 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005060 }
5061 current_funccal = old_current_funccal;
5062
5063 return hi;
5064}
5065
5066/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005067 * Search variable in parent scope.
5068 */
5069 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005070find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005071{
5072 dictitem_T *v = NULL;
5073 funccall_T *old_current_funccal = current_funccal;
5074 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005075 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005076
5077 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5078 return NULL;
5079
Bram Moolenaare38eab22019-12-05 21:50:01 +01005080 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005081 current_funccal = current_funccal->func->uf_scoped;
5082 while (current_funccal)
5083 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005084 ht = find_var_ht(name, &varname);
5085 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005086 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005087 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005088 if (v != NULL)
5089 break;
5090 }
5091 if (current_funccal == current_funccal->func->uf_scoped)
5092 break;
5093 current_funccal = current_funccal->func->uf_scoped;
5094 }
5095 current_funccal = old_current_funccal;
5096
5097 return v;
5098}
5099
5100/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005101 * Set "copyID + 1" in previous_funccal and callers.
5102 */
5103 int
5104set_ref_in_previous_funccal(int copyID)
5105{
5106 int abort = FALSE;
5107 funccall_T *fc;
5108
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005109 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005111 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005112 abort = abort
5113 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5114 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005115 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005116 }
5117 return abort;
5118}
5119
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005120 static int
5121set_ref_in_funccal(funccall_T *fc, int copyID)
5122{
5123 int abort = FALSE;
5124
5125 if (fc->fc_copyID != copyID)
5126 {
5127 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005128 abort = abort
5129 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5130 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005131 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005132 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005133 }
5134 return abort;
5135}
5136
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137/*
5138 * Set "copyID" in all local vars and arguments in the call stack.
5139 */
5140 int
5141set_ref_in_call_stack(int copyID)
5142{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005143 int abort = FALSE;
5144 funccall_T *fc;
5145 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005147 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005148 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005149
5150 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005151 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5152 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005153 abort = abort || set_ref_in_funccal(fc, copyID);
5154
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005155 return abort;
5156}
5157
5158/*
5159 * Set "copyID" in all functions available by name.
5160 */
5161 int
5162set_ref_in_functions(int copyID)
5163{
5164 int todo;
5165 hashitem_T *hi = NULL;
5166 int abort = FALSE;
5167 ufunc_T *fp;
5168
5169 todo = (int)func_hashtab.ht_used;
5170 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005172 if (!HASHITEM_EMPTY(hi))
5173 {
5174 --todo;
5175 fp = HI2UF(hi);
5176 if (!func_name_refcount(fp->uf_name))
5177 abort = abort || set_ref_in_func(NULL, fp, copyID);
5178 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005179 }
5180 return abort;
5181}
5182
5183/*
5184 * Set "copyID" in all function arguments.
5185 */
5186 int
5187set_ref_in_func_args(int copyID)
5188{
5189 int i;
5190 int abort = FALSE;
5191
5192 for (i = 0; i < funcargs.ga_len; ++i)
5193 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5194 copyID, NULL, NULL);
5195 return abort;
5196}
5197
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005198/*
5199 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005200 * Returns TRUE if setting references failed somehow.
5201 */
5202 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005203set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005204{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005205 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005206 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005207 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005208 char_u fname_buf[FLEN_FIXED + 1];
5209 char_u *tofree = NULL;
5210 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005211 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005212
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005213 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005214 return FALSE;
5215
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005216 if (fp_in == NULL)
5217 {
5218 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005219 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005220 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005221 if (fp != NULL)
5222 {
5223 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005224 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005225 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005226
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005227 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005228 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005229}
5230
Bram Moolenaare38eab22019-12-05 21:50:01 +01005231#endif // FEAT_EVAL