blob: d6a7e5d16d4aa6ce1680e830af24827b1871def8 [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 Moolenaar8a7d6542020-01-26 15:56:19 +010057 * Return a pointer to after the type.
58 * When something is wrong return "arg".
59 */
60 static char_u *
61one_function_arg(char_u *arg, garray_T *newargs, garray_T *argtypes, int skip)
62{
Bram Moolenaar6e949782020-04-13 17:21:00 +020063 char_u *p = arg;
64 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010065
66 while (ASCII_ISALNUM(*p) || *p == '_')
67 ++p;
68 if (arg == p || isdigit(*arg)
69 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
70 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
71 {
72 if (!skip)
73 semsg(_("E125: Illegal argument: %s"), arg);
74 return arg;
75 }
76 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
77 return arg;
78 if (newargs != NULL)
79 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010080 int c;
81 int i;
82
83 c = *p;
84 *p = NUL;
85 arg_copy = vim_strsave(arg);
86 if (arg_copy == NULL)
87 {
88 *p = c;
89 return arg;
90 }
91
92 // Check for duplicate argument name.
93 for (i = 0; i < newargs->ga_len; ++i)
94 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
95 {
96 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
97 vim_free(arg_copy);
98 return arg;
99 }
100 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
101 newargs->ga_len++;
102
103 *p = c;
104 }
105
106 // get any type from "arg: type"
107 if (argtypes != NULL && ga_grow(argtypes, 1) == OK)
108 {
109 char_u *type = NULL;
110
Bram Moolenaar6e949782020-04-13 17:21:00 +0200111 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
112 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200113 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200114 arg_copy == NULL ? arg : arg_copy);
115 p = skipwhite(p);
116 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100117 if (*p == ':')
118 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200119 ++p;
120 if (!VIM_ISWHITE(*p))
121 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200122 semsg(_(e_white_space_required_after_str), ":");
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200123 return arg;
124 }
125 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200126 p = skip_type(type, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100127 type = vim_strnsave(type, p - type);
128 }
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 else if (*skipwhite(p) != '=')
130 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200131 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 arg_copy == NULL ? arg : arg_copy);
133 return arg;
134 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
136 }
137
138 return p;
139}
140
141/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200142 * Get function arguments.
143 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100144 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200145get_function_args(
146 char_u **argp,
147 char_u endchar,
148 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149 garray_T *argtypes, // NULL unless using :def
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200150 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200151 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200152 int skip,
153 exarg_T *eap,
154 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200155{
156 int mustend = FALSE;
157 char_u *arg = *argp;
158 char_u *p = arg;
159 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200160 int any_default = FALSE;
161 char_u *expr;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200162 char_u *whitep = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200163
164 if (newargs != NULL)
165 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100166 if (argtypes != NULL)
167 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 if (default_args != NULL)
169 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170
171 if (varargs != NULL)
172 *varargs = FALSE;
173
174 /*
175 * Isolate the arguments: "arg1, arg2, ...)"
176 */
177 while (*p != endchar)
178 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200179 while (eap != NULL && eap->getline != NULL
180 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200181 {
182 char_u *theline;
183
184 // End of the line, get the next one.
185 theline = eap->getline(':', eap->cookie, 0, TRUE);
186 if (theline == NULL)
187 break;
188 vim_free(*line_to_free);
189 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200190 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200191 p = skipwhite(theline);
192 }
193
194 if (mustend && *p != endchar)
195 {
196 if (!skip)
197 semsg(_(e_invarg2), *argp);
198 break;
199 }
200 if (*p == endchar)
201 break;
202
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
204 {
205 if (varargs != NULL)
206 *varargs = TRUE;
207 p += 3;
208 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100209
210 if (argtypes != NULL)
211 {
212 // ...name: list<type>
213 if (!ASCII_ISALPHA(*p))
214 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200215 emsg(_(e_missing_name_after_dots));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100216 break;
217 }
218
219 arg = p;
220 p = one_function_arg(p, newargs, argtypes, skip);
221 if (p == arg)
222 break;
223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200224 }
225 else
226 {
227 arg = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228 p = one_function_arg(p, newargs, argtypes, skip);
229 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200231
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200232 if (*skipwhite(p) == '=' && default_args != NULL)
233 {
234 typval_T rettv;
235
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100236 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200237 any_default = TRUE;
238 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200239 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200240 p = skipwhite(p);
241 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200242 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200243 {
244 if (ga_grow(default_args, 1) == FAIL)
245 goto err_ret;
246
247 // trim trailing whitespace
248 while (p > expr && VIM_ISWHITE(p[-1]))
249 p--;
250 c = *p;
251 *p = NUL;
252 expr = vim_strsave(expr);
253 if (expr == NULL)
254 {
255 *p = c;
256 goto err_ret;
257 }
258 ((char_u **)(default_args->ga_data))
259 [default_args->ga_len] = expr;
260 default_args->ga_len++;
261 *p = c;
262 }
263 else
264 mustend = TRUE;
265 }
266 else if (any_default)
267 {
268 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200269 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200272 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200273 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200274 // Don't give this error when skipping, it makes the "->" not
275 // found in "{k,v -> x}" and give a confusing error.
276 if (!skip && in_vim9script()
277 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
278 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200279 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200280 goto err_ret;
281 }
282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200283 else
284 mustend = TRUE;
285 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200286 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200287 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200288 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200289
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200290 if (*p != endchar)
291 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100292 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200293
294 *argp = p;
295 return OK;
296
297err_ret:
298 if (newargs != NULL)
299 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200300 if (default_args != NULL)
301 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200302 return FAIL;
303}
304
305/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200306 * Register function "fp" as using "current_funccal" as its scope.
307 */
308 static int
309register_closure(ufunc_T *fp)
310{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200311 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100312 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200313 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200314 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200315 fp->uf_scoped = current_funccal;
316 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200317
Bram Moolenaar58016442016-07-31 18:30:22 +0200318 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
319 return FAIL;
320 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
321 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200322 return OK;
323}
324
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100325 static void
326set_ufunc_name(ufunc_T *fp, char_u *name)
327{
328 STRCPY(fp->uf_name, name);
329
330 if (name[0] == K_SPECIAL)
331 {
332 fp->uf_name_exp = alloc(STRLEN(name) + 3);
333 if (fp->uf_name_exp != NULL)
334 {
335 STRCPY(fp->uf_name_exp, "<SNR>");
336 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
337 }
338 }
339}
340
Bram Moolenaar58016442016-07-31 18:30:22 +0200341/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200342 * Get a name for a lambda. Returned in static memory.
343 */
344 char_u *
345get_lambda_name(void)
346{
347 static char_u name[30];
348 static int lambda_no = 0;
349
350 sprintf((char*)name, "<lambda>%d", ++lambda_no);
351 return name;
352}
353
Bram Moolenaar801ab062020-06-25 19:27:56 +0200354#if defined(FEAT_LUA) || defined(PROTO)
355/*
356 * Registers a native C callback which can be called from Vim script.
357 * Returns the name of the Vim script function.
358 */
359 char_u *
360register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
361{
362 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200363 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200364
365 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
366 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200367 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200368
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200369 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200370 fp->uf_refcount = 1;
371 fp->uf_varargs = TRUE;
372 fp->uf_flags = FC_CFUNC;
373 fp->uf_calls = 0;
374 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200375 fp->uf_cb = cb;
376 fp->uf_cb_free = cb_free;
377 fp->uf_cb_state = state;
378
379 set_ufunc_name(fp, name);
380 hash_add(&func_hashtab, UF2HIKEY(fp));
381
382 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200383}
384#endif
385
Bram Moolenaar04b12692020-05-04 23:24:44 +0200386/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200387 * Parse a lambda expression and get a Funcref from "*arg".
388 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
389 */
390 int
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200391get_lambda_tv(char_u **arg, typval_T *rettv, evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200392{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200393 int evaluate = evalarg != NULL
394 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200395 garray_T newargs;
396 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200397 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200398 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100399 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200400 int varargs;
401 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200402 char_u *s;
403 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200404 int *old_eval_lavars = eval_lavars_used;
405 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200406 char_u *tofree = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200407
408 ga_init(&newargs);
409 ga_init(&newlines);
410
Bram Moolenaare38eab22019-12-05 21:50:01 +0100411 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200412 s = skipwhite(*arg + 1);
413 ret = get_function_args(&s, '-', NULL, NULL, NULL, NULL, TRUE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200414 NULL, NULL);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200415 if (ret == FAIL || *s != '>')
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200416 return NOTDONE;
417
Bram Moolenaare38eab22019-12-05 21:50:01 +0100418 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200419 if (evaluate)
420 pnewargs = &newargs;
421 else
422 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200423 *arg = skipwhite(*arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100424 // TODO: argument types
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200425 ret = get_function_args(arg, '-', pnewargs, NULL, &varargs, NULL, FALSE,
426 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200427 if (ret == FAIL || **arg != '>')
428 goto errret;
429
Bram Moolenaare38eab22019-12-05 21:50:01 +0100430 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200431 if (evaluate)
432 eval_lavars_used = &eval_lavars;
433
Bram Moolenaare38eab22019-12-05 21:50:01 +0100434 // Get the start and the end of the expression.
Bram Moolenaar9215f012020-06-27 21:18:00 +0200435 *arg = skipwhite_and_linebreak(*arg + 1, evalarg);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200436 start = *arg;
437 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200438 if (ret == FAIL)
439 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200440 if (evalarg != NULL)
441 {
442 // avoid that the expression gets freed when another line break follows
443 tofree = evalarg->eval_tofree;
444 evalarg->eval_tofree = NULL;
445 }
446
Bram Moolenaar9215f012020-06-27 21:18:00 +0200447 *arg = skipwhite_and_linebreak(*arg, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200448 if (**arg != '}')
Bram Moolenaaree619e52020-03-28 21:38:06 +0100449 {
450 semsg(_("E451: Expected }: %s"), *arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200451 goto errret;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200453 ++*arg;
454
455 if (evaluate)
456 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200457 int len;
458 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200459 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200460 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200461
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200462 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200463 if (fp == NULL)
464 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200465 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200466 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200467 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200468 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200469
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200470 ga_init2(&newlines, (int)sizeof(char_u *), 1);
471 if (ga_grow(&newlines, 1) == FAIL)
472 goto errret;
473
Bram Moolenaare38eab22019-12-05 21:50:01 +0100474 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200475 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200476 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200477 if (p == NULL)
478 goto errret;
479 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
480 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200481 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200482 if (strstr((char *)p + 7, "a:") == NULL)
483 // No a: variables are used for sure.
484 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200485
486 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100487 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200488 hash_add(&func_hashtab, UF2HIKEY(fp));
489 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200490 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200491 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200492 if (current_funccal != NULL && eval_lavars)
493 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200494 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200496 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200497 }
498 else
499 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200500
501#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200502 if (prof_def_func())
503 func_do_profile(fp);
504#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200505 if (sandbox)
506 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100507 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200508 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200509 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200510 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200511 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100512 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200513
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200514 pt->pt_func = fp;
515 pt->pt_refcount = 1;
516 rettv->vval.v_partial = pt;
517 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200519
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200520 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200521 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200522 evalarg->eval_tofree = tofree;
523 else
524 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200525 return OK;
526
527errret:
528 ga_clear_strings(&newargs);
529 ga_clear_strings(&newlines);
530 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100531 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200532 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200533 evalarg->eval_tofree = tofree;
534 else
535 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200536 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 return FAIL;
538}
539
540/*
541 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
542 * name it contains, otherwise return "name".
543 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
544 * "partialp".
545 */
546 char_u *
547deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
548{
549 dictitem_T *v;
550 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200551 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200552
553 if (partialp != NULL)
554 *partialp = NULL;
555
556 cc = name[*lenp];
557 name[*lenp] = NUL;
558 v = find_var(name, NULL, no_autoload);
559 name[*lenp] = cc;
560 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
561 {
562 if (v->di_tv.vval.v_string == NULL)
563 {
564 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100565 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200566 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200567 s = v->di_tv.vval.v_string;
568 *lenp = (int)STRLEN(s);
569 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200570 }
571
572 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
573 {
574 partial_T *pt = v->di_tv.vval.v_partial;
575
576 if (pt == NULL)
577 {
578 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100579 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200580 }
581 if (partialp != NULL)
582 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200583 s = partial_name(pt);
584 *lenp = (int)STRLEN(s);
585 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200586 }
587
588 return name;
589}
590
591/*
592 * Give an error message with a function name. Handle <SNR> things.
593 * "ermsg" is to be passed without translation, use N_() instead of _().
594 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100595 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200596emsg_funcname(char *ermsg, char_u *name)
597{
598 char_u *p;
599
600 if (*name == K_SPECIAL)
601 p = concat_str((char_u *)"<SNR>", name + 3);
602 else
603 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100604 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200605 if (p != name)
606 vim_free(p);
607}
608
609/*
610 * Allocate a variable for the result of a function.
611 * Return OK or FAIL.
612 */
613 int
614get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200615 char_u *name, // name of the function
616 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200617 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200618 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200619 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200620 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200621{
622 char_u *argp;
623 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100624 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
625 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200626 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200627
628 /*
629 * Get the arguments.
630 */
631 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200632 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
633 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200634 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200635 // skip the '(' or ',' and possibly line breaks
636 argp = skipwhite_and_linebreak(argp + 1, evalarg);
637
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200638 if (*argp == ')' || *argp == ',' || *argp == NUL)
639 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200640 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200641 {
642 ret = FAIL;
643 break;
644 }
645 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200646 // The comma should come right after the argument, but this wasn't
647 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200648 if (vim9script)
649 {
650 if (*argp != ',' && *skipwhite(argp) == ',')
651 {
652 semsg(_(e_no_white_space_allowed_before_str), ",");
653 ret = FAIL;
654 break;
655 }
656 }
657 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200658 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200659 if (*argp != ',')
660 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200661 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
662 {
663 semsg(_(e_white_space_required_after_str), ",");
664 ret = FAIL;
665 break;
666 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200667 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200668 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200669 if (*argp == ')')
670 ++argp;
671 else
672 ret = FAIL;
673
674 if (ret == OK)
675 {
676 int i = 0;
677
678 if (get_vim_var_nr(VV_TESTING))
679 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100680 // Prepare for calling test_garbagecollect_now(), need to know
681 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200682 if (funcargs.ga_itemsize == 0)
683 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
684 for (i = 0; i < argcount; ++i)
685 if (ga_grow(&funcargs, 1) == OK)
686 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
687 &argvars[i];
688 }
689
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200690 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691
692 funcargs.ga_len -= i;
693 }
694 else if (!aborting())
695 {
696 if (argcount == MAX_FUNC_ARGS)
697 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
698 else
699 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
700 }
701
702 while (--argcount >= 0)
703 clear_tv(&argvars[argcount]);
704
Bram Moolenaar8294d492020-08-10 22:40:56 +0200705 if (in_vim9script())
706 *arg = argp;
707 else
708 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200709 return ret;
710}
711
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200712/*
713 * Return TRUE if "p" starts with "<SID>" or "s:".
714 * Only works if eval_fname_script() returned non-zero for "p"!
715 */
716 static int
717eval_fname_sid(char_u *p)
718{
719 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
720}
721
722/*
723 * In a script change <SID>name() and s:name() to K_SNR 123_name().
724 * Change <SNR>123_name() to K_SNR 123_name().
725 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
726 * (slow).
727 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100728 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200729fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
730{
731 int llen;
732 char_u *fname;
733 int i;
734
735 llen = eval_fname_script(name);
736 if (llen > 0)
737 {
738 fname_buf[0] = K_SPECIAL;
739 fname_buf[1] = KS_EXTRA;
740 fname_buf[2] = (int)KE_SNR;
741 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100742 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200743 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200744 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100745 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200746 else
747 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200748 sprintf((char *)fname_buf + 3, "%ld_",
749 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200750 i = (int)STRLEN(fname_buf);
751 }
752 }
753 if (i + STRLEN(name + llen) < FLEN_FIXED)
754 {
755 STRCPY(fname_buf + i, name + llen);
756 fname = fname_buf;
757 }
758 else
759 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200760 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200761 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100762 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200763 else
764 {
765 *tofree = fname;
766 mch_memmove(fname, fname_buf, (size_t)i);
767 STRCPY(fname + i, name + llen);
768 }
769 }
770 }
771 else
772 fname = name;
773 return fname;
774}
775
776/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100777 * Find a function "name" in script "sid".
778 */
779 static ufunc_T *
780find_func_with_sid(char_u *name, int sid)
781{
782 hashitem_T *hi;
783 char_u buffer[200];
784
785 buffer[0] = K_SPECIAL;
786 buffer[1] = KS_EXTRA;
787 buffer[2] = (int)KE_SNR;
788 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
789 (long)sid, name);
790 hi = hash_find(&func_hashtab, buffer);
791 if (!HASHITEM_EMPTY(hi))
792 return HI2UF(hi);
793
794 return NULL;
795}
796
797/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200798 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200799 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200800 * Return NULL for unknown function.
801 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200802 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200803find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200804{
805 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100806 ufunc_T *func;
807 imported_T *imported;
808
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200809 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100810 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200811 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200812 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +0200813 int find_script_local = in_vim9script()
814 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100815
Bram Moolenaar95006e32020-08-29 17:47:08 +0200816 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100817 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200818 // Find script-local function before global one.
819 func = find_func_with_sid(name, current_sctx.sc_sid);
820 if (func != NULL)
821 return func;
822 }
823
Bram Moolenaarefa94442020-08-08 22:16:00 +0200824 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200825 && name[1] == KS_EXTRA
826 && name[2] == KE_SNR)
827 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200828 // Caller changes s: to <SNR>99_name.
829
830 after_script = name + 3;
831 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200832 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200833 ++after_script;
834 else
835 after_script = NULL;
836 }
Bram Moolenaar95006e32020-08-29 17:47:08 +0200837 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200838 {
839 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200840 if (after_script != NULL && sid != current_sctx.sc_sid)
841 imported = find_imported_in_script(after_script, 0, sid);
842 else
843 imported = find_imported(after_script == NULL
844 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200845 if (imported != NULL && imported->imp_funcname != NULL)
846 {
847 hi = hash_find(&func_hashtab, imported->imp_funcname);
848 if (!HASHITEM_EMPTY(hi))
849 return HI2UF(hi);
850 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100851 }
852 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200853
Bram Moolenaara26b9702020-04-18 19:53:28 +0200854 hi = hash_find(&func_hashtab,
855 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200856 if (!HASHITEM_EMPTY(hi))
857 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100858
859 return NULL;
860}
861
862/*
863 * Find a function by name, return pointer to it in ufuncs.
864 * "cctx" is passed in a :def function to find imported functions.
865 * Return NULL for unknown or dead function.
866 */
867 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200868find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100869{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200870 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100871
872 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
873 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200874 return NULL;
875}
876
877/*
Bram Moolenaar0f769812020-09-12 18:32:34 +0200878 * Return TRUE if "ufunc" is a global function.
879 */
880 int
881func_is_global(ufunc_T *ufunc)
882{
883 return ufunc->uf_name[0] != K_SPECIAL;
884}
885
886/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200887 * Copy the function name of "fp" to buffer "buf".
888 * "buf" must be able to hold the function name plus three bytes.
889 * Takes care of script-local function names.
890 */
891 static void
892cat_func_name(char_u *buf, ufunc_T *fp)
893{
Bram Moolenaar0f769812020-09-12 18:32:34 +0200894 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200895 {
896 STRCPY(buf, "<SNR>");
897 STRCAT(buf, fp->uf_name + 3);
898 }
899 else
900 STRCPY(buf, fp->uf_name);
901}
902
903/*
904 * Add a number variable "name" to dict "dp" with value "nr".
905 */
906 static void
907add_nr_var(
908 dict_T *dp,
909 dictitem_T *v,
910 char *name,
911 varnumber_T nr)
912{
913 STRCPY(v->di_key, name);
914 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
915 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
916 v->di_tv.v_type = VAR_NUMBER;
917 v->di_tv.v_lock = VAR_FIXED;
918 v->di_tv.vval.v_number = nr;
919}
920
921/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100922 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200923 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100924 static void
925free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200926{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100927 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200928
929 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
930 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100931 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200932
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100933 // When garbage collecting a funccall_T may be freed before the
934 // function that references it, clear its uf_scoped field.
935 // The function may have been redefined and point to another
936 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200937 if (fp != NULL && fp->uf_scoped == fc)
938 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200939 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200940 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200941
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200942 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200943 vim_free(fc);
944}
945
946/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100947 * Free "fc" and what it contains.
948 * Can be called only when "fc" is kept beyond the period of it called,
949 * i.e. after cleanup_function_call(fc).
950 */
951 static void
952free_funccal_contents(funccall_T *fc)
953{
954 listitem_T *li;
955
956 // Free all l: variables.
957 vars_clear(&fc->l_vars.dv_hashtab);
958
959 // Free all a: variables.
960 vars_clear(&fc->l_avars.dv_hashtab);
961
962 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200963 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100964 clear_tv(&li->li_tv);
965
966 free_funccal(fc);
967}
968
969/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200970 * Handle the last part of returning from a function: free the local hashtable.
971 * Unless it is still in use by a closure.
972 */
973 static void
974cleanup_function_call(funccall_T *fc)
975{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100976 int may_free_fc = fc->fc_refcount <= 0;
977 int free_fc = TRUE;
978
Bram Moolenaar6914c642017-04-01 21:21:30 +0200979 current_funccal = fc->caller;
980
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100981 // Free all l: variables if not referred.
982 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
983 vars_clear(&fc->l_vars.dv_hashtab);
984 else
985 free_fc = FALSE;
986
987 // If the a:000 list and the l: and a: dicts are not referenced and
988 // there is no closure using it, we can free the funccall_T and what's
989 // in it.
990 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
991 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200992 else
993 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100994 int todo;
995 hashitem_T *hi;
996 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200997
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100998 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200999
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001000 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001001 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1002 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1003 {
1004 if (!HASHITEM_EMPTY(hi))
1005 {
1006 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001007 di = HI2DI(hi);
1008 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001009 }
1010 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001011 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001012
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001013 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1014 fc->l_varlist.lv_first = NULL;
1015 else
1016 {
1017 listitem_T *li;
1018
1019 free_fc = FALSE;
1020
1021 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001022 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001023 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001024 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001025
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001026 if (free_fc)
1027 free_funccal(fc);
1028 else
1029 {
1030 static int made_copy = 0;
1031
1032 // "fc" is still in use. This can happen when returning "a:000",
1033 // assigning "l:" to a global variable or defining a closure.
1034 // Link "fc" in the list for garbage collection later.
1035 fc->caller = previous_funccal;
1036 previous_funccal = fc;
1037
1038 if (want_garbage_collect)
1039 // If garbage collector is ready, clear count.
1040 made_copy = 0;
1041 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001042 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001043 // We have made a lot of copies, worth 4 Mbyte. This can happen
1044 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001045 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001046 // too much memory.
1047 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001048 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001049 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001050 }
1051}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001052
1053/*
1054 * There are two kinds of function names:
1055 * 1. ordinary names, function defined with :function or :def
1056 * 2. numbered functions and lambdas
1057 * For the first we only count the name stored in func_hashtab as a reference,
1058 * using function() does not count as a reference, because the function is
1059 * looked up by name.
1060 */
1061 static int
1062func_name_refcount(char_u *name)
1063{
1064 return isdigit(*name) || *name == '<';
1065}
1066
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001067/*
1068 * Unreference "fc": decrement the reference count and free it when it
1069 * becomes zero. "fp" is detached from "fc".
1070 * When "force" is TRUE we are exiting.
1071 */
1072 static void
1073funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1074{
1075 funccall_T **pfc;
1076 int i;
1077
1078 if (fc == NULL)
1079 return;
1080
1081 if (--fc->fc_refcount <= 0 && (force || (
1082 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1083 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1084 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1085 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1086 {
1087 if (fc == *pfc)
1088 {
1089 *pfc = fc->caller;
1090 free_funccal_contents(fc);
1091 return;
1092 }
1093 }
1094 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1095 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1096 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1097}
1098
1099/*
1100 * Remove the function from the function hashtable. If the function was
1101 * deleted while it still has references this was already done.
1102 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1103 */
1104 static int
1105func_remove(ufunc_T *fp)
1106{
1107 hashitem_T *hi;
1108
1109 // Return if it was already virtually deleted.
1110 if (fp->uf_flags & FC_DEAD)
1111 return FALSE;
1112
1113 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1114 if (!HASHITEM_EMPTY(hi))
1115 {
1116 // When there is a def-function index do not actually remove the
1117 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001118 // Do remove it when it's a copy.
1119 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001120 fp->uf_flags |= FC_DEAD;
1121 else
1122 hash_remove(&func_hashtab, hi);
1123 return TRUE;
1124 }
1125 return FALSE;
1126}
1127
1128 static void
1129func_clear_items(ufunc_T *fp)
1130{
1131 ga_clear_strings(&(fp->uf_args));
1132 ga_clear_strings(&(fp->uf_def_args));
1133 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001134 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001135 VIM_CLEAR(fp->uf_def_arg_idx);
1136 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001137 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001138
1139#ifdef FEAT_LUA
1140 if (fp->uf_cb_free != NULL)
1141 {
1142 fp->uf_cb_free(fp->uf_cb_state);
1143 fp->uf_cb_free = NULL;
1144 }
1145
1146 fp->uf_cb_state = NULL;
1147 fp->uf_cb = NULL;
1148#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001149#ifdef FEAT_PROFILE
1150 VIM_CLEAR(fp->uf_tml_count);
1151 VIM_CLEAR(fp->uf_tml_total);
1152 VIM_CLEAR(fp->uf_tml_self);
1153#endif
1154}
1155
1156/*
1157 * Free all things that a function contains. Does not free the function
1158 * itself, use func_free() for that.
1159 * When "force" is TRUE we are exiting.
1160 */
1161 static void
1162func_clear(ufunc_T *fp, int force)
1163{
1164 if (fp->uf_cleared)
1165 return;
1166 fp->uf_cleared = TRUE;
1167
1168 // clear this function
1169 func_clear_items(fp);
1170 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001171 if ((fp->uf_flags & FC_COPY) == 0)
1172 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001173}
1174
1175/*
1176 * Free a function and remove it from the list of functions. Does not free
1177 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001178 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001179 */
1180 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001181func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001182{
1183 // Only remove it when not done already, otherwise we would remove a newer
1184 // version of the function with the same name.
1185 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1186 func_remove(fp);
1187
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001188 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001189 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001190 if (fp->uf_dfunc_idx > 0)
1191 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001192 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001193 vim_free(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001194 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001195}
1196
1197/*
1198 * Free all things that a function contains and free the function itself.
1199 * When "force" is TRUE we are exiting.
1200 */
1201 static void
1202func_clear_free(ufunc_T *fp, int force)
1203{
1204 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001205 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1206 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001207 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001208 else
1209 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001210}
1211
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001212/*
1213 * Copy already defined function "lambda" to a new function with name "global".
1214 * This is for when a compiled function defines a global function.
1215 */
1216 void
1217copy_func(char_u *lambda, char_u *global)
1218{
1219 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1220 ufunc_T *fp;
1221
1222 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001223 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001224 else
1225 {
1226 // TODO: handle ! to overwrite
1227 fp = find_func(global, TRUE, NULL);
1228 if (fp != NULL)
1229 {
1230 semsg(_(e_funcexts), global);
1231 return;
1232 }
1233
1234 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1235 if (fp == NULL)
1236 return;
1237
1238 fp->uf_varargs = ufunc->uf_varargs;
1239 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1240 fp->uf_def_status = ufunc->uf_def_status;
1241 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001242 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1243 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001244 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001245 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001246 goto failed;
1247
1248 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1249 : vim_strsave(ufunc->uf_name_exp);
1250 if (ufunc->uf_arg_types != NULL)
1251 {
1252 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1253 if (fp->uf_arg_types == NULL)
1254 goto failed;
1255 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1256 sizeof(type_T *) * fp->uf_args.ga_len);
1257 }
1258 if (ufunc->uf_def_arg_idx != NULL)
1259 {
1260 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1261 if (fp->uf_def_arg_idx == NULL)
1262 goto failed;
1263 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1264 sizeof(int) * fp->uf_def_args.ga_len + 1);
1265 }
1266 if (ufunc->uf_va_name != NULL)
1267 {
1268 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1269 if (fp->uf_va_name == NULL)
1270 goto failed;
1271 }
1272
1273 fp->uf_refcount = 1;
1274 STRCPY(fp->uf_name, global);
1275 hash_add(&func_hashtab, UF2HIKEY(fp));
1276 }
1277 return;
1278
1279failed:
1280 func_clear_free(fp, TRUE);
1281}
1282
Bram Moolenaar6914c642017-04-01 21:21:30 +02001283
1284/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 * Call a user function.
1286 */
1287 static void
1288call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001289 ufunc_T *fp, // pointer to function
1290 int argcount, // nr of args
1291 typval_T *argvars, // arguments
1292 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001293 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001294 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001296 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001297 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001298 funccall_T *fc;
1299 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001300 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001301 static int depth = 0;
1302 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001303 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001304 int i;
1305 int ai;
1306 int islambda = FALSE;
1307 char_u numbuf[NUMBUFLEN];
1308 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309#ifdef FEAT_PROFILE
1310 proftime_T wait_start;
1311 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001312 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001313#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001314 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001315
Bram Moolenaare38eab22019-12-05 21:50:01 +01001316 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 if (depth >= p_mfd)
1318 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001319 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001320 rettv->v_type = VAR_NUMBER;
1321 rettv->vval.v_number = -1;
1322 return;
1323 }
1324 ++depth;
1325
Bram Moolenaare38eab22019-12-05 21:50:01 +01001326 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001327
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001328 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001329 if (fc == NULL)
1330 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001331 fc->caller = current_funccal;
1332 current_funccal = fc;
1333 fc->func = fp;
1334 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001335 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001336 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001337 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1338 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001339 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001340 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001341 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001342
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001343 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001344 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001345 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001346 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001347 --depth;
1348 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001349 free_funccal(fc);
1350 return;
1351 }
1352
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001353 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1354 islambda = TRUE;
1355
1356 /*
1357 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1358 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1359 * each argument variable and saves a lot of time.
1360 */
1361 /*
1362 * Init l: variables.
1363 */
1364 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1365 if (selfdict != NULL)
1366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001367 // Set l:self to "selfdict". Use "name" to avoid a warning from
1368 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369 v = &fc->fixvar[fixvar_idx++].var;
1370 name = v->di_key;
1371 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001372 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001373 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1374 v->di_tv.v_type = VAR_DICT;
1375 v->di_tv.v_lock = 0;
1376 v->di_tv.vval.v_dict = selfdict;
1377 ++selfdict->dv_refcount;
1378 }
1379
1380 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001381 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001382 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383 * Set a:000 to a list with room for the "..." arguments.
1384 */
1385 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001386 if ((fp->uf_flags & FC_NOARGS) == 0)
1387 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001388 (varnumber_T)(argcount >= fp->uf_args.ga_len
1389 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001390 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001391 if ((fp->uf_flags & FC_NOARGS) == 0)
1392 {
1393 // Use "name" to avoid a warning from some compiler that checks the
1394 // destination size.
1395 v = &fc->fixvar[fixvar_idx++].var;
1396 name = v->di_key;
1397 STRCPY(name, "000");
1398 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1399 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1400 v->di_tv.v_type = VAR_LIST;
1401 v->di_tv.v_lock = VAR_FIXED;
1402 v->di_tv.vval.v_list = &fc->l_varlist;
1403 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001404 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001405 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1406 fc->l_varlist.lv_lock = VAR_FIXED;
1407
1408 /*
1409 * Set a:firstline to "firstline" and a:lastline to "lastline".
1410 * Set a:name to named arguments.
1411 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001412 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001413 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001414 if ((fp->uf_flags & FC_NOARGS) == 0)
1415 {
1416 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001417 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001418 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001419 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001420 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001421 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422 {
1423 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001424 typval_T def_rettv;
1425 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001426
1427 ai = i - fp->uf_args.ga_len;
1428 if (ai < 0)
1429 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001430 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001431 name = FUNCARG(fp, i);
1432 if (islambda)
1433 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001434
1435 // evaluate named argument default expression
1436 isdefault = ai + fp->uf_def_args.ga_len >= 0
1437 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1438 && argvars[i].vval.v_number == VVAL_NONE));
1439 if (isdefault)
1440 {
1441 char_u *default_expr = NULL;
1442 def_rettv.v_type = VAR_NUMBER;
1443 def_rettv.vval.v_number = -1;
1444
1445 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1446 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001447 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001448 {
1449 default_arg_err = 1;
1450 break;
1451 }
1452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453 }
1454 else
1455 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001456 if ((fp->uf_flags & FC_NOARGS) != 0)
1457 // Bail out if no a: arguments used (in lambda).
1458 break;
1459
Bram Moolenaare38eab22019-12-05 21:50:01 +01001460 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001461 sprintf((char *)numbuf, "%d", ai + 1);
1462 name = numbuf;
1463 }
1464 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1465 {
1466 v = &fc->fixvar[fixvar_idx++].var;
1467 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001468 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001469 }
1470 else
1471 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001472 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001473 if (v == NULL)
1474 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001475 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001478 // Note: the values are copied directly to avoid alloc/free.
1479 // "argvars" must have VAR_FIXED for v_lock.
1480 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481 v->di_tv.v_lock = VAR_FIXED;
1482
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483 if (addlocal)
1484 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001485 // Named arguments should be accessed without the "a:" prefix in
1486 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001487 copy_tv(&v->di_tv, &v->di_tv);
1488 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001489 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001490 else
1491 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492
1493 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1494 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001495 listitem_T *li = &fc->l_listitems[ai];
1496
1497 li->li_tv = argvars[i];
1498 li->li_tv.v_lock = VAR_FIXED;
1499 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500 }
1501 }
1502
Bram Moolenaare38eab22019-12-05 21:50:01 +01001503 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001504 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001505
1506 if (fp->uf_flags & FC_SANDBOX)
1507 {
1508 using_sandbox = TRUE;
1509 ++sandbox;
1510 }
1511
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001512 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001513 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001514 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001516 ++no_wait_return;
1517 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001518
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001519 smsg(_("calling %s"), SOURCING_NAME);
1520 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001521 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001522 char_u buf[MSG_BUF_LEN];
1523 char_u numbuf2[NUMBUFLEN];
1524 char_u *tofree;
1525 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001527 msg_puts("(");
1528 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001530 if (i > 0)
1531 msg_puts(", ");
1532 if (argvars[i].v_type == VAR_NUMBER)
1533 msg_outnum((long)argvars[i].vval.v_number);
1534 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001535 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001536 // Do not want errors such as E724 here.
1537 ++emsg_off;
1538 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1539 --emsg_off;
1540 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001541 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001542 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001544 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1545 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001546 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001547 msg_puts((char *)s);
1548 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 }
1550 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001551 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001552 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001554 msg_puts("\n"); // don't overwrite this either
1555
1556 verbose_leave_scroll();
1557 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001558 }
1559#ifdef FEAT_PROFILE
1560 if (do_profiling == PROF_YES)
1561 {
1562 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001563 {
1564 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001566 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001567 if (fp->uf_profiling
1568 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1569 {
1570 ++fp->uf_tm_count;
1571 profile_start(&call_start);
1572 profile_zero(&fp->uf_tm_children);
1573 }
1574 script_prof_save(&wait_start);
1575 }
1576#endif
1577
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001578 save_current_sctx = current_sctx;
1579 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580 save_did_emsg = did_emsg;
1581 did_emsg = FALSE;
1582
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001583 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1584 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001585 else if (islambda)
1586 {
1587 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1588
1589 // A Lambda always has the command "return {expr}". It is much faster
1590 // to evaluate {expr} directly.
1591 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001592 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001593 --ex_nesting_level;
1594 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001595 else
1596 // call do_cmdline() to execute the lines
1597 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1599
1600 --RedrawingDisabled;
1601
Bram Moolenaare38eab22019-12-05 21:50:01 +01001602 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1604 {
1605 clear_tv(rettv);
1606 rettv->v_type = VAR_NUMBER;
1607 rettv->vval.v_number = -1;
1608 }
1609
1610#ifdef FEAT_PROFILE
1611 if (do_profiling == PROF_YES && (fp->uf_profiling
1612 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1613 {
1614 profile_end(&call_start);
1615 profile_sub_wait(&wait_start, &call_start);
1616 profile_add(&fp->uf_tm_total, &call_start);
1617 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1618 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1619 {
1620 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1621 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1622 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001623 if (started_profiling)
1624 // make a ":profdel func" stop profiling the function
1625 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626 }
1627#endif
1628
Bram Moolenaare38eab22019-12-05 21:50:01 +01001629 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630 if (p_verbose >= 12)
1631 {
1632 ++no_wait_return;
1633 verbose_enter_scroll();
1634
1635 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001636 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001638 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 (long)fc->rettv->vval.v_number);
1640 else
1641 {
1642 char_u buf[MSG_BUF_LEN];
1643 char_u numbuf2[NUMBUFLEN];
1644 char_u *tofree;
1645 char_u *s;
1646
Bram Moolenaare38eab22019-12-05 21:50:01 +01001647 // The value may be very long. Skip the middle part, so that we
1648 // have some idea how it starts and ends. smsg() would always
1649 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 ++emsg_off;
1651 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1652 --emsg_off;
1653 if (s != NULL)
1654 {
1655 if (vim_strsize(s) > MSG_BUF_CLEN)
1656 {
1657 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1658 s = buf;
1659 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001660 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 vim_free(tofree);
1662 }
1663 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001664 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665
1666 verbose_leave_scroll();
1667 --no_wait_return;
1668 }
1669
Bram Moolenaare31ee862020-01-07 20:59:34 +01001670 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001671 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001672 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001673#ifdef FEAT_PROFILE
1674 if (do_profiling == PROF_YES)
1675 script_prof_restore(&wait_start);
1676#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001677 if (using_sandbox)
1678 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001680 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 {
1682 ++no_wait_return;
1683 verbose_enter_scroll();
1684
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001685 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001686 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687
1688 verbose_leave_scroll();
1689 --no_wait_return;
1690 }
1691
1692 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 --depth;
1694
Bram Moolenaar6914c642017-04-01 21:21:30 +02001695 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696}
1697
1698/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001699 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001700 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001701 int
1702call_user_func_check(
1703 ufunc_T *fp,
1704 int argcount,
1705 typval_T *argvars,
1706 typval_T *rettv,
1707 funcexe_T *funcexe,
1708 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001709{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001710 int error;
1711 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001712
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001713 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1714 *funcexe->doesrange = TRUE;
1715 if (argcount < regular_args - fp->uf_def_args.ga_len)
1716 error = FCERR_TOOFEW;
1717 else if (!has_varargs(fp) && argcount > regular_args)
1718 error = FCERR_TOOMANY;
1719 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1720 error = FCERR_DICT;
1721 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001722 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001723 int did_save_redo = FALSE;
1724 save_redo_T save_redo;
1725
1726 /*
1727 * Call the user function.
1728 * Save and restore search patterns, script variables and
1729 * redo buffer.
1730 */
1731 save_search_patterns();
1732 if (!ins_compl_active())
1733 {
1734 saveRedobuff(&save_redo);
1735 did_save_redo = TRUE;
1736 }
1737 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001738 call_user_func(fp, argcount, argvars, rettv, funcexe,
1739 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001740 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1741 // Function was unreferenced while being used, free it now.
1742 func_clear_free(fp, FALSE);
1743 if (did_save_redo)
1744 restoreRedobuff(&save_redo);
1745 restore_search_patterns();
1746 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001747 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001748 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001749}
1750
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001751static funccal_entry_T *funccal_stack = NULL;
1752
1753/*
1754 * Save the current function call pointer, and set it to NULL.
1755 * Used when executing autocommands and for ":source".
1756 */
1757 void
1758save_funccal(funccal_entry_T *entry)
1759{
1760 entry->top_funccal = current_funccal;
1761 entry->next = funccal_stack;
1762 funccal_stack = entry;
1763 current_funccal = NULL;
1764}
1765
1766 void
1767restore_funccal(void)
1768{
1769 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001770 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001771 else
1772 {
1773 current_funccal = funccal_stack->top_funccal;
1774 funccal_stack = funccal_stack->next;
1775 }
1776}
1777
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001778 funccall_T *
1779get_current_funccal(void)
1780{
1781 return current_funccal;
1782}
1783
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001784/*
1785 * Mark all functions of script "sid" as deleted.
1786 */
1787 void
1788delete_script_functions(int sid)
1789{
1790 hashitem_T *hi;
1791 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001792 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001793 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001794 size_t len;
1795
1796 buf[0] = K_SPECIAL;
1797 buf[1] = KS_EXTRA;
1798 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001799 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001800 len = STRLEN(buf);
1801
Bram Moolenaarce658352020-07-31 23:47:12 +02001802 while (todo > 0)
1803 {
1804 todo = func_hashtab.ht_used;
1805 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1806 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001807 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001808 fp = HI2UF(hi);
1809 if (STRNCMP(fp->uf_name, buf, len) == 0)
1810 {
1811 int changed = func_hashtab.ht_changed;
1812
1813 fp->uf_flags |= FC_DEAD;
1814 func_clear(fp, TRUE);
1815 // When clearing a function another function can be cleared
1816 // as a side effect. When that happens start over.
1817 if (changed != func_hashtab.ht_changed)
1818 break;
1819 }
1820 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001821 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001822 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001823}
1824
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825#if defined(EXITFREE) || defined(PROTO)
1826 void
1827free_all_functions(void)
1828{
1829 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001830 ufunc_T *fp;
1831 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001832 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001833 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834
Bram Moolenaare38eab22019-12-05 21:50:01 +01001835 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001836 while (current_funccal != NULL)
1837 {
1838 clear_tv(current_funccal->rettv);
1839 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001840 if (current_funccal == NULL && funccal_stack != NULL)
1841 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001842 }
1843
Bram Moolenaare38eab22019-12-05 21:50:01 +01001844 // First clear what the functions contain. Since this may lower the
1845 // reference count of a function, it may also free a function and change
1846 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001847 while (todo > 0)
1848 {
1849 todo = func_hashtab.ht_used;
1850 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1851 if (!HASHITEM_EMPTY(hi))
1852 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001853 // clear the def function index now
1854 fp = HI2UF(hi);
1855 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001856 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001857
Bram Moolenaare38eab22019-12-05 21:50:01 +01001858 // Only free functions that are not refcounted, those are
1859 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001860 if (func_name_refcount(fp->uf_name))
1861 ++skipped;
1862 else
1863 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001864 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001865 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001866 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001867 {
1868 skipped = 0;
1869 break;
1870 }
1871 }
1872 --todo;
1873 }
1874 }
1875
Bram Moolenaare38eab22019-12-05 21:50:01 +01001876 // Now actually free the functions. Need to start all over every time,
1877 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001878 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001879 while (func_hashtab.ht_used > skipped)
1880 {
1881 todo = func_hashtab.ht_used;
1882 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001883 if (!HASHITEM_EMPTY(hi))
1884 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001885 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001886 // Only free functions that are not refcounted, those are
1887 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001888 fp = HI2UF(hi);
1889 if (func_name_refcount(fp->uf_name))
1890 ++skipped;
1891 else
1892 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001893 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001894 skipped = 0;
1895 break;
1896 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001897 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001898 }
1899 if (skipped == 0)
1900 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001901
1902 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001903}
1904#endif
1905
1906/*
1907 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001908 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 * "len" is the length of "name", or -1 for NUL terminated.
1910 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001911 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001912builtin_function(char_u *name, int len)
1913{
1914 char_u *p;
1915
Bram Moolenaara26b9702020-04-18 19:53:28 +02001916 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 return FALSE;
1918 p = vim_strchr(name, AUTOLOAD_CHAR);
1919 return p == NULL || (len > 0 && p > name + len);
1920}
1921
1922 int
1923func_call(
1924 char_u *name,
1925 typval_T *args,
1926 partial_T *partial,
1927 dict_T *selfdict,
1928 typval_T *rettv)
1929{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001930 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001931 listitem_T *item;
1932 typval_T argv[MAX_FUNC_ARGS + 1];
1933 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 int r = 0;
1935
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001936 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001937 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938 {
1939 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1940 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001941 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001942 break;
1943 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001944 // Make a copy of each argument. This is needed to be able to set
1945 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001946 copy_tv(&item->li_tv, &argv[argc++]);
1947 }
1948
1949 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001950 {
1951 funcexe_T funcexe;
1952
Bram Moolenaara80faa82020-04-12 19:37:17 +02001953 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001954 funcexe.firstline = curwin->w_cursor.lnum;
1955 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001956 funcexe.evaluate = TRUE;
1957 funcexe.partial = partial;
1958 funcexe.selfdict = selfdict;
1959 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1960 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961
Bram Moolenaare38eab22019-12-05 21:50:01 +01001962 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001963 while (argc > 0)
1964 clear_tv(&argv[--argc]);
1965
1966 return r;
1967}
1968
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001969static int callback_depth = 0;
1970
1971 int
1972get_callback_depth(void)
1973{
1974 return callback_depth;
1975}
1976
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001977/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001978 * Invoke call_func() with a callback.
1979 */
1980 int
1981call_callback(
1982 callback_T *callback,
1983 int len, // length of "name" or -1 to use strlen()
1984 typval_T *rettv, // return value goes here
1985 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001986 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001987 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001988{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001989 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001990 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001991
Bram Moolenaara80faa82020-04-12 19:37:17 +02001992 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001993 funcexe.evaluate = TRUE;
1994 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001995 ++callback_depth;
1996 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1997 --callback_depth;
1998 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001999}
2000
2001/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002 * Give an error message for the result of a function.
2003 * Nothing if "error" is FCERR_NONE.
2004 */
2005 void
2006user_func_error(int error, char_u *name)
2007{
2008 switch (error)
2009 {
2010 case FCERR_UNKNOWN:
2011 emsg_funcname(e_unknownfunc, name);
2012 break;
2013 case FCERR_NOTMETHOD:
2014 emsg_funcname(
2015 N_("E276: Cannot use function as a method: %s"), name);
2016 break;
2017 case FCERR_DELETED:
2018 emsg_funcname(N_(e_func_deleted), name);
2019 break;
2020 case FCERR_TOOMANY:
2021 emsg_funcname((char *)e_toomanyarg, name);
2022 break;
2023 case FCERR_TOOFEW:
2024 emsg_funcname((char *)e_toofewarg, name);
2025 break;
2026 case FCERR_SCRIPT:
2027 emsg_funcname(
2028 N_("E120: Using <SID> not in a script context: %s"), name);
2029 break;
2030 case FCERR_DICT:
2031 emsg_funcname(
2032 N_("E725: Calling dict function without Dictionary: %s"),
2033 name);
2034 break;
2035 }
2036}
2037
2038/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002040 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002041 * Return FAIL when the function can't be called, OK otherwise.
2042 * Also returns OK when an error was encountered while executing the function.
2043 */
2044 int
2045call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002046 char_u *funcname, // name of the function
2047 int len, // length of "name" or -1 to use strlen()
2048 typval_T *rettv, // return value goes here
2049 int argcount_in, // number of "argvars"
2050 typval_T *argvars_in, // vars for arguments, must have "argcount"
2051 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002052 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002053{
2054 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002055 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002056 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002057 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058 char_u fname_buf[FLEN_FIXED + 1];
2059 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002060 char_u *fname = NULL;
2061 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002062 int argcount = argcount_in;
2063 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002064 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002065 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2066 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002067 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002068 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002069 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002070
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002071 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2072 // even when call_func() returns FAIL.
2073 rettv->v_type = VAR_UNKNOWN;
2074
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002075 if (partial != NULL)
2076 fp = partial->pt_func;
2077 if (fp == NULL)
2078 {
2079 // Make a copy of the name, if it comes from a funcref variable it
2080 // could be changed or deleted in the called function.
2081 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2082 if (name == NULL)
2083 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002084
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002085 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2086 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002087
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002088 if (funcexe->doesrange != NULL)
2089 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002090
2091 if (partial != NULL)
2092 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002093 // When the function has a partial with a dict and there is a dict
2094 // argument, use the dict argument. That is backwards compatible.
2095 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002096 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002097 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002098 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002099 {
2100 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002101 {
2102 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2103 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002104 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002105 goto theend;
2106 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002107 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002108 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002109 for (i = 0; i < argcount_in; ++i)
2110 argv[i + argv_clear] = argvars_in[i];
2111 argvars = argv;
2112 argcount = partial->pt_argc + argcount_in;
2113 }
2114 }
2115
Bram Moolenaaref140542019-12-31 21:27:13 +01002116 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002117 {
2118 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002119 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120
Bram Moolenaar333894b2020-08-01 18:53:07 +02002121 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002122 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002123 {
2124 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002126 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002127
Bram Moolenaare38eab22019-12-05 21:50:01 +01002128 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002129 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002130 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002131
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002132 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002133 {
2134 /*
2135 * User defined function.
2136 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002137 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002138 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002139
Bram Moolenaare38eab22019-12-05 21:50:01 +01002140 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141 if (fp == NULL
2142 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002143 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002144 && !aborting())
2145 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002146 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002147 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002148 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002149 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002150 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2151 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002152 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002153 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002154 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002155 if (fp == NULL)
2156 {
2157 char_u *p = untrans_function_name(rfname);
2158
2159 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002160 // Don't do this if the name starts with "s:".
2161 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002162 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002163 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002164
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002165 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002166 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002167#ifdef FEAT_LUA
2168 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2169 {
2170 cfunc_T cb = fp->uf_cb;
2171
2172 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2173 }
2174#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002175 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002177 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002178 // postponed filling in the arguments, do it now
2179 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002180 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002181
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002182 if (funcexe->basetv != NULL)
2183 {
2184 // Method call: base->Method()
2185 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2186 argv[0] = *funcexe->basetv;
2187 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002188 argvars = argv;
2189 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002190 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002191
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002192 error = call_user_func_check(fp, argcount, argvars, rettv,
2193 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194 }
2195 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002196 else if (funcexe->basetv != NULL)
2197 {
2198 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002199 * expr->method(): Find the method name in the table, call its
2200 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002201 */
2202 error = call_internal_method(fname, argcount, argvars, rettv,
2203 funcexe->basetv);
2204 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002205 else
2206 {
2207 /*
2208 * Find the function name in the table, call its implementation.
2209 */
2210 error = call_internal_func(fname, argcount, argvars, rettv);
2211 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002212
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002213 /*
2214 * The function call (or "FuncUndefined" autocommand sequence) might
2215 * have been aborted by an error, an interrupt, or an explicitly thrown
2216 * exception that has not been caught so far. This situation can be
2217 * tested for by calling aborting(). For an error in an internal
2218 * function or for the "E132" error in call_user_func(), however, the
2219 * throw point at which the "force_abort" flag (temporarily reset by
2220 * emsg()) is normally updated has not been reached yet. We need to
2221 * update that flag first to make aborting() reliable.
2222 */
2223 update_force_abort();
2224 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002225 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226 ret = OK;
2227
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002228theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229 /*
2230 * Report an error unless the argument evaluation or function call has been
2231 * cancelled due to an aborting error, an interrupt, or an exception.
2232 */
2233 if (!aborting())
2234 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002235 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002236 }
2237
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002238 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002239 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002240 clear_tv(&argv[--argv_clear + argv_base]);
2241
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002242 vim_free(tofree);
2243 vim_free(name);
2244
2245 return ret;
2246}
2247
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002248 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002249printable_func_name(ufunc_T *fp)
2250{
2251 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2252}
2253
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002254/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002255 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002256 */
2257 static void
2258list_func_head(ufunc_T *fp, int indent)
2259{
2260 int j;
2261
2262 msg_start();
2263 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002264 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002265 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002266 msg_puts("def ");
2267 else
2268 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002269 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002270 msg_putchar('(');
2271 for (j = 0; j < fp->uf_args.ga_len; ++j)
2272 {
2273 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002274 msg_puts(", ");
2275 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002276 if (fp->uf_arg_types != NULL)
2277 {
2278 char *tofree;
2279
2280 msg_puts(": ");
2281 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2282 vim_free(tofree);
2283 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002284 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2285 {
2286 msg_puts(" = ");
2287 msg_puts(((char **)(fp->uf_def_args.ga_data))
2288 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2289 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290 }
2291 if (fp->uf_varargs)
2292 {
2293 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002294 msg_puts(", ");
2295 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002296 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002297 if (fp->uf_va_name != NULL)
2298 {
2299 if (j)
2300 msg_puts(", ");
2301 msg_puts("...");
2302 msg_puts((char *)fp->uf_va_name);
2303 if (fp->uf_va_type)
2304 {
2305 char *tofree;
2306
2307 msg_puts(": ");
2308 msg_puts(type_name(fp->uf_va_type, &tofree));
2309 vim_free(tofree);
2310 }
2311 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002312 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002313
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002314 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002315 {
2316 if (fp->uf_ret_type != &t_void)
2317 {
2318 char *tofree;
2319
2320 msg_puts(": ");
2321 msg_puts(type_name(fp->uf_ret_type, &tofree));
2322 vim_free(tofree);
2323 }
2324 }
2325 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002326 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002328 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002329 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002330 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002331 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002332 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 msg_clr_eos();
2334 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002335 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336}
2337
2338/*
2339 * Get a function name, translating "<SID>" and "<SNR>".
2340 * Also handles a Funcref in a List or Dictionary.
2341 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002342 * Set "*is_global" to TRUE when the function must be global, unless
2343 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 * flags:
2345 * TFN_INT: internal function name OK
2346 * TFN_QUIET: be quiet
2347 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002348 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 * Advances "pp" to just after the function name (if no error).
2350 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002351 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352trans_function_name(
2353 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002354 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002355 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002356 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002357 funcdict_T *fdp, // return: info about dictionary used
2358 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359{
2360 char_u *name = NULL;
2361 char_u *start;
2362 char_u *end;
2363 int lead;
2364 char_u sid_buf[20];
2365 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002366 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002368 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369
2370 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002371 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 start = *pp;
2373
Bram Moolenaare38eab22019-12-05 21:50:01 +01002374 // Check for hard coded <SNR>: already translated function ID (from a user
2375 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2377 && (*pp)[2] == (int)KE_SNR)
2378 {
2379 *pp += 3;
2380 len = get_id_len(pp) + 3;
2381 return vim_strnsave(start, len);
2382 }
2383
Bram Moolenaare38eab22019-12-05 21:50:01 +01002384 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2385 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002386 lead = eval_fname_script(start);
2387 if (lead > 2)
2388 start += lead;
2389
Bram Moolenaare38eab22019-12-05 21:50:01 +01002390 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002391 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392 lead > 2 ? 0 : FNE_CHECK_START);
2393 if (end == start)
2394 {
2395 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002396 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002397 goto theend;
2398 }
2399 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2400 {
2401 /*
2402 * Report an invalid expression in braces, unless the expression
2403 * evaluation has been cancelled due to an aborting error, an
2404 * interrupt, or an exception.
2405 */
2406 if (!aborting())
2407 {
2408 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002409 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410 }
2411 else
2412 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2413 goto theend;
2414 }
2415
2416 if (lv.ll_tv != NULL)
2417 {
2418 if (fdp != NULL)
2419 {
2420 fdp->fd_dict = lv.ll_dict;
2421 fdp->fd_newkey = lv.ll_newkey;
2422 lv.ll_newkey = NULL;
2423 fdp->fd_di = lv.ll_di;
2424 }
2425 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2426 {
2427 name = vim_strsave(lv.ll_tv->vval.v_string);
2428 *pp = end;
2429 }
2430 else if (lv.ll_tv->v_type == VAR_PARTIAL
2431 && lv.ll_tv->vval.v_partial != NULL)
2432 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002433 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 *pp = end;
2435 if (partial != NULL)
2436 *partial = lv.ll_tv->vval.v_partial;
2437 }
2438 else
2439 {
2440 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2441 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002442 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443 else
2444 *pp = end;
2445 name = NULL;
2446 }
2447 goto theend;
2448 }
2449
2450 if (lv.ll_name == NULL)
2451 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002452 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 *pp = end;
2454 goto theend;
2455 }
2456
Bram Moolenaare38eab22019-12-05 21:50:01 +01002457 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458 if (lv.ll_exp_name != NULL)
2459 {
2460 len = (int)STRLEN(lv.ll_exp_name);
2461 name = deref_func_name(lv.ll_exp_name, &len, partial,
2462 flags & TFN_NO_AUTOLOAD);
2463 if (name == lv.ll_exp_name)
2464 name = NULL;
2465 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002466 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 {
2468 len = (int)(end - *pp);
2469 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2470 if (name == *pp)
2471 name = NULL;
2472 }
2473 if (name != NULL)
2474 {
2475 name = vim_strsave(name);
2476 *pp = end;
2477 if (STRNCMP(name, "<SNR>", 5) == 0)
2478 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 name[0] = K_SPECIAL;
2481 name[1] = KS_EXTRA;
2482 name[2] = (int)KE_SNR;
2483 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2484 }
2485 goto theend;
2486 }
2487
2488 if (lv.ll_exp_name != NULL)
2489 {
2490 len = (int)STRLEN(lv.ll_exp_name);
2491 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2492 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002494 // When there was "s:" already or the name expanded to get a
2495 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496 lv.ll_name += 2;
2497 len -= 2;
2498 lead = 2;
2499 }
2500 }
2501 else
2502 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002503 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002505 {
2506 if (is_global != NULL && lv.ll_name[0] == 'g')
2507 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002508 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002509 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 len = (int)(end - lv.ll_name);
2511 }
2512
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002513 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002514 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002515
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 /*
2517 * Copy the function name to allocated memory.
2518 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2519 * Accept <SNR>123_name() outside a script.
2520 */
2521 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002522 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002523 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002525 if (!vim9script)
2526 lead = 3;
2527 if (vim9script || (lv.ll_exp_name != NULL
2528 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 || eval_fname_sid(*pp))
2530 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002531 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002532 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002534 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 goto theend;
2536 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002537 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002538 if (vim9script)
2539 extra = 3 + (int)STRLEN(sid_buf);
2540 else
2541 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 }
2543 }
2544 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2545 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002546 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 start);
2548 goto theend;
2549 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002550 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551 {
2552 char_u *cp = vim_strchr(lv.ll_name, ':');
2553
2554 if (cp != NULL && cp < end)
2555 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002556 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 goto theend;
2558 }
2559 }
2560
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002561 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002562 if (name != NULL)
2563 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002564 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002565 {
2566 name[0] = K_SPECIAL;
2567 name[1] = KS_EXTRA;
2568 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002569 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 STRCPY(name + 3, sid_buf);
2571 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002572 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2573 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 }
2575 *pp = end;
2576
2577theend:
2578 clear_lval(&lv);
2579 return name;
2580}
2581
2582/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002583 * Assuming "name" is the result of trans_function_name() and it was prefixed
2584 * to use the script-local name, return the unmodified name (points into
2585 * "name"). Otherwise return NULL.
2586 * This can be used to first search for a script-local function and fall back
2587 * to the global function if not found.
2588 */
2589 char_u *
2590untrans_function_name(char_u *name)
2591{
2592 char_u *p;
2593
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002594 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002595 {
2596 p = vim_strchr(name, '_');
2597 if (p != NULL)
2598 return p + 1;
2599 }
2600 return NULL;
2601}
2602
2603/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002604 * List functions. When "regmatch" is NULL all of then.
2605 * Otherwise functions matching "regmatch".
2606 */
2607 static void
2608list_functions(regmatch_T *regmatch)
2609{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002610 int changed = func_hashtab.ht_changed;
2611 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002612 hashitem_T *hi;
2613
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002614 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002615 {
2616 if (!HASHITEM_EMPTY(hi))
2617 {
2618 ufunc_T *fp = HI2UF(hi);
2619
2620 --todo;
2621 if ((fp->uf_flags & FC_DEAD) == 0
2622 && (regmatch == NULL
2623 ? !message_filtered(fp->uf_name)
2624 && !func_name_refcount(fp->uf_name)
2625 : !isdigit(*fp->uf_name)
2626 && vim_regexec(regmatch, fp->uf_name, 0)))
2627 {
2628 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002629 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002630 {
2631 emsg(_("E454: function list was modified"));
2632 return;
2633 }
2634 }
2635 }
2636 }
2637}
2638
2639/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002640 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002641 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2642 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002643 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002645 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002646def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647{
2648 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002649 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 int j;
2651 int c;
2652 int saved_did_emsg;
2653 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002654 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002655 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 char_u *p;
2657 char_u *arg;
2658 char_u *line_arg = NULL;
2659 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002660 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002661 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 garray_T newlines;
2663 int varargs = FALSE;
2664 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002665 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002666 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002667 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 int indent;
2669 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002670#define MAX_FUNC_NESTING 50
2671 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672 dictitem_T *v;
2673 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002674 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002677 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002678 linenr_T sourcing_lnum_off;
2679 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002680 int is_heredoc = FALSE;
2681 char_u *skip_until = NULL;
2682 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002683 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002684 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685
2686 /*
2687 * ":function" without argument: list functions.
2688 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002689 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 {
2691 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002692 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002694 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 }
2696
2697 /*
2698 * ":function /pat": list functions matching pattern.
2699 */
2700 if (*eap->arg == '/')
2701 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002702 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703 if (!eap->skip)
2704 {
2705 regmatch_T regmatch;
2706
2707 c = *p;
2708 *p = NUL;
2709 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2710 *p = c;
2711 if (regmatch.regprog != NULL)
2712 {
2713 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002714 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 vim_regfree(regmatch.regprog);
2716 }
2717 }
2718 if (*p == '/')
2719 ++p;
2720 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002721 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 }
2723
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002724 ga_init(&newargs);
2725 ga_init(&argtypes);
2726 ga_init(&default_args);
2727
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 /*
2729 * Get the function name. There are these situations:
2730 * func normal function name
2731 * "name" == func, "fudi.fd_dict" == NULL
2732 * dict.func new dictionary entry
2733 * "name" == NULL, "fudi.fd_dict" set,
2734 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2735 * dict.func existing dict entry with a Funcref
2736 * "name" == func, "fudi.fd_dict" set,
2737 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2738 * dict.func existing dict entry that's not a Funcref
2739 * "name" == NULL, "fudi.fd_dict" set,
2740 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2741 * s:func script-local function name
2742 * g:func global function name, same as "func"
2743 */
2744 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002745 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002747 // nested function, argument is (args).
2748 paren = TRUE;
2749 CLEAR_FIELD(fudi);
2750 }
2751 else
2752 {
2753 name = trans_function_name(&p, &is_global, eap->skip,
2754 TFN_NO_AUTOLOAD, &fudi, NULL);
2755 paren = (vim_strchr(p, '(') != NULL);
2756 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002758 /*
2759 * Return on an invalid expression in braces, unless the expression
2760 * evaluation has been cancelled due to an aborting error, an
2761 * interrupt, or an exception.
2762 */
2763 if (!aborting())
2764 {
2765 if (!eap->skip && fudi.fd_newkey != NULL)
2766 semsg(_(e_dictkey), fudi.fd_newkey);
2767 vim_free(fudi.fd_newkey);
2768 return NULL;
2769 }
2770 else
2771 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 }
2774
Bram Moolenaare38eab22019-12-05 21:50:01 +01002775 // An error in a function call during evaluation of an expression in magic
2776 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 saved_did_emsg = did_emsg;
2778 did_emsg = FALSE;
2779
2780 /*
2781 * ":function func" with only function name: list function.
2782 */
2783 if (!paren)
2784 {
2785 if (!ends_excmd(*skipwhite(p)))
2786 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002787 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 goto ret_free;
2789 }
2790 eap->nextcmd = check_nextcmd(p);
2791 if (eap->nextcmd != NULL)
2792 *p = NUL;
2793 if (!eap->skip && !got_int)
2794 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002795 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002796 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2797 {
2798 char_u *up = untrans_function_name(name);
2799
2800 // With Vim9 script the name was made script-local, if not
2801 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002802 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002803 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002804 }
2805
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 if (fp != NULL)
2807 {
2808 list_func_head(fp, TRUE);
2809 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2810 {
2811 if (FUNCLINE(fp, j) == NULL)
2812 continue;
2813 msg_putchar('\n');
2814 msg_outnum((long)(j + 1));
2815 if (j < 9)
2816 msg_putchar(' ');
2817 if (j < 99)
2818 msg_putchar(' ');
2819 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002820 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 ui_breakcheck();
2822 }
2823 if (!got_int)
2824 {
2825 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002826 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002827 msg_puts(" enddef");
2828 else
2829 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830 }
2831 }
2832 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002833 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 }
2835 goto ret_free;
2836 }
2837
2838 /*
2839 * ":function name(arg1, arg2)" Define function.
2840 */
2841 p = skipwhite(p);
2842 if (*p != '(')
2843 {
2844 if (!eap->skip)
2845 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002846 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847 goto ret_free;
2848 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002849 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 if (vim_strchr(p, '(') != NULL)
2851 p = vim_strchr(p, '(');
2852 }
2853 p = skipwhite(p + 1);
2854
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002855 // In Vim9 script only global functions can be redefined.
2856 if (vim9script && eap->forceit && !is_global)
2857 {
2858 emsg(_(e_nobang));
2859 goto ret_free;
2860 }
2861
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2863
Bram Moolenaar04b12692020-05-04 23:24:44 +02002864 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002866 // Check the name of the function. Unless it's a dictionary function
2867 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 if (name != NULL)
2869 arg = name;
2870 else
2871 arg = fudi.fd_newkey;
2872 if (arg != NULL && (fudi.fd_di == NULL
2873 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2874 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2875 {
2876 if (*arg == K_SPECIAL)
2877 j = 3;
2878 else
2879 j = 0;
2880 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2881 : eval_isnamec(arg[j])))
2882 ++j;
2883 if (arg[j] != NUL)
2884 emsg_funcname((char *)e_invarg2, arg);
2885 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002886 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002888 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889 }
2890
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002891 // This may get more lines and make the pointers into the first line
2892 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002893 if (get_function_args(&p, ')', &newargs,
2894 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002895 &varargs, &default_args, eap->skip,
2896 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897 goto errret_2;
2898
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002899 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 // find the return type: :def Func(): type
2902 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002904 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002905 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002906 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002907 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002908 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002909 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002910 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002911 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002912 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002913 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002914 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002915 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002916 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002917 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002919 else
2920 // find extra arguments "range", "dict", "abort" and "closure"
2921 for (;;)
2922 {
2923 p = skipwhite(p);
2924 if (STRNCMP(p, "range", 5) == 0)
2925 {
2926 flags |= FC_RANGE;
2927 p += 5;
2928 }
2929 else if (STRNCMP(p, "dict", 4) == 0)
2930 {
2931 flags |= FC_DICT;
2932 p += 4;
2933 }
2934 else if (STRNCMP(p, "abort", 5) == 0)
2935 {
2936 flags |= FC_ABORT;
2937 p += 5;
2938 }
2939 else if (STRNCMP(p, "closure", 7) == 0)
2940 {
2941 flags |= FC_CLOSURE;
2942 p += 7;
2943 if (current_funccal == NULL)
2944 {
2945 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2946 name == NULL ? (char_u *)"" : name);
2947 goto erret;
2948 }
2949 }
2950 else
2951 break;
2952 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953
Bram Moolenaare38eab22019-12-05 21:50:01 +01002954 // When there is a line break use what follows for the function body.
2955 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 if (*p == '\n')
2957 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002958 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002959 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2960 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002961 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2962 && !eap->skip
2963 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002964 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965
2966 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002967 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2968 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969 */
2970 if (KeyTyped)
2971 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002972 // Check if the function already exists, don't let the user type the
2973 // whole function before telling him it doesn't work! For a script we
2974 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975 if (!eap->skip && !eap->forceit)
2976 {
2977 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002978 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002979 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980 emsg_funcname(e_funcexts, name);
2981 }
2982
2983 if (!eap->skip && did_emsg)
2984 goto erret;
2985
Bram Moolenaare38eab22019-12-05 21:50:01 +01002986 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002987 cmdline_row = msg_row;
2988 }
2989
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002990 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002991 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002992
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002993 // Detect having skipped over comment lines to find the return
2994 // type. Add NULL lines to keep the line count correct.
2995 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2996 if (SOURCING_LNUM < sourcing_lnum_off)
2997 {
2998 sourcing_lnum_off -= SOURCING_LNUM;
2999 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3000 goto erret;
3001 while (sourcing_lnum_off-- > 0)
3002 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3003 }
3004
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005 indent = 2;
3006 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003007 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 for (;;)
3009 {
3010 if (KeyTyped)
3011 {
3012 msg_scroll = TRUE;
3013 saved_wait_return = FALSE;
3014 }
3015 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016
3017 if (line_arg != NULL)
3018 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003019 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 theline = line_arg;
3021 p = vim_strchr(theline, '\n');
3022 if (p == NULL)
3023 line_arg += STRLEN(line_arg);
3024 else
3025 {
3026 *p = NUL;
3027 line_arg = p + 1;
3028 }
3029 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003031 {
3032 vim_free(line_to_free);
3033 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003034 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003035 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003036 theline = eap->getline(':', eap->cookie, indent,
3037 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003038 line_to_free = theline;
3039 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003040 if (KeyTyped)
3041 lines_left = Rows - 1;
3042 if (theline == NULL)
3043 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003044 if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003045 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003046 else
3047 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048 goto erret;
3049 }
3050
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003051 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003052 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003053 if (SOURCING_LNUM < sourcing_lnum_off)
3054 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 else
3056 sourcing_lnum_off = 0;
3057
3058 if (skip_until != NULL)
3059 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003060 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003061 // * ":append" and "."
3062 // * ":python <<EOF" and "EOF"
3063 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3064 if (heredoc_trimmed == NULL
3065 || (is_heredoc && skipwhite(theline) == theline)
3066 || STRNCMP(theline, heredoc_trimmed,
3067 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003068 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003069 if (heredoc_trimmed == NULL)
3070 p = theline;
3071 else if (is_heredoc)
3072 p = skipwhite(theline) == theline
3073 ? theline : theline + STRLEN(heredoc_trimmed);
3074 else
3075 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003076 if (STRCMP(p, skip_until) == 0)
3077 {
3078 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003079 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003080 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003081 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003082 }
3083 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084 }
3085 else
3086 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003087 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003088 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003089 ;
3090
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003091 // Check for "endfunction" or "enddef".
3092 if (checkforcmd(&p, nesting_def[nesting]
3093 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003095 char_u *nextcmd = NULL;
3096
Bram Moolenaar663bb232017-06-22 19:12:10 +02003097 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003098 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003099 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003100 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003101 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003102 give_warning2(eap->cmdidx == CMD_def
3103 ? (char_u *)_("W1001: Text found after :enddef: %s")
3104 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003105 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003106 if (nextcmd != NULL)
3107 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003108 // Another command follows. If the line came from "eap" we
3109 // can simply point into it, otherwise we need to change
3110 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003111 eap->nextcmd = nextcmd;
3112 if (line_to_free != NULL)
3113 {
3114 vim_free(*eap->cmdlinep);
3115 *eap->cmdlinep = line_to_free;
3116 line_to_free = NULL;
3117 }
3118 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 break;
3120 }
3121
Bram Moolenaare38eab22019-12-05 21:50:01 +01003122 // Increase indent inside "if", "while", "for" and "try", decrease
3123 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003124 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125 indent -= 2;
3126 else if (STRNCMP(p, "if", 2) == 0
3127 || STRNCMP(p, "wh", 2) == 0
3128 || STRNCMP(p, "for", 3) == 0
3129 || STRNCMP(p, "try", 3) == 0)
3130 indent += 2;
3131
Bram Moolenaare38eab22019-12-05 21:50:01 +01003132 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003133 // Only recognize "def" inside "def", not inside "function",
3134 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003135 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003136 if (checkforcmd(&p, "function", 2)
3137 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 {
3139 if (*p == '!')
3140 p = skipwhite(p + 1);
3141 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003142 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 if (*skipwhite(p) == '(')
3144 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003145 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003146 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003147 else
3148 {
3149 ++nesting;
3150 nesting_def[nesting] = (c == 'd');
3151 indent += 2;
3152 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003153 }
3154 }
3155
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003156 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003157 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003158 if (eap->cmdidx != CMD_def
3159 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003160 || (p[0] == 'c'
3161 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3162 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3163 && (STRNCMP(&p[3], "nge", 3) != 0
3164 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 || (p[0] == 'i'
3166 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003167 && (!ASCII_ISALPHA(p[2])
3168 || (p[2] == 's'
3169 && (!ASCII_ISALPHA(p[3])
3170 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003171 skip_until = vim_strsave((char_u *)".");
3172
Bram Moolenaare38eab22019-12-05 21:50:01 +01003173 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 arg = skipwhite(skiptowhite(p));
3175 if (arg[0] == '<' && arg[1] =='<'
3176 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003177 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3178 || ((p[2] == '3' || p[2] == 'x')
3179 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 || (p[0] == 'p' && p[1] == 'e'
3181 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3182 || (p[0] == 't' && p[1] == 'c'
3183 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3184 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3185 && !ASCII_ISALPHA(p[3]))
3186 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3187 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3188 || (p[0] == 'm' && p[1] == 'z'
3189 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3190 ))
3191 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003192 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003193 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003194 if (STRNCMP(p, "trim", 4) == 0)
3195 {
3196 // Ignore leading white space.
3197 p = skipwhite(p + 4);
3198 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003199 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003200 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 if (*p == NUL)
3202 skip_until = vim_strsave((char_u *)".");
3203 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003204 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003205 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003206 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003208
3209 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003210 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003211 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003212 if (*arg == '[')
3213 arg = vim_strchr(arg, ']');
3214 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003215 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003216 arg = skipwhite(skiptowhite(arg));
3217 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3218 && ((p[0] == 'l'
3219 && p[1] == 'e'
3220 && (!ASCII_ISALNUM(p[2])
3221 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003222 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003223 p = skipwhite(arg + 3);
3224 if (STRNCMP(p, "trim", 4) == 0)
3225 {
3226 // Ignore leading white space.
3227 p = skipwhite(p + 4);
3228 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003229 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003230 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003231 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003232 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003233 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003234 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003235 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 }
3237
Bram Moolenaare38eab22019-12-05 21:50:01 +01003238 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003240 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241
Bram Moolenaare38eab22019-12-05 21:50:01 +01003242 // Copy the line to newly allocated memory. get_one_sourceline()
3243 // allocates 250 bytes per line, this saves 80% on average. The cost
3244 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003246 if (p == NULL)
3247 goto erret;
3248 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249
Bram Moolenaare38eab22019-12-05 21:50:01 +01003250 // Add NULL lines for continuation lines, so that the line count is
3251 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 while (sourcing_lnum_off-- > 0)
3253 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3254
Bram Moolenaare38eab22019-12-05 21:50:01 +01003255 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256 if (line_arg != NULL && *line_arg == NUL)
3257 line_arg = NULL;
3258 }
3259
Bram Moolenaare38eab22019-12-05 21:50:01 +01003260 // Don't define the function when skipping commands or when an error was
3261 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003262 if (eap->skip || did_emsg)
3263 goto erret;
3264
3265 /*
3266 * If there are no errors, add the function
3267 */
3268 if (fudi.fd_dict == NULL)
3269 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 hashtab_T *ht;
3271
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003272 v = find_var(name, &ht, FALSE);
3273 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3274 {
3275 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3276 name);
3277 goto erret;
3278 }
3279
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003280 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003281 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003283 char_u *uname = untrans_function_name(name);
3284
3285 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3286 }
3287
3288 if (fp != NULL || import != NULL)
3289 {
3290 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003291
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003292 // Function can be replaced with "function!" and when sourcing the
3293 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003294 // A name that is used by an import can not be overruled.
3295 if (import != NULL
3296 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003297 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003298 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003300 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003301 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003302 else
3303 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 goto erret;
3305 }
3306 if (fp->uf_calls > 0)
3307 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003308 emsg_funcname(
3309 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310 name);
3311 goto erret;
3312 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003313 if (fp->uf_refcount > 1)
3314 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003315 // This function is referenced somewhere, don't redefine it but
3316 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003317 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003318 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003319 fp = NULL;
3320 overwrite = TRUE;
3321 }
3322 else
3323 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003324 char_u *exp_name = fp->uf_name_exp;
3325
3326 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003327 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003328 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003329 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003330 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003331 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003332#ifdef FEAT_PROFILE
3333 fp->uf_profiling = FALSE;
3334 fp->uf_prof_initialized = FALSE;
3335#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003336 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 }
3339 }
3340 else
3341 {
3342 char numbuf[20];
3343
3344 fp = NULL;
3345 if (fudi.fd_newkey == NULL && !eap->forceit)
3346 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003347 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 goto erret;
3349 }
3350 if (fudi.fd_di == NULL)
3351 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003352 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003353 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 goto erret;
3355 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003356 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003357 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 goto erret;
3359
Bram Moolenaare38eab22019-12-05 21:50:01 +01003360 // Give the function a sequential number. Can only be used with a
3361 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 vim_free(name);
3363 sprintf(numbuf, "%d", ++func_nr);
3364 name = vim_strsave((char_u *)numbuf);
3365 if (name == NULL)
3366 goto erret;
3367 }
3368
3369 if (fp == NULL)
3370 {
3371 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3372 {
3373 int slen, plen;
3374 char_u *scriptname;
3375
Bram Moolenaare38eab22019-12-05 21:50:01 +01003376 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003378 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379 {
3380 scriptname = autoload_name(name);
3381 if (scriptname != NULL)
3382 {
3383 p = vim_strchr(scriptname, '/');
3384 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003385 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003387 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 j = OK;
3389 vim_free(scriptname);
3390 }
3391 }
3392 if (j == FAIL)
3393 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003394 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395 goto erret;
3396 }
3397 }
3398
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003399 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 if (fp == NULL)
3401 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003402 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003403 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404
3405 if (fudi.fd_dict != NULL)
3406 {
3407 if (fudi.fd_di == NULL)
3408 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003409 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3411 if (fudi.fd_di == NULL)
3412 {
3413 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003414 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003415 goto erret;
3416 }
3417 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3418 {
3419 vim_free(fudi.fd_di);
3420 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003421 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 goto erret;
3423 }
3424 }
3425 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003426 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 clear_tv(&fudi.fd_di->di_tv);
3428 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430
Bram Moolenaare38eab22019-12-05 21:50:01 +01003431 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 flags |= FC_DICT;
3433 }
3434
Bram Moolenaare38eab22019-12-05 21:50:01 +01003435 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003436 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003437 if (overwrite)
3438 {
3439 hi = hash_find(&func_hashtab, name);
3440 hi->hi_key = UF2HIKEY(fp);
3441 }
3442 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 {
3444 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003445 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446 goto erret;
3447 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003448 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449 }
3450 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003451 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003453 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003454
3455 if (eap->cmdidx == CMD_def)
3456 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003457 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003458
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003459 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003460
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003461 // error messages are for the first function line
3462 SOURCING_LNUM = sourcing_lnum_top;
3463
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003465 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466
3467 if (argtypes.ga_len > 0)
3468 {
3469 // When "varargs" is set the last name/type goes into uf_va_name
3470 // and uf_va_type.
3471 int len = argtypes.ga_len - (varargs ? 1 : 0);
3472
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003473 if (len > 0)
3474 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003475 if (fp->uf_arg_types != NULL)
3476 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003477 int i;
3478 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003479
3480 for (i = 0; i < len; ++ i)
3481 {
3482 p = ((char_u **)argtypes.ga_data)[i];
3483 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003484 // will get the type from the default value
3485 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003486 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003487 type = parse_type(&p, &fp->uf_type_list);
3488 if (type == NULL)
3489 {
3490 SOURCING_LNUM = lnum_save;
3491 goto errret_2;
3492 }
3493 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003494 }
3495 }
3496 if (varargs)
3497 {
3498 // Move the last argument "...name: type" to uf_va_name and
3499 // uf_va_type.
3500 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3501 [fp->uf_args.ga_len - 1];
3502 --fp->uf_args.ga_len;
3503 p = ((char_u **)argtypes.ga_data)[len];
3504 if (p == NULL)
3505 // todo: get type from default value
3506 fp->uf_va_type = &t_any;
3507 else
3508 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003509 if (fp->uf_va_type == NULL)
3510 {
3511 SOURCING_LNUM = lnum_save;
3512 goto errret_2;
3513 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003514 }
3515 varargs = FALSE;
3516 }
3517
3518 // parse the return type, if any
3519 if (ret_type == NULL)
3520 fp->uf_ret_type = &t_void;
3521 else
3522 {
3523 p = ret_type;
3524 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3525 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003526 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003527 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003528 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003529 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003530
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003532 if ((flags & FC_CLOSURE) != 0)
3533 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003534 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003535 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003536 }
3537 else
3538 fp->uf_scoped = NULL;
3539
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 if (prof_def_func())
3542 func_do_profile(fp);
3543#endif
3544 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003545 if (sandbox)
3546 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003547 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003548 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 fp->uf_flags = flags;
3550 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003551 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003552 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003553 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003554 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003555 if (is_export)
3556 {
3557 fp->uf_flags |= FC_EXPORT;
3558 // let ex_export() know the export worked.
3559 is_export = FALSE;
3560 }
3561
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003562 if (eap->cmdidx == CMD_def)
3563 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003564 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3565 // :func does not use Vim9 script syntax, even in a Vim9 script file
3566 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003567
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 goto ret_free;
3569
3570erret:
3571 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003572 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573errret_2:
3574 ga_clear_strings(&newlines);
3575ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003576 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003578 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003580 if (name != name_arg)
3581 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003582 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 did_emsg |= saved_did_emsg;
3584 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003585
3586 return fp;
3587}
3588
3589/*
3590 * ":function"
3591 */
3592 void
3593ex_function(exarg_T *eap)
3594{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003595 (void)def_function(eap, NULL);
3596}
3597
3598/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003599 * :defcompile - compile all :def functions in the current script that need to
3600 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003601 */
3602 void
3603ex_defcompile(exarg_T *eap UNUSED)
3604{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003605 long todo = (long)func_hashtab.ht_used;
3606 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003607 hashitem_T *hi;
3608 ufunc_T *ufunc;
3609
3610 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3611 {
3612 if (!HASHITEM_EMPTY(hi))
3613 {
3614 --todo;
3615 ufunc = HI2UF(hi);
3616 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003617 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3618 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003619 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003620 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003621
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003622 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003623 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003624 // a function has been added or removed, need to start over
3625 todo = (long)func_hashtab.ht_used;
3626 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003627 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003628 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003629 }
3630 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003631 }
3632 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633}
3634
3635/*
3636 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3637 * Return 2 if "p" starts with "s:".
3638 * Return 0 otherwise.
3639 */
3640 int
3641eval_fname_script(char_u *p)
3642{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003643 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3644 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3646 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3647 return 5;
3648 if (p[0] == 's' && p[1] == ':')
3649 return 2;
3650 return 0;
3651}
3652
3653 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003654translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655{
3656 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003657 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003658 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003659}
3660
3661/*
3662 * Return TRUE when "ufunc" has old-style "..." varargs
3663 * or named varargs "...name: type".
3664 */
3665 int
3666has_varargs(ufunc_T *ufunc)
3667{
3668 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669}
3670
3671/*
3672 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003673 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 */
3675 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003676function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677{
3678 char_u *nm = name;
3679 char_u *p;
3680 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003681 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003682 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003684 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3685 if (no_deref)
3686 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003687 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 nm = skipwhite(nm);
3689
Bram Moolenaare38eab22019-12-05 21:50:01 +01003690 // Only accept "funcname", "funcname ", "funcname (..." and
3691 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003693 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 vim_free(p);
3695 return n;
3696}
3697
Bram Moolenaar113e1072019-01-20 15:30:40 +01003698#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 char_u *
3700get_expanded_name(char_u *name, int check)
3701{
3702 char_u *nm = name;
3703 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003704 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003706 p = trans_function_name(&nm, &is_global, FALSE,
3707 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003709 if (p != NULL && *nm == NUL
3710 && (!check || translated_function_exists(p, is_global)))
3711 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712
3713 vim_free(p);
3714 return NULL;
3715}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003716#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718/*
3719 * Function given to ExpandGeneric() to obtain the list of user defined
3720 * function names.
3721 */
3722 char_u *
3723get_user_func_name(expand_T *xp, int idx)
3724{
3725 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003726 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 static hashitem_T *hi;
3728 ufunc_T *fp;
3729
3730 if (idx == 0)
3731 {
3732 done = 0;
3733 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003734 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003736 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 {
3738 if (done++ > 0)
3739 ++hi;
3740 while (HASHITEM_EMPTY(hi))
3741 ++hi;
3742 fp = HI2UF(hi);
3743
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003744 // don't show dead, dict and lambda functions
3745 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003746 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003747 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003748
3749 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003750 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751
3752 cat_func_name(IObuff, fp);
3753 if (xp->xp_context != EXPAND_USER_FUNC)
3754 {
3755 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003756 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 STRCAT(IObuff, ")");
3758 }
3759 return IObuff;
3760 }
3761 return NULL;
3762}
3763
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764/*
3765 * ":delfunction {name}"
3766 */
3767 void
3768ex_delfunction(exarg_T *eap)
3769{
3770 ufunc_T *fp = NULL;
3771 char_u *p;
3772 char_u *name;
3773 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003774 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775
3776 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003777 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 vim_free(fudi.fd_newkey);
3779 if (name == NULL)
3780 {
3781 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003782 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 return;
3784 }
3785 if (!ends_excmd(*skipwhite(p)))
3786 {
3787 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003788 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789 return;
3790 }
3791 eap->nextcmd = check_nextcmd(p);
3792 if (eap->nextcmd != NULL)
3793 *p = NUL;
3794
3795 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003796 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 vim_free(name);
3798
3799 if (!eap->skip)
3800 {
3801 if (fp == NULL)
3802 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003803 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003804 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 return;
3806 }
3807 if (fp->uf_calls > 0)
3808 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003809 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 return;
3811 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003812 if (fp->uf_flags & FC_VIM9)
3813 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003814 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003815 return;
3816 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817
3818 if (fudi.fd_dict != NULL)
3819 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003820 // Delete the dict item that refers to the function, it will
3821 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3823 }
3824 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003825 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003826 // A normal function (not a numbered function or lambda) has a
3827 // refcount of 1 for the entry in the hashtable. When deleting
3828 // it and the refcount is more than one, it should be kept.
3829 // A numbered function and lambda should be kept if the refcount is
3830 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003831 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003832 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003833 // Function is still referenced somewhere. Don't free it but
3834 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003835 if (func_remove(fp))
3836 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003837 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003838 }
3839 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003840 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003841 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 }
3843}
3844
3845/*
3846 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003847 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 */
3849 void
3850func_unref(char_u *name)
3851{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003852 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003854 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003856 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003857 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003860 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003862 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003864 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003866 // Only delete it when it's not being used. Otherwise it's done
3867 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003868 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003869 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003870 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003871}
3872
3873/*
3874 * Unreference a Function: decrement the reference count and free it when it
3875 * becomes zero.
3876 */
3877 void
3878func_ptr_unref(ufunc_T *fp)
3879{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003880 if (fp != NULL && --fp->uf_refcount <= 0)
3881 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003882 // Only delete it when it's not being used. Otherwise it's done
3883 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003884 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003885 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886 }
3887}
3888
3889/*
3890 * Count a reference to a Function.
3891 */
3892 void
3893func_ref(char_u *name)
3894{
3895 ufunc_T *fp;
3896
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003897 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003898 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003899 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003900 if (fp != NULL)
3901 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003902 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003903 // Only give an error for a numbered function.
3904 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003905 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003906}
3907
3908/*
3909 * Count a reference to a Function.
3910 */
3911 void
3912func_ptr_ref(ufunc_T *fp)
3913{
3914 if (fp != NULL)
3915 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916}
3917
3918/*
3919 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3920 * referenced from anywhere that is in use.
3921 */
3922 static int
3923can_free_funccal(funccall_T *fc, int copyID)
3924{
3925 return (fc->l_varlist.lv_copyID != copyID
3926 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003927 && fc->l_avars.dv_copyID != copyID
3928 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929}
3930
3931/*
3932 * ":return [expr]"
3933 */
3934 void
3935ex_return(exarg_T *eap)
3936{
3937 char_u *arg = eap->arg;
3938 typval_T rettv;
3939 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003940 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941
3942 if (current_funccal == NULL)
3943 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003944 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 return;
3946 }
3947
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003948 CLEAR_FIELD(evalarg);
3949 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3950
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951 if (eap->skip)
3952 ++emsg_skip;
3953
3954 eap->nextcmd = NULL;
3955 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003956 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 {
3958 if (!eap->skip)
3959 returning = do_return(eap, FALSE, TRUE, &rettv);
3960 else
3961 clear_tv(&rettv);
3962 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003963 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 else if (!eap->skip)
3965 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003966 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003967 update_force_abort();
3968
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 /*
3970 * Return unless the expression evaluation has been cancelled due to an
3971 * aborting error, an interrupt, or an exception.
3972 */
3973 if (!aborting())
3974 returning = do_return(eap, FALSE, TRUE, NULL);
3975 }
3976
Bram Moolenaare38eab22019-12-05 21:50:01 +01003977 // When skipping or the return gets pending, advance to the next command
3978 // in this line (!returning). Otherwise, ignore the rest of the line.
3979 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 if (returning)
3981 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 eap->nextcmd = check_nextcmd(arg);
3984
3985 if (eap->skip)
3986 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003987 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988}
3989
3990/*
3991 * ":1,25call func(arg1, arg2)" function call.
3992 */
3993 void
3994ex_call(exarg_T *eap)
3995{
3996 char_u *arg = eap->arg;
3997 char_u *startarg;
3998 char_u *name;
3999 char_u *tofree;
4000 int len;
4001 typval_T rettv;
4002 linenr_T lnum;
4003 int doesrange;
4004 int failed = FALSE;
4005 funcdict_T fudi;
4006 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004007 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008
Bram Moolenaare6b53242020-07-01 17:28:33 +02004009 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 if (eap->skip)
4011 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004012 // trans_function_name() doesn't work well when skipping, use eval0()
4013 // instead to skip to any following command, e.g. for:
4014 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004016 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 clear_tv(&rettv);
4018 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004019 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 return;
4021 }
4022
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004023 tofree = trans_function_name(&arg, NULL, eap->skip,
4024 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 if (fudi.fd_newkey != NULL)
4026 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004027 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004028 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 vim_free(fudi.fd_newkey);
4030 }
4031 if (tofree == NULL)
4032 return;
4033
Bram Moolenaare38eab22019-12-05 21:50:01 +01004034 // Increase refcount on dictionary, it could get deleted when evaluating
4035 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 if (fudi.fd_dict != NULL)
4037 ++fudi.fd_dict->dv_refcount;
4038
Bram Moolenaare38eab22019-12-05 21:50:01 +01004039 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4040 // contents. For VAR_PARTIAL get its partial, unless we already have one
4041 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 len = (int)STRLEN(tofree);
4043 name = deref_func_name(tofree, &len,
4044 partial != NULL ? NULL : &partial, FALSE);
4045
Bram Moolenaare38eab22019-12-05 21:50:01 +01004046 // Skip white space to allow ":call func ()". Not good, but required for
4047 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004049 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050
4051 if (*startarg != '(')
4052 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004053 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 goto end;
4055 }
4056
4057 /*
4058 * When skipping, evaluate the function once, to find the end of the
4059 * arguments.
4060 * When the function takes a range, this is discovered after the first
4061 * call, and the loop is broken.
4062 */
4063 if (eap->skip)
4064 {
4065 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004066 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 }
4068 else
4069 lnum = eap->line1;
4070 for ( ; lnum <= eap->line2; ++lnum)
4071 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004072 funcexe_T funcexe;
4073
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 if (!eap->skip && eap->addr_count > 0)
4075 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004076 if (lnum > curbuf->b_ml.ml_line_count)
4077 {
4078 // If the function deleted lines or switched to another buffer
4079 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004080 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004081 break;
4082 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004083 curwin->w_cursor.lnum = lnum;
4084 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 }
4087 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004088
Bram Moolenaara80faa82020-04-12 19:37:17 +02004089 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004090 funcexe.firstline = eap->line1;
4091 funcexe.lastline = eap->line2;
4092 funcexe.doesrange = &doesrange;
4093 funcexe.evaluate = !eap->skip;
4094 funcexe.partial = partial;
4095 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004096 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 {
4098 failed = TRUE;
4099 break;
4100 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004101 if (has_watchexpr())
4102 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004104 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004105 if (handle_subscript(&arg, &rettv,
4106 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 {
4108 failed = TRUE;
4109 break;
4110 }
4111
4112 clear_tv(&rettv);
4113 if (doesrange || eap->skip)
4114 break;
4115
Bram Moolenaare38eab22019-12-05 21:50:01 +01004116 // Stop when immediately aborting on error, or when an interrupt
4117 // occurred or an exception was thrown but not caught.
4118 // get_func_tv() returned OK, so that the check for trailing
4119 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120 if (aborting())
4121 break;
4122 }
4123 if (eap->skip)
4124 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004125 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004126
Bram Moolenaare51bb172020-02-16 19:42:23 +01004127 // When inside :try we need to check for following "| catch".
4128 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004130 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004131 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004132 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004134 if (!failed)
4135 {
4136 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004137 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004138 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 }
4140 else
4141 eap->nextcmd = check_nextcmd(arg);
4142 }
4143
4144end:
4145 dict_unref(fudi.fd_dict);
4146 vim_free(tofree);
4147}
4148
4149/*
4150 * Return from a function. Possibly makes the return pending. Also called
4151 * for a pending return at the ":endtry" or after returning from an extra
4152 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4153 * when called due to a ":return" command. "rettv" may point to a typval_T
4154 * with the return rettv. Returns TRUE when the return can be carried out,
4155 * FALSE when the return gets pending.
4156 */
4157 int
4158do_return(
4159 exarg_T *eap,
4160 int reanimate,
4161 int is_cmd,
4162 void *rettv)
4163{
4164 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004165 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166
4167 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004168 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 current_funccal->returned = FALSE;
4170
4171 /*
4172 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4173 * not in its finally clause (which then is to be executed next) is found.
4174 * In this case, make the ":return" pending for execution at the ":endtry".
4175 * Otherwise, return normally.
4176 */
4177 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4178 if (idx >= 0)
4179 {
4180 cstack->cs_pending[idx] = CSTP_RETURN;
4181
4182 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004183 // A pending return again gets pending. "rettv" points to an
4184 // allocated variable with the rettv of the original ":return"'s
4185 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 cstack->cs_rettv[idx] = rettv;
4187 else
4188 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004189 // When undoing a return in order to make it pending, get the stored
4190 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191 if (reanimate)
4192 rettv = current_funccal->rettv;
4193
4194 if (rettv != NULL)
4195 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004196 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4198 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4199 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004200 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 }
4202 else
4203 cstack->cs_rettv[idx] = NULL;
4204
4205 if (reanimate)
4206 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004207 // The pending return value could be overwritten by a ":return"
4208 // without argument in a finally clause; reset the default
4209 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210 current_funccal->rettv->v_type = VAR_NUMBER;
4211 current_funccal->rettv->vval.v_number = 0;
4212 }
4213 }
4214 report_make_pending(CSTP_RETURN, rettv);
4215 }
4216 else
4217 {
4218 current_funccal->returned = TRUE;
4219
Bram Moolenaare38eab22019-12-05 21:50:01 +01004220 // If the return is carried out now, store the return value. For
4221 // a return immediately after reanimation, the value is already
4222 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004223 if (!reanimate && rettv != NULL)
4224 {
4225 clear_tv(current_funccal->rettv);
4226 *current_funccal->rettv = *(typval_T *)rettv;
4227 if (!is_cmd)
4228 vim_free(rettv);
4229 }
4230 }
4231
4232 return idx < 0;
4233}
4234
4235/*
4236 * Free the variable with a pending return value.
4237 */
4238 void
4239discard_pending_return(void *rettv)
4240{
4241 free_tv((typval_T *)rettv);
4242}
4243
4244/*
4245 * Generate a return command for producing the value of "rettv". The result
4246 * is an allocated string. Used by report_pending() for verbose messages.
4247 */
4248 char_u *
4249get_return_cmd(void *rettv)
4250{
4251 char_u *s = NULL;
4252 char_u *tofree = NULL;
4253 char_u numbuf[NUMBUFLEN];
4254
4255 if (rettv != NULL)
4256 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4257 if (s == NULL)
4258 s = (char_u *)"";
4259
4260 STRCPY(IObuff, ":return ");
4261 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4262 if (STRLEN(s) + 8 >= IOSIZE)
4263 STRCPY(IObuff + IOSIZE - 4, "...");
4264 vim_free(tofree);
4265 return vim_strsave(IObuff);
4266}
4267
4268/*
4269 * Get next function line.
4270 * Called by do_cmdline() to get the next line.
4271 * Returns allocated string, or NULL for end of function.
4272 */
4273 char_u *
4274get_func_line(
4275 int c UNUSED,
4276 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004277 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004278 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279{
4280 funccall_T *fcp = (funccall_T *)cookie;
4281 ufunc_T *fp = fcp->func;
4282 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004283 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284
Bram Moolenaare38eab22019-12-05 21:50:01 +01004285 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 if (fcp->dbg_tick != debug_tick)
4287 {
4288 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004289 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 fcp->dbg_tick = debug_tick;
4291 }
4292#ifdef FEAT_PROFILE
4293 if (do_profiling == PROF_YES)
4294 func_line_end(cookie);
4295#endif
4296
4297 gap = &fp->uf_lines;
4298 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4299 || fcp->returned)
4300 retval = NULL;
4301 else
4302 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004303 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 while (fcp->linenr < gap->ga_len
4305 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4306 ++fcp->linenr;
4307 if (fcp->linenr >= gap->ga_len)
4308 retval = NULL;
4309 else
4310 {
4311 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004312 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313#ifdef FEAT_PROFILE
4314 if (do_profiling == PROF_YES)
4315 func_line_start(cookie);
4316#endif
4317 }
4318 }
4319
Bram Moolenaare38eab22019-12-05 21:50:01 +01004320 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004321 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004323 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004324 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004326 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327 fcp->dbg_tick = debug_tick;
4328 }
4329
4330 return retval;
4331}
4332
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333/*
4334 * Return TRUE if the currently active function should be ended, because a
4335 * return was encountered or an error occurred. Used inside a ":while".
4336 */
4337 int
4338func_has_ended(void *cookie)
4339{
4340 funccall_T *fcp = (funccall_T *)cookie;
4341
Bram Moolenaare38eab22019-12-05 21:50:01 +01004342 // Ignore the "abort" flag if the abortion behavior has been changed due to
4343 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4345 || fcp->returned);
4346}
4347
4348/*
4349 * return TRUE if cookie indicates a function which "abort"s on errors.
4350 */
4351 int
4352func_has_abort(
4353 void *cookie)
4354{
4355 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4356}
4357
4358
4359/*
4360 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4361 * Don't do this when "Func" is already a partial that was bound
4362 * explicitly (pt_auto is FALSE).
4363 * Changes "rettv" in-place.
4364 * Returns the updated "selfdict_in".
4365 */
4366 dict_T *
4367make_partial(dict_T *selfdict_in, typval_T *rettv)
4368{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004369 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370 char_u *tofree = NULL;
4371 ufunc_T *fp;
4372 char_u fname_buf[FLEN_FIXED + 1];
4373 int error;
4374 dict_T *selfdict = selfdict_in;
4375
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004376 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4377 fp = rettv->vval.v_partial->pt_func;
4378 else
4379 {
4380 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4381 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004382 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004383 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004384 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004385 vim_free(tofree);
4386 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387
4388 if (fp != NULL && (fp->uf_flags & FC_DICT))
4389 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004390 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391
4392 if (pt != NULL)
4393 {
4394 pt->pt_refcount = 1;
4395 pt->pt_dict = selfdict;
4396 pt->pt_auto = TRUE;
4397 selfdict = NULL;
4398 if (rettv->v_type == VAR_FUNC)
4399 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004400 // Just a function: Take over the function name and use
4401 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 pt->pt_name = rettv->vval.v_string;
4403 }
4404 else
4405 {
4406 partial_T *ret_pt = rettv->vval.v_partial;
4407 int i;
4408
Bram Moolenaare38eab22019-12-05 21:50:01 +01004409 // Partial: copy the function name, use selfdict and copy
4410 // args. Can't take over name or args, the partial might
4411 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004412 if (ret_pt->pt_name != NULL)
4413 {
4414 pt->pt_name = vim_strsave(ret_pt->pt_name);
4415 func_ref(pt->pt_name);
4416 }
4417 else
4418 {
4419 pt->pt_func = ret_pt->pt_func;
4420 func_ptr_ref(pt->pt_func);
4421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004422 if (ret_pt->pt_argc > 0)
4423 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004424 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004426 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 pt->pt_argc = 0;
4428 else
4429 {
4430 pt->pt_argc = ret_pt->pt_argc;
4431 for (i = 0; i < pt->pt_argc; i++)
4432 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4433 }
4434 }
4435 partial_unref(ret_pt);
4436 }
4437 rettv->v_type = VAR_PARTIAL;
4438 rettv->vval.v_partial = pt;
4439 }
4440 }
4441 return selfdict;
4442}
4443
4444/*
4445 * Return the name of the executed function.
4446 */
4447 char_u *
4448func_name(void *cookie)
4449{
4450 return ((funccall_T *)cookie)->func->uf_name;
4451}
4452
4453/*
4454 * Return the address holding the next breakpoint line for a funccall cookie.
4455 */
4456 linenr_T *
4457func_breakpoint(void *cookie)
4458{
4459 return &((funccall_T *)cookie)->breakpoint;
4460}
4461
4462/*
4463 * Return the address holding the debug tick for a funccall cookie.
4464 */
4465 int *
4466func_dbg_tick(void *cookie)
4467{
4468 return &((funccall_T *)cookie)->dbg_tick;
4469}
4470
4471/*
4472 * Return the nesting level for a funccall cookie.
4473 */
4474 int
4475func_level(void *cookie)
4476{
4477 return ((funccall_T *)cookie)->level;
4478}
4479
4480/*
4481 * Return TRUE when a function was ended by a ":return" command.
4482 */
4483 int
4484current_func_returned(void)
4485{
4486 return current_funccal->returned;
4487}
4488
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 int
4490free_unref_funccal(int copyID, int testing)
4491{
4492 int did_free = FALSE;
4493 int did_free_funccal = FALSE;
4494 funccall_T *fc, **pfc;
4495
4496 for (pfc = &previous_funccal; *pfc != NULL; )
4497 {
4498 if (can_free_funccal(*pfc, copyID))
4499 {
4500 fc = *pfc;
4501 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004502 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004503 did_free = TRUE;
4504 did_free_funccal = TRUE;
4505 }
4506 else
4507 pfc = &(*pfc)->caller;
4508 }
4509 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004510 // When a funccal was freed some more items might be garbage
4511 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004512 (void)garbage_collect(testing);
4513
4514 return did_free;
4515}
4516
4517/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004518 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 */
4520 static funccall_T *
4521get_funccal(void)
4522{
4523 int i;
4524 funccall_T *funccal;
4525 funccall_T *temp_funccal;
4526
4527 funccal = current_funccal;
4528 if (debug_backtrace_level > 0)
4529 {
4530 for (i = 0; i < debug_backtrace_level; i++)
4531 {
4532 temp_funccal = funccal->caller;
4533 if (temp_funccal)
4534 funccal = temp_funccal;
4535 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004536 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 debug_backtrace_level = i;
4538 }
4539 }
4540 return funccal;
4541}
4542
4543/*
4544 * Return the hashtable used for local variables in the current funccal.
4545 * Return NULL if there is no current funccal.
4546 */
4547 hashtab_T *
4548get_funccal_local_ht()
4549{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004550 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551 return NULL;
4552 return &get_funccal()->l_vars.dv_hashtab;
4553}
4554
4555/*
4556 * Return the l: scope variable.
4557 * Return NULL if there is no current funccal.
4558 */
4559 dictitem_T *
4560get_funccal_local_var()
4561{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004562 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563 return NULL;
4564 return &get_funccal()->l_vars_var;
4565}
4566
4567/*
4568 * Return the hashtable used for argument in the current funccal.
4569 * Return NULL if there is no current funccal.
4570 */
4571 hashtab_T *
4572get_funccal_args_ht()
4573{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004574 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 return NULL;
4576 return &get_funccal()->l_avars.dv_hashtab;
4577}
4578
4579/*
4580 * Return the a: scope variable.
4581 * Return NULL if there is no current funccal.
4582 */
4583 dictitem_T *
4584get_funccal_args_var()
4585{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004586 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004588 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589}
4590
4591/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592 * List function variables, if there is a function.
4593 */
4594 void
4595list_func_vars(int *first)
4596{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004597 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004599 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600}
4601
4602/*
4603 * If "ht" is the hashtable for local variables in the current funccal, return
4604 * the dict that contains it.
4605 * Otherwise return NULL.
4606 */
4607 dict_T *
4608get_current_funccal_dict(hashtab_T *ht)
4609{
4610 if (current_funccal != NULL
4611 && ht == &current_funccal->l_vars.dv_hashtab)
4612 return &current_funccal->l_vars;
4613 return NULL;
4614}
4615
4616/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004617 * Search hashitem in parent scope.
4618 */
4619 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004620find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004621{
4622 funccall_T *old_current_funccal = current_funccal;
4623 hashtab_T *ht;
4624 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004625 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004626
4627 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4628 return NULL;
4629
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004630 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004631 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004632 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004633 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004634 ht = find_var_ht(name, &varname);
4635 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004636 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004637 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004638 if (!HASHITEM_EMPTY(hi))
4639 {
4640 *pht = ht;
4641 break;
4642 }
4643 }
4644 if (current_funccal == current_funccal->func->uf_scoped)
4645 break;
4646 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004647 }
4648 current_funccal = old_current_funccal;
4649
4650 return hi;
4651}
4652
4653/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004654 * Search variable in parent scope.
4655 */
4656 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004657find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004658{
4659 dictitem_T *v = NULL;
4660 funccall_T *old_current_funccal = current_funccal;
4661 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004662 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004663
4664 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4665 return NULL;
4666
Bram Moolenaare38eab22019-12-05 21:50:01 +01004667 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004668 current_funccal = current_funccal->func->uf_scoped;
4669 while (current_funccal)
4670 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004671 ht = find_var_ht(name, &varname);
4672 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004673 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004674 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004675 if (v != NULL)
4676 break;
4677 }
4678 if (current_funccal == current_funccal->func->uf_scoped)
4679 break;
4680 current_funccal = current_funccal->func->uf_scoped;
4681 }
4682 current_funccal = old_current_funccal;
4683
4684 return v;
4685}
4686
4687/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 * Set "copyID + 1" in previous_funccal and callers.
4689 */
4690 int
4691set_ref_in_previous_funccal(int copyID)
4692{
4693 int abort = FALSE;
4694 funccall_T *fc;
4695
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004696 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004698 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004699 abort = abort
4700 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4701 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004702 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 }
4704 return abort;
4705}
4706
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004707 static int
4708set_ref_in_funccal(funccall_T *fc, int copyID)
4709{
4710 int abort = FALSE;
4711
4712 if (fc->fc_copyID != copyID)
4713 {
4714 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004715 abort = abort
4716 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4717 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004718 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004719 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004720 }
4721 return abort;
4722}
4723
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724/*
4725 * Set "copyID" in all local vars and arguments in the call stack.
4726 */
4727 int
4728set_ref_in_call_stack(int copyID)
4729{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004730 int abort = FALSE;
4731 funccall_T *fc;
4732 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004734 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004735 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004736
4737 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004738 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4739 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004740 abort = abort || set_ref_in_funccal(fc, copyID);
4741
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004742 return abort;
4743}
4744
4745/*
4746 * Set "copyID" in all functions available by name.
4747 */
4748 int
4749set_ref_in_functions(int copyID)
4750{
4751 int todo;
4752 hashitem_T *hi = NULL;
4753 int abort = FALSE;
4754 ufunc_T *fp;
4755
4756 todo = (int)func_hashtab.ht_used;
4757 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004758 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004759 if (!HASHITEM_EMPTY(hi))
4760 {
4761 --todo;
4762 fp = HI2UF(hi);
4763 if (!func_name_refcount(fp->uf_name))
4764 abort = abort || set_ref_in_func(NULL, fp, copyID);
4765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004766 }
4767 return abort;
4768}
4769
4770/*
4771 * Set "copyID" in all function arguments.
4772 */
4773 int
4774set_ref_in_func_args(int copyID)
4775{
4776 int i;
4777 int abort = FALSE;
4778
4779 for (i = 0; i < funcargs.ga_len; ++i)
4780 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4781 copyID, NULL, NULL);
4782 return abort;
4783}
4784
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004785/*
4786 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004787 * Returns TRUE if setting references failed somehow.
4788 */
4789 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004790set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004791{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004792 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004793 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004794 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004795 char_u fname_buf[FLEN_FIXED + 1];
4796 char_u *tofree = NULL;
4797 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004798 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004799
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004800 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004801 return FALSE;
4802
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004803 if (fp_in == NULL)
4804 {
4805 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004806 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004807 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004808 if (fp != NULL)
4809 {
4810 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004811 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004812 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004813
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004814 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004815 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004816}
4817
Bram Moolenaare38eab22019-12-05 21:50:01 +01004818#endif // FEAT_EVAL