blob: 017098d0fcfc6822d0738ce411b9774fbaf8a403 [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 Moolenaar8a7d6542020-01-26 15:56:19 +01001052/*
1053 * Unreference "fc": decrement the reference count and free it when it
1054 * becomes zero. "fp" is detached from "fc".
1055 * When "force" is TRUE we are exiting.
1056 */
1057 static void
1058funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1059{
1060 funccall_T **pfc;
1061 int i;
1062
1063 if (fc == NULL)
1064 return;
1065
1066 if (--fc->fc_refcount <= 0 && (force || (
1067 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1068 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1069 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1070 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1071 {
1072 if (fc == *pfc)
1073 {
1074 *pfc = fc->caller;
1075 free_funccal_contents(fc);
1076 return;
1077 }
1078 }
1079 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1080 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1081 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1082}
1083
1084/*
1085 * Remove the function from the function hashtable. If the function was
1086 * deleted while it still has references this was already done.
1087 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1088 */
1089 static int
1090func_remove(ufunc_T *fp)
1091{
1092 hashitem_T *hi;
1093
1094 // Return if it was already virtually deleted.
1095 if (fp->uf_flags & FC_DEAD)
1096 return FALSE;
1097
1098 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1099 if (!HASHITEM_EMPTY(hi))
1100 {
1101 // When there is a def-function index do not actually remove the
1102 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001103 // Do remove it when it's a copy.
1104 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001105 fp->uf_flags |= FC_DEAD;
1106 else
1107 hash_remove(&func_hashtab, hi);
1108 return TRUE;
1109 }
1110 return FALSE;
1111}
1112
1113 static void
1114func_clear_items(ufunc_T *fp)
1115{
1116 ga_clear_strings(&(fp->uf_args));
1117 ga_clear_strings(&(fp->uf_def_args));
1118 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001119 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001120 VIM_CLEAR(fp->uf_def_arg_idx);
1121 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001122 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001123
1124#ifdef FEAT_LUA
1125 if (fp->uf_cb_free != NULL)
1126 {
1127 fp->uf_cb_free(fp->uf_cb_state);
1128 fp->uf_cb_free = NULL;
1129 }
1130
1131 fp->uf_cb_state = NULL;
1132 fp->uf_cb = NULL;
1133#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001134#ifdef FEAT_PROFILE
1135 VIM_CLEAR(fp->uf_tml_count);
1136 VIM_CLEAR(fp->uf_tml_total);
1137 VIM_CLEAR(fp->uf_tml_self);
1138#endif
1139}
1140
1141/*
1142 * Free all things that a function contains. Does not free the function
1143 * itself, use func_free() for that.
1144 * When "force" is TRUE we are exiting.
1145 */
1146 static void
1147func_clear(ufunc_T *fp, int force)
1148{
1149 if (fp->uf_cleared)
1150 return;
1151 fp->uf_cleared = TRUE;
1152
1153 // clear this function
1154 func_clear_items(fp);
1155 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001156 if ((fp->uf_flags & FC_COPY) == 0)
1157 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001158}
1159
1160/*
1161 * Free a function and remove it from the list of functions. Does not free
1162 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001163 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001164 */
1165 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001166func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001167{
1168 // Only remove it when not done already, otherwise we would remove a newer
1169 // version of the function with the same name.
1170 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1171 func_remove(fp);
1172
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001173 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001174 {
1175 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001176 vim_free(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001177 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001178}
1179
1180/*
1181 * Free all things that a function contains and free the function itself.
1182 * When "force" is TRUE we are exiting.
1183 */
1184 static void
1185func_clear_free(ufunc_T *fp, int force)
1186{
1187 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001188 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001189 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001190 else
1191 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001192}
1193
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001194/*
1195 * Copy already defined function "lambda" to a new function with name "global".
1196 * This is for when a compiled function defines a global function.
1197 */
1198 void
1199copy_func(char_u *lambda, char_u *global)
1200{
1201 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1202 ufunc_T *fp;
1203
1204 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001205 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001206 else
1207 {
1208 // TODO: handle ! to overwrite
1209 fp = find_func(global, TRUE, NULL);
1210 if (fp != NULL)
1211 {
1212 semsg(_(e_funcexts), global);
1213 return;
1214 }
1215
1216 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1217 if (fp == NULL)
1218 return;
1219
1220 fp->uf_varargs = ufunc->uf_varargs;
1221 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1222 fp->uf_def_status = ufunc->uf_def_status;
1223 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001224 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1225 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001226 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001227 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001228 goto failed;
1229
1230 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1231 : vim_strsave(ufunc->uf_name_exp);
1232 if (ufunc->uf_arg_types != NULL)
1233 {
1234 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1235 if (fp->uf_arg_types == NULL)
1236 goto failed;
1237 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1238 sizeof(type_T *) * fp->uf_args.ga_len);
1239 }
1240 if (ufunc->uf_def_arg_idx != NULL)
1241 {
1242 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1243 if (fp->uf_def_arg_idx == NULL)
1244 goto failed;
1245 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1246 sizeof(int) * fp->uf_def_args.ga_len + 1);
1247 }
1248 if (ufunc->uf_va_name != NULL)
1249 {
1250 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1251 if (fp->uf_va_name == NULL)
1252 goto failed;
1253 }
1254
1255 fp->uf_refcount = 1;
1256 STRCPY(fp->uf_name, global);
1257 hash_add(&func_hashtab, UF2HIKEY(fp));
1258 }
1259 return;
1260
1261failed:
1262 func_clear_free(fp, TRUE);
1263}
1264
Bram Moolenaar6914c642017-04-01 21:21:30 +02001265
1266/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267 * Call a user function.
1268 */
1269 static void
1270call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001271 ufunc_T *fp, // pointer to function
1272 int argcount, // nr of args
1273 typval_T *argvars, // arguments
1274 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001275 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001276 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001277{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001278 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001279 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001280 funccall_T *fc;
1281 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001282 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283 static int depth = 0;
1284 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001285 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286 int i;
1287 int ai;
1288 int islambda = FALSE;
1289 char_u numbuf[NUMBUFLEN];
1290 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291#ifdef FEAT_PROFILE
1292 proftime_T wait_start;
1293 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001294 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001296 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001297
Bram Moolenaare38eab22019-12-05 21:50:01 +01001298 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001299 if (depth >= p_mfd)
1300 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001301 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001302 rettv->v_type = VAR_NUMBER;
1303 rettv->vval.v_number = -1;
1304 return;
1305 }
1306 ++depth;
1307
Bram Moolenaare38eab22019-12-05 21:50:01 +01001308 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001310 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001311 if (fc == NULL)
1312 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001313 fc->caller = current_funccal;
1314 current_funccal = fc;
1315 fc->func = fp;
1316 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001318 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001319 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1320 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001321 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001322 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001323 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001325 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001326 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001327 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001328 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001329 --depth;
1330 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001331 free_funccal(fc);
1332 return;
1333 }
1334
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001335 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1336 islambda = TRUE;
1337
1338 /*
1339 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1340 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1341 * each argument variable and saves a lot of time.
1342 */
1343 /*
1344 * Init l: variables.
1345 */
1346 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1347 if (selfdict != NULL)
1348 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001349 // Set l:self to "selfdict". Use "name" to avoid a warning from
1350 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351 v = &fc->fixvar[fixvar_idx++].var;
1352 name = v->di_key;
1353 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001354 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001355 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1356 v->di_tv.v_type = VAR_DICT;
1357 v->di_tv.v_lock = 0;
1358 v->di_tv.vval.v_dict = selfdict;
1359 ++selfdict->dv_refcount;
1360 }
1361
1362 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001363 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001364 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 * Set a:000 to a list with room for the "..." arguments.
1366 */
1367 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001368 if ((fp->uf_flags & FC_NOARGS) == 0)
1369 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001370 (varnumber_T)(argcount >= fp->uf_args.ga_len
1371 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001372 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001373 if ((fp->uf_flags & FC_NOARGS) == 0)
1374 {
1375 // Use "name" to avoid a warning from some compiler that checks the
1376 // destination size.
1377 v = &fc->fixvar[fixvar_idx++].var;
1378 name = v->di_key;
1379 STRCPY(name, "000");
1380 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1381 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1382 v->di_tv.v_type = VAR_LIST;
1383 v->di_tv.v_lock = VAR_FIXED;
1384 v->di_tv.vval.v_list = &fc->l_varlist;
1385 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001386 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001387 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1388 fc->l_varlist.lv_lock = VAR_FIXED;
1389
1390 /*
1391 * Set a:firstline to "firstline" and a:lastline to "lastline".
1392 * Set a:name to named arguments.
1393 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001394 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001395 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001396 if ((fp->uf_flags & FC_NOARGS) == 0)
1397 {
1398 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001399 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001400 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001401 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001402 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001403 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404 {
1405 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001406 typval_T def_rettv;
1407 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408
1409 ai = i - fp->uf_args.ga_len;
1410 if (ai < 0)
1411 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001412 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001413 name = FUNCARG(fp, i);
1414 if (islambda)
1415 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001416
1417 // evaluate named argument default expression
1418 isdefault = ai + fp->uf_def_args.ga_len >= 0
1419 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1420 && argvars[i].vval.v_number == VVAL_NONE));
1421 if (isdefault)
1422 {
1423 char_u *default_expr = NULL;
1424 def_rettv.v_type = VAR_NUMBER;
1425 def_rettv.vval.v_number = -1;
1426
1427 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1428 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001429 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001430 {
1431 default_arg_err = 1;
1432 break;
1433 }
1434 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435 }
1436 else
1437 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001438 if ((fp->uf_flags & FC_NOARGS) != 0)
1439 // Bail out if no a: arguments used (in lambda).
1440 break;
1441
Bram Moolenaare38eab22019-12-05 21:50:01 +01001442 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001443 sprintf((char *)numbuf, "%d", ai + 1);
1444 name = numbuf;
1445 }
1446 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1447 {
1448 v = &fc->fixvar[fixvar_idx++].var;
1449 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001450 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 }
1452 else
1453 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001454 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 if (v == NULL)
1456 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001457 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001458 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001459
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001460 // Note: the values are copied directly to avoid alloc/free.
1461 // "argvars" must have VAR_FIXED for v_lock.
1462 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001463 v->di_tv.v_lock = VAR_FIXED;
1464
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465 if (addlocal)
1466 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001467 // Named arguments should be accessed without the "a:" prefix in
1468 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001469 copy_tv(&v->di_tv, &v->di_tv);
1470 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001471 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001472 else
1473 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474
1475 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1476 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001477 listitem_T *li = &fc->l_listitems[ai];
1478
1479 li->li_tv = argvars[i];
1480 li->li_tv.v_lock = VAR_FIXED;
1481 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482 }
1483 }
1484
Bram Moolenaare38eab22019-12-05 21:50:01 +01001485 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001487
1488 if (fp->uf_flags & FC_SANDBOX)
1489 {
1490 using_sandbox = TRUE;
1491 ++sandbox;
1492 }
1493
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001494 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001495 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001496 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001497 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001498 ++no_wait_return;
1499 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001501 smsg(_("calling %s"), SOURCING_NAME);
1502 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001503 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001504 char_u buf[MSG_BUF_LEN];
1505 char_u numbuf2[NUMBUFLEN];
1506 char_u *tofree;
1507 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001509 msg_puts("(");
1510 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001512 if (i > 0)
1513 msg_puts(", ");
1514 if (argvars[i].v_type == VAR_NUMBER)
1515 msg_outnum((long)argvars[i].vval.v_number);
1516 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001518 // Do not want errors such as E724 here.
1519 ++emsg_off;
1520 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1521 --emsg_off;
1522 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001524 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001526 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1527 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001529 msg_puts((char *)s);
1530 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 }
1532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001533 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001534 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001535 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001536 msg_puts("\n"); // don't overwrite this either
1537
1538 verbose_leave_scroll();
1539 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 }
1541#ifdef FEAT_PROFILE
1542 if (do_profiling == PROF_YES)
1543 {
1544 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001545 {
1546 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001547 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001548 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 if (fp->uf_profiling
1550 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1551 {
1552 ++fp->uf_tm_count;
1553 profile_start(&call_start);
1554 profile_zero(&fp->uf_tm_children);
1555 }
1556 script_prof_save(&wait_start);
1557 }
1558#endif
1559
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001560 save_current_sctx = current_sctx;
1561 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562 save_did_emsg = did_emsg;
1563 did_emsg = FALSE;
1564
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001565 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1566 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001567 else if (islambda)
1568 {
1569 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1570
1571 // A Lambda always has the command "return {expr}". It is much faster
1572 // to evaluate {expr} directly.
1573 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001574 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001575 --ex_nesting_level;
1576 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001577 else
1578 // call do_cmdline() to execute the lines
1579 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1581
1582 --RedrawingDisabled;
1583
Bram Moolenaare38eab22019-12-05 21:50:01 +01001584 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1586 {
1587 clear_tv(rettv);
1588 rettv->v_type = VAR_NUMBER;
1589 rettv->vval.v_number = -1;
1590 }
1591
1592#ifdef FEAT_PROFILE
1593 if (do_profiling == PROF_YES && (fp->uf_profiling
1594 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1595 {
1596 profile_end(&call_start);
1597 profile_sub_wait(&wait_start, &call_start);
1598 profile_add(&fp->uf_tm_total, &call_start);
1599 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1600 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1601 {
1602 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1603 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1604 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001605 if (started_profiling)
1606 // make a ":profdel func" stop profiling the function
1607 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 }
1609#endif
1610
Bram Moolenaare38eab22019-12-05 21:50:01 +01001611 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 if (p_verbose >= 12)
1613 {
1614 ++no_wait_return;
1615 verbose_enter_scroll();
1616
1617 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001618 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001620 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621 (long)fc->rettv->vval.v_number);
1622 else
1623 {
1624 char_u buf[MSG_BUF_LEN];
1625 char_u numbuf2[NUMBUFLEN];
1626 char_u *tofree;
1627 char_u *s;
1628
Bram Moolenaare38eab22019-12-05 21:50:01 +01001629 // The value may be very long. Skip the middle part, so that we
1630 // have some idea how it starts and ends. smsg() would always
1631 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001632 ++emsg_off;
1633 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1634 --emsg_off;
1635 if (s != NULL)
1636 {
1637 if (vim_strsize(s) > MSG_BUF_CLEN)
1638 {
1639 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1640 s = buf;
1641 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001642 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643 vim_free(tofree);
1644 }
1645 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001646 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647
1648 verbose_leave_scroll();
1649 --no_wait_return;
1650 }
1651
Bram Moolenaare31ee862020-01-07 20:59:34 +01001652 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001653 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001654 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001655#ifdef FEAT_PROFILE
1656 if (do_profiling == PROF_YES)
1657 script_prof_restore(&wait_start);
1658#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001659 if (using_sandbox)
1660 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001662 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001663 {
1664 ++no_wait_return;
1665 verbose_enter_scroll();
1666
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001667 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001668 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001669
1670 verbose_leave_scroll();
1671 --no_wait_return;
1672 }
1673
1674 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 --depth;
1676
Bram Moolenaar6914c642017-04-01 21:21:30 +02001677 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001678}
1679
1680/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001681 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001682 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001683 int
1684call_user_func_check(
1685 ufunc_T *fp,
1686 int argcount,
1687 typval_T *argvars,
1688 typval_T *rettv,
1689 funcexe_T *funcexe,
1690 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001691{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001692 int error;
1693 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001694
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001695 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1696 *funcexe->doesrange = TRUE;
1697 if (argcount < regular_args - fp->uf_def_args.ga_len)
1698 error = FCERR_TOOFEW;
1699 else if (!has_varargs(fp) && argcount > regular_args)
1700 error = FCERR_TOOMANY;
1701 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1702 error = FCERR_DICT;
1703 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001704 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001705 int did_save_redo = FALSE;
1706 save_redo_T save_redo;
1707
1708 /*
1709 * Call the user function.
1710 * Save and restore search patterns, script variables and
1711 * redo buffer.
1712 */
1713 save_search_patterns();
1714 if (!ins_compl_active())
1715 {
1716 saveRedobuff(&save_redo);
1717 did_save_redo = TRUE;
1718 }
1719 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001720 call_user_func(fp, argcount, argvars, rettv, funcexe,
1721 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001722 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1723 // Function was unreferenced while being used, free it now.
1724 func_clear_free(fp, FALSE);
1725 if (did_save_redo)
1726 restoreRedobuff(&save_redo);
1727 restore_search_patterns();
1728 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001729 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001730 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001731}
1732
1733/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001734 * There are two kinds of function names:
1735 * 1. ordinary names, function defined with :function
1736 * 2. numbered functions and lambdas
1737 * For the first we only count the name stored in func_hashtab as a reference,
1738 * using function() does not count as a reference, because the function is
1739 * looked up by name.
1740 */
1741 static int
1742func_name_refcount(char_u *name)
1743{
1744 return isdigit(*name) || *name == '<';
1745}
1746
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001747static funccal_entry_T *funccal_stack = NULL;
1748
1749/*
1750 * Save the current function call pointer, and set it to NULL.
1751 * Used when executing autocommands and for ":source".
1752 */
1753 void
1754save_funccal(funccal_entry_T *entry)
1755{
1756 entry->top_funccal = current_funccal;
1757 entry->next = funccal_stack;
1758 funccal_stack = entry;
1759 current_funccal = NULL;
1760}
1761
1762 void
1763restore_funccal(void)
1764{
1765 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001766 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001767 else
1768 {
1769 current_funccal = funccal_stack->top_funccal;
1770 funccal_stack = funccal_stack->next;
1771 }
1772}
1773
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001774 funccall_T *
1775get_current_funccal(void)
1776{
1777 return current_funccal;
1778}
1779
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001780/*
1781 * Mark all functions of script "sid" as deleted.
1782 */
1783 void
1784delete_script_functions(int sid)
1785{
1786 hashitem_T *hi;
1787 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001788 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001789 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001790 size_t len;
1791
1792 buf[0] = K_SPECIAL;
1793 buf[1] = KS_EXTRA;
1794 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001795 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001796 len = STRLEN(buf);
1797
Bram Moolenaarce658352020-07-31 23:47:12 +02001798 while (todo > 0)
1799 {
1800 todo = func_hashtab.ht_used;
1801 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1802 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001803 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001804 fp = HI2UF(hi);
1805 if (STRNCMP(fp->uf_name, buf, len) == 0)
1806 {
1807 int changed = func_hashtab.ht_changed;
1808
1809 fp->uf_flags |= FC_DEAD;
1810 func_clear(fp, TRUE);
1811 // When clearing a function another function can be cleared
1812 // as a side effect. When that happens start over.
1813 if (changed != func_hashtab.ht_changed)
1814 break;
1815 }
1816 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001817 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001818 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001819}
1820
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821#if defined(EXITFREE) || defined(PROTO)
1822 void
1823free_all_functions(void)
1824{
1825 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001826 ufunc_T *fp;
1827 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001828 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001829 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830
Bram Moolenaare38eab22019-12-05 21:50:01 +01001831 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001832 while (current_funccal != NULL)
1833 {
1834 clear_tv(current_funccal->rettv);
1835 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001836 if (current_funccal == NULL && funccal_stack != NULL)
1837 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001838 }
1839
Bram Moolenaare38eab22019-12-05 21:50:01 +01001840 // First clear what the functions contain. Since this may lower the
1841 // reference count of a function, it may also free a function and change
1842 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001843 while (todo > 0)
1844 {
1845 todo = func_hashtab.ht_used;
1846 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1847 if (!HASHITEM_EMPTY(hi))
1848 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001849 // clear the def function index now
1850 fp = HI2UF(hi);
1851 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001852 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001853
Bram Moolenaare38eab22019-12-05 21:50:01 +01001854 // Only free functions that are not refcounted, those are
1855 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001856 if (func_name_refcount(fp->uf_name))
1857 ++skipped;
1858 else
1859 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001860 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001861 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001862 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001863 {
1864 skipped = 0;
1865 break;
1866 }
1867 }
1868 --todo;
1869 }
1870 }
1871
Bram Moolenaare38eab22019-12-05 21:50:01 +01001872 // Now actually free the functions. Need to start all over every time,
1873 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001874 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001875 while (func_hashtab.ht_used > skipped)
1876 {
1877 todo = func_hashtab.ht_used;
1878 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001879 if (!HASHITEM_EMPTY(hi))
1880 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001881 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001882 // Only free functions that are not refcounted, those are
1883 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001884 fp = HI2UF(hi);
1885 if (func_name_refcount(fp->uf_name))
1886 ++skipped;
1887 else
1888 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001889 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001890 skipped = 0;
1891 break;
1892 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001894 }
1895 if (skipped == 0)
1896 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001897
1898 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001899}
1900#endif
1901
1902/*
1903 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001904 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001905 * "len" is the length of "name", or -1 for NUL terminated.
1906 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001907 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001908builtin_function(char_u *name, int len)
1909{
1910 char_u *p;
1911
Bram Moolenaara26b9702020-04-18 19:53:28 +02001912 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001913 return FALSE;
1914 p = vim_strchr(name, AUTOLOAD_CHAR);
1915 return p == NULL || (len > 0 && p > name + len);
1916}
1917
1918 int
1919func_call(
1920 char_u *name,
1921 typval_T *args,
1922 partial_T *partial,
1923 dict_T *selfdict,
1924 typval_T *rettv)
1925{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001926 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 listitem_T *item;
1928 typval_T argv[MAX_FUNC_ARGS + 1];
1929 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001930 int r = 0;
1931
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001932 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001933 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 {
1935 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1936 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001937 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938 break;
1939 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001940 // Make a copy of each argument. This is needed to be able to set
1941 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001942 copy_tv(&item->li_tv, &argv[argc++]);
1943 }
1944
1945 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001946 {
1947 funcexe_T funcexe;
1948
Bram Moolenaara80faa82020-04-12 19:37:17 +02001949 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001950 funcexe.firstline = curwin->w_cursor.lnum;
1951 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001952 funcexe.evaluate = TRUE;
1953 funcexe.partial = partial;
1954 funcexe.selfdict = selfdict;
1955 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1956 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001957
Bram Moolenaare38eab22019-12-05 21:50:01 +01001958 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001959 while (argc > 0)
1960 clear_tv(&argv[--argc]);
1961
1962 return r;
1963}
1964
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001965static int callback_depth = 0;
1966
1967 int
1968get_callback_depth(void)
1969{
1970 return callback_depth;
1971}
1972
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001973/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001974 * Invoke call_func() with a callback.
1975 */
1976 int
1977call_callback(
1978 callback_T *callback,
1979 int len, // length of "name" or -1 to use strlen()
1980 typval_T *rettv, // return value goes here
1981 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001982 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001983 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001984{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001985 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001986 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001987
Bram Moolenaara80faa82020-04-12 19:37:17 +02001988 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001989 funcexe.evaluate = TRUE;
1990 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001991 ++callback_depth;
1992 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1993 --callback_depth;
1994 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001995}
1996
1997/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998 * Give an error message for the result of a function.
1999 * Nothing if "error" is FCERR_NONE.
2000 */
2001 void
2002user_func_error(int error, char_u *name)
2003{
2004 switch (error)
2005 {
2006 case FCERR_UNKNOWN:
2007 emsg_funcname(e_unknownfunc, name);
2008 break;
2009 case FCERR_NOTMETHOD:
2010 emsg_funcname(
2011 N_("E276: Cannot use function as a method: %s"), name);
2012 break;
2013 case FCERR_DELETED:
2014 emsg_funcname(N_(e_func_deleted), name);
2015 break;
2016 case FCERR_TOOMANY:
2017 emsg_funcname((char *)e_toomanyarg, name);
2018 break;
2019 case FCERR_TOOFEW:
2020 emsg_funcname((char *)e_toofewarg, name);
2021 break;
2022 case FCERR_SCRIPT:
2023 emsg_funcname(
2024 N_("E120: Using <SID> not in a script context: %s"), name);
2025 break;
2026 case FCERR_DICT:
2027 emsg_funcname(
2028 N_("E725: Calling dict function without Dictionary: %s"),
2029 name);
2030 break;
2031 }
2032}
2033
2034/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002035 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002036 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002037 * Return FAIL when the function can't be called, OK otherwise.
2038 * Also returns OK when an error was encountered while executing the function.
2039 */
2040 int
2041call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002042 char_u *funcname, // name of the function
2043 int len, // length of "name" or -1 to use strlen()
2044 typval_T *rettv, // return value goes here
2045 int argcount_in, // number of "argvars"
2046 typval_T *argvars_in, // vars for arguments, must have "argcount"
2047 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002048 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002049{
2050 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002051 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002053 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002054 char_u fname_buf[FLEN_FIXED + 1];
2055 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002056 char_u *fname = NULL;
2057 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058 int argcount = argcount_in;
2059 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002060 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002061 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2062 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002063 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002064 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002065 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002066
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002067 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2068 // even when call_func() returns FAIL.
2069 rettv->v_type = VAR_UNKNOWN;
2070
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002071 if (partial != NULL)
2072 fp = partial->pt_func;
2073 if (fp == NULL)
2074 {
2075 // Make a copy of the name, if it comes from a funcref variable it
2076 // could be changed or deleted in the called function.
2077 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2078 if (name == NULL)
2079 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002080
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002081 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2082 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002083
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002084 if (funcexe->doesrange != NULL)
2085 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002086
2087 if (partial != NULL)
2088 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002089 // When the function has a partial with a dict and there is a dict
2090 // argument, use the dict argument. That is backwards compatible.
2091 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002092 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002093 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002094 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002095 {
2096 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002097 {
2098 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2099 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002100 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002101 goto theend;
2102 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002103 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002104 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002105 for (i = 0; i < argcount_in; ++i)
2106 argv[i + argv_clear] = argvars_in[i];
2107 argvars = argv;
2108 argcount = partial->pt_argc + argcount_in;
2109 }
2110 }
2111
Bram Moolenaaref140542019-12-31 21:27:13 +01002112 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002113 {
2114 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002115 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116
Bram Moolenaar333894b2020-08-01 18:53:07 +02002117 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002118 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002119 {
2120 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002121 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002122 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002123
Bram Moolenaare38eab22019-12-05 21:50:01 +01002124 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002126 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002127
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002128 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002129 {
2130 /*
2131 * User defined function.
2132 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002133 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002134 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002135
Bram Moolenaare38eab22019-12-05 21:50:01 +01002136 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002137 if (fp == NULL
2138 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002139 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002140 && !aborting())
2141 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002142 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002143 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002144 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002146 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2147 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002148 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002149 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002150 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002151 if (fp == NULL)
2152 {
2153 char_u *p = untrans_function_name(rfname);
2154
2155 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002156 // Don't do this if the name starts with "s:".
2157 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002158 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002159 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002160
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002161 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002162 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002163#ifdef FEAT_LUA
2164 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2165 {
2166 cfunc_T cb = fp->uf_cb;
2167
2168 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2169 }
2170#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002171 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002172 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002173 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002174 // postponed filling in the arguments, do it now
2175 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002176 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002177
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002178 if (funcexe->basetv != NULL)
2179 {
2180 // Method call: base->Method()
2181 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2182 argv[0] = *funcexe->basetv;
2183 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002184 argvars = argv;
2185 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002186 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002187
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002188 error = call_user_func_check(fp, argcount, argvars, rettv,
2189 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002190 }
2191 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002192 else if (funcexe->basetv != NULL)
2193 {
2194 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002195 * expr->method(): Find the method name in the table, call its
2196 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002197 */
2198 error = call_internal_method(fname, argcount, argvars, rettv,
2199 funcexe->basetv);
2200 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002201 else
2202 {
2203 /*
2204 * Find the function name in the table, call its implementation.
2205 */
2206 error = call_internal_func(fname, argcount, argvars, rettv);
2207 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002208
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209 /*
2210 * The function call (or "FuncUndefined" autocommand sequence) might
2211 * have been aborted by an error, an interrupt, or an explicitly thrown
2212 * exception that has not been caught so far. This situation can be
2213 * tested for by calling aborting(). For an error in an internal
2214 * function or for the "E132" error in call_user_func(), however, the
2215 * throw point at which the "force_abort" flag (temporarily reset by
2216 * emsg()) is normally updated has not been reached yet. We need to
2217 * update that flag first to make aborting() reliable.
2218 */
2219 update_force_abort();
2220 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002221 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002222 ret = OK;
2223
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002224theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002225 /*
2226 * Report an error unless the argument evaluation or function call has been
2227 * cancelled due to an aborting error, an interrupt, or an exception.
2228 */
2229 if (!aborting())
2230 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002231 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232 }
2233
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002234 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002235 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002236 clear_tv(&argv[--argv_clear + argv_base]);
2237
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002238 vim_free(tofree);
2239 vim_free(name);
2240
2241 return ret;
2242}
2243
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002244 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002245printable_func_name(ufunc_T *fp)
2246{
2247 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2248}
2249
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002250/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002251 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002252 */
2253 static void
2254list_func_head(ufunc_T *fp, int indent)
2255{
2256 int j;
2257
2258 msg_start();
2259 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002260 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002261 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002262 msg_puts("def ");
2263 else
2264 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002265 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002266 msg_putchar('(');
2267 for (j = 0; j < fp->uf_args.ga_len; ++j)
2268 {
2269 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002270 msg_puts(", ");
2271 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002272 if (fp->uf_arg_types != NULL)
2273 {
2274 char *tofree;
2275
2276 msg_puts(": ");
2277 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2278 vim_free(tofree);
2279 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002280 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2281 {
2282 msg_puts(" = ");
2283 msg_puts(((char **)(fp->uf_def_args.ga_data))
2284 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2285 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 }
2287 if (fp->uf_varargs)
2288 {
2289 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002290 msg_puts(", ");
2291 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293 if (fp->uf_va_name != NULL)
2294 {
2295 if (j)
2296 msg_puts(", ");
2297 msg_puts("...");
2298 msg_puts((char *)fp->uf_va_name);
2299 if (fp->uf_va_type)
2300 {
2301 char *tofree;
2302
2303 msg_puts(": ");
2304 msg_puts(type_name(fp->uf_va_type, &tofree));
2305 vim_free(tofree);
2306 }
2307 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002308 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002309
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002310 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002311 {
2312 if (fp->uf_ret_type != &t_void)
2313 {
2314 char *tofree;
2315
2316 msg_puts(": ");
2317 msg_puts(type_name(fp->uf_ret_type, &tofree));
2318 vim_free(tofree);
2319 }
2320 }
2321 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002322 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002323 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002324 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002325 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002326 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002327 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002328 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002329 msg_clr_eos();
2330 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002331 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332}
2333
2334/*
2335 * Get a function name, translating "<SID>" and "<SNR>".
2336 * Also handles a Funcref in a List or Dictionary.
2337 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002338 * Set "*is_global" to TRUE when the function must be global, unless
2339 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340 * flags:
2341 * TFN_INT: internal function name OK
2342 * TFN_QUIET: be quiet
2343 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002344 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345 * Advances "pp" to just after the function name (if no error).
2346 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002347 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348trans_function_name(
2349 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002350 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002351 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002353 funcdict_T *fdp, // return: info about dictionary used
2354 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355{
2356 char_u *name = NULL;
2357 char_u *start;
2358 char_u *end;
2359 int lead;
2360 char_u sid_buf[20];
2361 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002362 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002364 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002365
2366 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002367 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002368 start = *pp;
2369
Bram Moolenaare38eab22019-12-05 21:50:01 +01002370 // Check for hard coded <SNR>: already translated function ID (from a user
2371 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2373 && (*pp)[2] == (int)KE_SNR)
2374 {
2375 *pp += 3;
2376 len = get_id_len(pp) + 3;
2377 return vim_strnsave(start, len);
2378 }
2379
Bram Moolenaare38eab22019-12-05 21:50:01 +01002380 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2381 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 lead = eval_fname_script(start);
2383 if (lead > 2)
2384 start += lead;
2385
Bram Moolenaare38eab22019-12-05 21:50:01 +01002386 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002387 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002388 lead > 2 ? 0 : FNE_CHECK_START);
2389 if (end == start)
2390 {
2391 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002392 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 goto theend;
2394 }
2395 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2396 {
2397 /*
2398 * Report an invalid expression in braces, unless the expression
2399 * evaluation has been cancelled due to an aborting error, an
2400 * interrupt, or an exception.
2401 */
2402 if (!aborting())
2403 {
2404 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002405 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 }
2407 else
2408 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2409 goto theend;
2410 }
2411
2412 if (lv.ll_tv != NULL)
2413 {
2414 if (fdp != NULL)
2415 {
2416 fdp->fd_dict = lv.ll_dict;
2417 fdp->fd_newkey = lv.ll_newkey;
2418 lv.ll_newkey = NULL;
2419 fdp->fd_di = lv.ll_di;
2420 }
2421 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2422 {
2423 name = vim_strsave(lv.ll_tv->vval.v_string);
2424 *pp = end;
2425 }
2426 else if (lv.ll_tv->v_type == VAR_PARTIAL
2427 && lv.ll_tv->vval.v_partial != NULL)
2428 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002429 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 *pp = end;
2431 if (partial != NULL)
2432 *partial = lv.ll_tv->vval.v_partial;
2433 }
2434 else
2435 {
2436 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2437 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002438 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439 else
2440 *pp = end;
2441 name = NULL;
2442 }
2443 goto theend;
2444 }
2445
2446 if (lv.ll_name == NULL)
2447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002448 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 *pp = end;
2450 goto theend;
2451 }
2452
Bram Moolenaare38eab22019-12-05 21:50:01 +01002453 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 if (lv.ll_exp_name != NULL)
2455 {
2456 len = (int)STRLEN(lv.ll_exp_name);
2457 name = deref_func_name(lv.ll_exp_name, &len, partial,
2458 flags & TFN_NO_AUTOLOAD);
2459 if (name == lv.ll_exp_name)
2460 name = NULL;
2461 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002462 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 {
2464 len = (int)(end - *pp);
2465 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2466 if (name == *pp)
2467 name = NULL;
2468 }
2469 if (name != NULL)
2470 {
2471 name = vim_strsave(name);
2472 *pp = end;
2473 if (STRNCMP(name, "<SNR>", 5) == 0)
2474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002475 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 name[0] = K_SPECIAL;
2477 name[1] = KS_EXTRA;
2478 name[2] = (int)KE_SNR;
2479 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2480 }
2481 goto theend;
2482 }
2483
2484 if (lv.ll_exp_name != NULL)
2485 {
2486 len = (int)STRLEN(lv.ll_exp_name);
2487 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2488 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2489 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002490 // When there was "s:" already or the name expanded to get a
2491 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492 lv.ll_name += 2;
2493 len -= 2;
2494 lead = 2;
2495 }
2496 }
2497 else
2498 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002499 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002501 {
2502 if (is_global != NULL && lv.ll_name[0] == 'g')
2503 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 len = (int)(end - lv.ll_name);
2507 }
2508
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002509 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002510 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002511
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 /*
2513 * Copy the function name to allocated memory.
2514 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2515 * Accept <SNR>123_name() outside a script.
2516 */
2517 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002518 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002519 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002521 if (!vim9script)
2522 lead = 3;
2523 if (vim9script || (lv.ll_exp_name != NULL
2524 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 || eval_fname_sid(*pp))
2526 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002527 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002528 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002530 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 goto theend;
2532 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002533 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002534 if (vim9script)
2535 extra = 3 + (int)STRLEN(sid_buf);
2536 else
2537 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 }
2539 }
2540 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2541 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002542 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 start);
2544 goto theend;
2545 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002546 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 {
2548 char_u *cp = vim_strchr(lv.ll_name, ':');
2549
2550 if (cp != NULL && cp < end)
2551 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002552 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 goto theend;
2554 }
2555 }
2556
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002557 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 if (name != NULL)
2559 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002560 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 {
2562 name[0] = K_SPECIAL;
2563 name[1] = KS_EXTRA;
2564 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002565 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566 STRCPY(name + 3, sid_buf);
2567 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002568 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2569 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 }
2571 *pp = end;
2572
2573theend:
2574 clear_lval(&lv);
2575 return name;
2576}
2577
2578/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002579 * Assuming "name" is the result of trans_function_name() and it was prefixed
2580 * to use the script-local name, return the unmodified name (points into
2581 * "name"). Otherwise return NULL.
2582 * This can be used to first search for a script-local function and fall back
2583 * to the global function if not found.
2584 */
2585 char_u *
2586untrans_function_name(char_u *name)
2587{
2588 char_u *p;
2589
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002590 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002591 {
2592 p = vim_strchr(name, '_');
2593 if (p != NULL)
2594 return p + 1;
2595 }
2596 return NULL;
2597}
2598
2599/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002600 * List functions. When "regmatch" is NULL all of then.
2601 * Otherwise functions matching "regmatch".
2602 */
2603 static void
2604list_functions(regmatch_T *regmatch)
2605{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002606 int changed = func_hashtab.ht_changed;
2607 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002608 hashitem_T *hi;
2609
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002610 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002611 {
2612 if (!HASHITEM_EMPTY(hi))
2613 {
2614 ufunc_T *fp = HI2UF(hi);
2615
2616 --todo;
2617 if ((fp->uf_flags & FC_DEAD) == 0
2618 && (regmatch == NULL
2619 ? !message_filtered(fp->uf_name)
2620 && !func_name_refcount(fp->uf_name)
2621 : !isdigit(*fp->uf_name)
2622 && vim_regexec(regmatch, fp->uf_name, 0)))
2623 {
2624 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002625 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002626 {
2627 emsg(_("E454: function list was modified"));
2628 return;
2629 }
2630 }
2631 }
2632 }
2633}
2634
2635/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002636 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002637 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2638 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002639 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002641 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002642def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643{
2644 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002645 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 int j;
2647 int c;
2648 int saved_did_emsg;
2649 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002650 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002651 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 char_u *p;
2653 char_u *arg;
2654 char_u *line_arg = NULL;
2655 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002656 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002657 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658 garray_T newlines;
2659 int varargs = FALSE;
2660 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002661 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002662 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002663 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 int indent;
2665 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002666#define MAX_FUNC_NESTING 50
2667 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 dictitem_T *v;
2669 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002670 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002671 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002673 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002674 linenr_T sourcing_lnum_off;
2675 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002676 int is_heredoc = FALSE;
2677 char_u *skip_until = NULL;
2678 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002679 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002680 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681
2682 /*
2683 * ":function" without argument: list functions.
2684 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002685 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 {
2687 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002688 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002690 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 }
2692
2693 /*
2694 * ":function /pat": list functions matching pattern.
2695 */
2696 if (*eap->arg == '/')
2697 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002698 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 if (!eap->skip)
2700 {
2701 regmatch_T regmatch;
2702
2703 c = *p;
2704 *p = NUL;
2705 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2706 *p = c;
2707 if (regmatch.regprog != NULL)
2708 {
2709 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002710 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 vim_regfree(regmatch.regprog);
2712 }
2713 }
2714 if (*p == '/')
2715 ++p;
2716 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002717 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 }
2719
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002720 ga_init(&newargs);
2721 ga_init(&argtypes);
2722 ga_init(&default_args);
2723
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 /*
2725 * Get the function name. There are these situations:
2726 * func normal function name
2727 * "name" == func, "fudi.fd_dict" == NULL
2728 * dict.func new dictionary entry
2729 * "name" == NULL, "fudi.fd_dict" set,
2730 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2731 * dict.func existing dict entry with a Funcref
2732 * "name" == func, "fudi.fd_dict" set,
2733 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2734 * dict.func existing dict entry that's not a Funcref
2735 * "name" == NULL, "fudi.fd_dict" set,
2736 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2737 * s:func script-local function name
2738 * g:func global function name, same as "func"
2739 */
2740 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002741 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002743 // nested function, argument is (args).
2744 paren = TRUE;
2745 CLEAR_FIELD(fudi);
2746 }
2747 else
2748 {
2749 name = trans_function_name(&p, &is_global, eap->skip,
2750 TFN_NO_AUTOLOAD, &fudi, NULL);
2751 paren = (vim_strchr(p, '(') != NULL);
2752 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002754 /*
2755 * Return on an invalid expression in braces, unless the expression
2756 * evaluation has been cancelled due to an aborting error, an
2757 * interrupt, or an exception.
2758 */
2759 if (!aborting())
2760 {
2761 if (!eap->skip && fudi.fd_newkey != NULL)
2762 semsg(_(e_dictkey), fudi.fd_newkey);
2763 vim_free(fudi.fd_newkey);
2764 return NULL;
2765 }
2766 else
2767 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 }
2770
Bram Moolenaare38eab22019-12-05 21:50:01 +01002771 // An error in a function call during evaluation of an expression in magic
2772 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 saved_did_emsg = did_emsg;
2774 did_emsg = FALSE;
2775
2776 /*
2777 * ":function func" with only function name: list function.
2778 */
2779 if (!paren)
2780 {
2781 if (!ends_excmd(*skipwhite(p)))
2782 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002783 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002784 goto ret_free;
2785 }
2786 eap->nextcmd = check_nextcmd(p);
2787 if (eap->nextcmd != NULL)
2788 *p = NUL;
2789 if (!eap->skip && !got_int)
2790 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002791 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002792 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2793 {
2794 char_u *up = untrans_function_name(name);
2795
2796 // With Vim9 script the name was made script-local, if not
2797 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002798 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002799 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002800 }
2801
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 if (fp != NULL)
2803 {
2804 list_func_head(fp, TRUE);
2805 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2806 {
2807 if (FUNCLINE(fp, j) == NULL)
2808 continue;
2809 msg_putchar('\n');
2810 msg_outnum((long)(j + 1));
2811 if (j < 9)
2812 msg_putchar(' ');
2813 if (j < 99)
2814 msg_putchar(' ');
2815 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002816 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 ui_breakcheck();
2818 }
2819 if (!got_int)
2820 {
2821 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002822 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002823 msg_puts(" enddef");
2824 else
2825 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 }
2827 }
2828 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002829 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830 }
2831 goto ret_free;
2832 }
2833
2834 /*
2835 * ":function name(arg1, arg2)" Define function.
2836 */
2837 p = skipwhite(p);
2838 if (*p != '(')
2839 {
2840 if (!eap->skip)
2841 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002842 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 goto ret_free;
2844 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002845 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002846 if (vim_strchr(p, '(') != NULL)
2847 p = vim_strchr(p, '(');
2848 }
2849 p = skipwhite(p + 1);
2850
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002851 // In Vim9 script only global functions can be redefined.
2852 if (vim9script && eap->forceit && !is_global)
2853 {
2854 emsg(_(e_nobang));
2855 goto ret_free;
2856 }
2857
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2859
Bram Moolenaar04b12692020-05-04 23:24:44 +02002860 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002862 // Check the name of the function. Unless it's a dictionary function
2863 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 if (name != NULL)
2865 arg = name;
2866 else
2867 arg = fudi.fd_newkey;
2868 if (arg != NULL && (fudi.fd_di == NULL
2869 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2870 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2871 {
2872 if (*arg == K_SPECIAL)
2873 j = 3;
2874 else
2875 j = 0;
2876 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2877 : eval_isnamec(arg[j])))
2878 ++j;
2879 if (arg[j] != NUL)
2880 emsg_funcname((char *)e_invarg2, arg);
2881 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002882 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002884 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002885 }
2886
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002887 // This may get more lines and make the pointers into the first line
2888 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002889 if (get_function_args(&p, ')', &newargs,
2890 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002891 &varargs, &default_args, eap->skip,
2892 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 goto errret_2;
2894
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002895 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002897 // find the return type: :def Func(): type
2898 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002899 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002900 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002901 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002903 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002904 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002906 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002907 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002908 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002909 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002910 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002911 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002913 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002914 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002915 else
2916 // find extra arguments "range", "dict", "abort" and "closure"
2917 for (;;)
2918 {
2919 p = skipwhite(p);
2920 if (STRNCMP(p, "range", 5) == 0)
2921 {
2922 flags |= FC_RANGE;
2923 p += 5;
2924 }
2925 else if (STRNCMP(p, "dict", 4) == 0)
2926 {
2927 flags |= FC_DICT;
2928 p += 4;
2929 }
2930 else if (STRNCMP(p, "abort", 5) == 0)
2931 {
2932 flags |= FC_ABORT;
2933 p += 5;
2934 }
2935 else if (STRNCMP(p, "closure", 7) == 0)
2936 {
2937 flags |= FC_CLOSURE;
2938 p += 7;
2939 if (current_funccal == NULL)
2940 {
2941 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2942 name == NULL ? (char_u *)"" : name);
2943 goto erret;
2944 }
2945 }
2946 else
2947 break;
2948 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949
Bram Moolenaare38eab22019-12-05 21:50:01 +01002950 // When there is a line break use what follows for the function body.
2951 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 if (*p == '\n')
2953 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002954 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002955 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2956 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002957 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2958 && !eap->skip
2959 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002960 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961
2962 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002963 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2964 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 */
2966 if (KeyTyped)
2967 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002968 // Check if the function already exists, don't let the user type the
2969 // whole function before telling him it doesn't work! For a script we
2970 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971 if (!eap->skip && !eap->forceit)
2972 {
2973 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002974 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002975 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002976 emsg_funcname(e_funcexts, name);
2977 }
2978
2979 if (!eap->skip && did_emsg)
2980 goto erret;
2981
Bram Moolenaare38eab22019-12-05 21:50:01 +01002982 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 cmdline_row = msg_row;
2984 }
2985
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002986 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002987 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002988
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002989 // Detect having skipped over comment lines to find the return
2990 // type. Add NULL lines to keep the line count correct.
2991 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2992 if (SOURCING_LNUM < sourcing_lnum_off)
2993 {
2994 sourcing_lnum_off -= SOURCING_LNUM;
2995 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
2996 goto erret;
2997 while (sourcing_lnum_off-- > 0)
2998 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2999 }
3000
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 indent = 2;
3002 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003003 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 for (;;)
3005 {
3006 if (KeyTyped)
3007 {
3008 msg_scroll = TRUE;
3009 saved_wait_return = FALSE;
3010 }
3011 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012
3013 if (line_arg != NULL)
3014 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003015 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 theline = line_arg;
3017 p = vim_strchr(theline, '\n');
3018 if (p == NULL)
3019 line_arg += STRLEN(line_arg);
3020 else
3021 {
3022 *p = NUL;
3023 line_arg = p + 1;
3024 }
3025 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003027 {
3028 vim_free(line_to_free);
3029 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003030 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003031 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003032 theline = eap->getline(':', eap->cookie, indent,
3033 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003034 line_to_free = theline;
3035 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003036 if (KeyTyped)
3037 lines_left = Rows - 1;
3038 if (theline == NULL)
3039 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003040 if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003041 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003042 else
3043 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044 goto erret;
3045 }
3046
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003047 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003048 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003049 if (SOURCING_LNUM < sourcing_lnum_off)
3050 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 else
3052 sourcing_lnum_off = 0;
3053
3054 if (skip_until != NULL)
3055 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003056 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003057 // * ":append" and "."
3058 // * ":python <<EOF" and "EOF"
3059 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3060 if (heredoc_trimmed == NULL
3061 || (is_heredoc && skipwhite(theline) == theline)
3062 || STRNCMP(theline, heredoc_trimmed,
3063 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003064 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003065 if (heredoc_trimmed == NULL)
3066 p = theline;
3067 else if (is_heredoc)
3068 p = skipwhite(theline) == theline
3069 ? theline : theline + STRLEN(heredoc_trimmed);
3070 else
3071 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003072 if (STRCMP(p, skip_until) == 0)
3073 {
3074 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003075 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003076 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003077 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003078 }
3079 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003080 }
3081 else
3082 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003083 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003084 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085 ;
3086
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003087 // Check for "endfunction" or "enddef".
3088 if (checkforcmd(&p, nesting_def[nesting]
3089 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003090 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003091 char_u *nextcmd = NULL;
3092
Bram Moolenaar663bb232017-06-22 19:12:10 +02003093 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003094 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003095 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003096 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003097 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003098 give_warning2(eap->cmdidx == CMD_def
3099 ? (char_u *)_("W1001: Text found after :enddef: %s")
3100 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003101 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003102 if (nextcmd != NULL)
3103 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003104 // Another command follows. If the line came from "eap" we
3105 // can simply point into it, otherwise we need to change
3106 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003107 eap->nextcmd = nextcmd;
3108 if (line_to_free != NULL)
3109 {
3110 vim_free(*eap->cmdlinep);
3111 *eap->cmdlinep = line_to_free;
3112 line_to_free = NULL;
3113 }
3114 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 break;
3116 }
3117
Bram Moolenaare38eab22019-12-05 21:50:01 +01003118 // Increase indent inside "if", "while", "for" and "try", decrease
3119 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003120 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121 indent -= 2;
3122 else if (STRNCMP(p, "if", 2) == 0
3123 || STRNCMP(p, "wh", 2) == 0
3124 || STRNCMP(p, "for", 3) == 0
3125 || STRNCMP(p, "try", 3) == 0)
3126 indent += 2;
3127
Bram Moolenaare38eab22019-12-05 21:50:01 +01003128 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003129 // Only recognize "def" inside "def", not inside "function",
3130 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003131 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003132 if (checkforcmd(&p, "function", 2)
3133 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 {
3135 if (*p == '!')
3136 p = skipwhite(p + 1);
3137 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003138 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 if (*skipwhite(p) == '(')
3140 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003141 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003142 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003143 else
3144 {
3145 ++nesting;
3146 nesting_def[nesting] = (c == 'd');
3147 indent += 2;
3148 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003149 }
3150 }
3151
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003152 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003153 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003154 if (eap->cmdidx != CMD_def
3155 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003156 || (p[0] == 'c'
3157 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3158 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3159 && (STRNCMP(&p[3], "nge", 3) != 0
3160 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 || (p[0] == 'i'
3162 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003163 && (!ASCII_ISALPHA(p[2])
3164 || (p[2] == 's'
3165 && (!ASCII_ISALPHA(p[3])
3166 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 skip_until = vim_strsave((char_u *)".");
3168
Bram Moolenaare38eab22019-12-05 21:50:01 +01003169 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003170 arg = skipwhite(skiptowhite(p));
3171 if (arg[0] == '<' && arg[1] =='<'
3172 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003173 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3174 || ((p[2] == '3' || p[2] == 'x')
3175 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003176 || (p[0] == 'p' && p[1] == 'e'
3177 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3178 || (p[0] == 't' && p[1] == 'c'
3179 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3180 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3181 && !ASCII_ISALPHA(p[3]))
3182 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3183 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3184 || (p[0] == 'm' && p[1] == 'z'
3185 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3186 ))
3187 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003188 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003189 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003190 if (STRNCMP(p, "trim", 4) == 0)
3191 {
3192 // Ignore leading white space.
3193 p = skipwhite(p + 4);
3194 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003195 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003196 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003197 if (*p == NUL)
3198 skip_until = vim_strsave((char_u *)".");
3199 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003200 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003201 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003202 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003204
3205 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003206 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003207 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003208 if (*arg == '[')
3209 arg = vim_strchr(arg, ']');
3210 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003211 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003212 arg = skipwhite(skiptowhite(arg));
3213 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3214 && ((p[0] == 'l'
3215 && p[1] == 'e'
3216 && (!ASCII_ISALNUM(p[2])
3217 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003218 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003219 p = skipwhite(arg + 3);
3220 if (STRNCMP(p, "trim", 4) == 0)
3221 {
3222 // Ignore leading white space.
3223 p = skipwhite(p + 4);
3224 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003225 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003226 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003227 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003228 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003229 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003230 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003231 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 }
3233
Bram Moolenaare38eab22019-12-05 21:50:01 +01003234 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237
Bram Moolenaare38eab22019-12-05 21:50:01 +01003238 // Copy the line to newly allocated memory. get_one_sourceline()
3239 // allocates 250 bytes per line, this saves 80% on average. The cost
3240 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003242 if (p == NULL)
3243 goto erret;
3244 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245
Bram Moolenaare38eab22019-12-05 21:50:01 +01003246 // Add NULL lines for continuation lines, so that the line count is
3247 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 while (sourcing_lnum_off-- > 0)
3249 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3250
Bram Moolenaare38eab22019-12-05 21:50:01 +01003251 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 if (line_arg != NULL && *line_arg == NUL)
3253 line_arg = NULL;
3254 }
3255
Bram Moolenaare38eab22019-12-05 21:50:01 +01003256 // Don't define the function when skipping commands or when an error was
3257 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258 if (eap->skip || did_emsg)
3259 goto erret;
3260
3261 /*
3262 * If there are no errors, add the function
3263 */
3264 if (fudi.fd_dict == NULL)
3265 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266 hashtab_T *ht;
3267
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 v = find_var(name, &ht, FALSE);
3269 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3270 {
3271 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3272 name);
3273 goto erret;
3274 }
3275
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003276 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003277 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003279 char_u *uname = untrans_function_name(name);
3280
3281 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3282 }
3283
3284 if (fp != NULL || import != NULL)
3285 {
3286 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003288 // Function can be replaced with "function!" and when sourcing the
3289 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003290 // A name that is used by an import can not be overruled.
3291 if (import != NULL
3292 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003293 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003294 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003295 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003296 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003297 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003298 else
3299 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003300 goto erret;
3301 }
3302 if (fp->uf_calls > 0)
3303 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003304 emsg_funcname(
3305 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 name);
3307 goto erret;
3308 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003309 if (fp->uf_refcount > 1)
3310 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003311 // This function is referenced somewhere, don't redefine it but
3312 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003313 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003314 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003315 fp = NULL;
3316 overwrite = TRUE;
3317 }
3318 else
3319 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003320 char_u *exp_name = fp->uf_name_exp;
3321
3322 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003323 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003324 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003325 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003326 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003327 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003328#ifdef FEAT_PROFILE
3329 fp->uf_profiling = FALSE;
3330 fp->uf_prof_initialized = FALSE;
3331#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003332 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334 }
3335 }
3336 else
3337 {
3338 char numbuf[20];
3339
3340 fp = NULL;
3341 if (fudi.fd_newkey == NULL && !eap->forceit)
3342 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003343 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 goto erret;
3345 }
3346 if (fudi.fd_di == NULL)
3347 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003348 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003349 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 goto erret;
3351 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003352 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003353 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 goto erret;
3355
Bram Moolenaare38eab22019-12-05 21:50:01 +01003356 // Give the function a sequential number. Can only be used with a
3357 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 vim_free(name);
3359 sprintf(numbuf, "%d", ++func_nr);
3360 name = vim_strsave((char_u *)numbuf);
3361 if (name == NULL)
3362 goto erret;
3363 }
3364
3365 if (fp == NULL)
3366 {
3367 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3368 {
3369 int slen, plen;
3370 char_u *scriptname;
3371
Bram Moolenaare38eab22019-12-05 21:50:01 +01003372 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003374 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 {
3376 scriptname = autoload_name(name);
3377 if (scriptname != NULL)
3378 {
3379 p = vim_strchr(scriptname, '/');
3380 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003381 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003383 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 j = OK;
3385 vim_free(scriptname);
3386 }
3387 }
3388 if (j == FAIL)
3389 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003390 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 goto erret;
3392 }
3393 }
3394
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003395 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 if (fp == NULL)
3397 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003398 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003399 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400
3401 if (fudi.fd_dict != NULL)
3402 {
3403 if (fudi.fd_di == NULL)
3404 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003405 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3407 if (fudi.fd_di == NULL)
3408 {
3409 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003410 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411 goto erret;
3412 }
3413 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3414 {
3415 vim_free(fudi.fd_di);
3416 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003417 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 goto erret;
3419 }
3420 }
3421 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003422 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 clear_tv(&fudi.fd_di->di_tv);
3424 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426
Bram Moolenaare38eab22019-12-05 21:50:01 +01003427 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 flags |= FC_DICT;
3429 }
3430
Bram Moolenaare38eab22019-12-05 21:50:01 +01003431 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003432 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003433 if (overwrite)
3434 {
3435 hi = hash_find(&func_hashtab, name);
3436 hi->hi_key = UF2HIKEY(fp);
3437 }
3438 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 {
3440 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003441 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 goto erret;
3443 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003444 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 }
3446 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003447 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003448 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003449 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003450
3451 if (eap->cmdidx == CMD_def)
3452 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003453 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003454
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003455 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003456
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003457 // error messages are for the first function line
3458 SOURCING_LNUM = sourcing_lnum_top;
3459
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003460 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003461 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462
3463 if (argtypes.ga_len > 0)
3464 {
3465 // When "varargs" is set the last name/type goes into uf_va_name
3466 // and uf_va_type.
3467 int len = argtypes.ga_len - (varargs ? 1 : 0);
3468
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003469 if (len > 0)
3470 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003471 if (fp->uf_arg_types != NULL)
3472 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003473 int i;
3474 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003475
3476 for (i = 0; i < len; ++ i)
3477 {
3478 p = ((char_u **)argtypes.ga_data)[i];
3479 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003480 // will get the type from the default value
3481 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003482 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003483 type = parse_type(&p, &fp->uf_type_list);
3484 if (type == NULL)
3485 {
3486 SOURCING_LNUM = lnum_save;
3487 goto errret_2;
3488 }
3489 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003490 }
3491 }
3492 if (varargs)
3493 {
3494 // Move the last argument "...name: type" to uf_va_name and
3495 // uf_va_type.
3496 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3497 [fp->uf_args.ga_len - 1];
3498 --fp->uf_args.ga_len;
3499 p = ((char_u **)argtypes.ga_data)[len];
3500 if (p == NULL)
3501 // todo: get type from default value
3502 fp->uf_va_type = &t_any;
3503 else
3504 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003505 if (fp->uf_va_type == NULL)
3506 {
3507 SOURCING_LNUM = lnum_save;
3508 goto errret_2;
3509 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003510 }
3511 varargs = FALSE;
3512 }
3513
3514 // parse the return type, if any
3515 if (ret_type == NULL)
3516 fp->uf_ret_type = &t_void;
3517 else
3518 {
3519 p = ret_type;
3520 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3521 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003522 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003523 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003524 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003525 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003526
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003527 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003528 if ((flags & FC_CLOSURE) != 0)
3529 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003530 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003531 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003532 }
3533 else
3534 fp->uf_scoped = NULL;
3535
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537 if (prof_def_func())
3538 func_do_profile(fp);
3539#endif
3540 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003541 if (sandbox)
3542 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003543 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003544 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 fp->uf_flags = flags;
3546 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003547 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003548 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003549 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003550 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003551 if (is_export)
3552 {
3553 fp->uf_flags |= FC_EXPORT;
3554 // let ex_export() know the export worked.
3555 is_export = FALSE;
3556 }
3557
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003558 if (eap->cmdidx == CMD_def)
3559 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003560 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3561 // :func does not use Vim9 script syntax, even in a Vim9 script file
3562 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003563
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 goto ret_free;
3565
3566erret:
3567 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003568 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003569errret_2:
3570 ga_clear_strings(&newlines);
3571ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003572 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003574 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003576 if (name != name_arg)
3577 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003578 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 did_emsg |= saved_did_emsg;
3580 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003581
3582 return fp;
3583}
3584
3585/*
3586 * ":function"
3587 */
3588 void
3589ex_function(exarg_T *eap)
3590{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003591 (void)def_function(eap, NULL);
3592}
3593
3594/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003595 * :defcompile - compile all :def functions in the current script that need to
3596 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003597 */
3598 void
3599ex_defcompile(exarg_T *eap UNUSED)
3600{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003601 long todo = (long)func_hashtab.ht_used;
3602 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003603 hashitem_T *hi;
3604 ufunc_T *ufunc;
3605
3606 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3607 {
3608 if (!HASHITEM_EMPTY(hi))
3609 {
3610 --todo;
3611 ufunc = HI2UF(hi);
3612 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003613 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3614 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003615 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003616 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003617
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003618 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003619 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003620 // a function has been added or removed, need to start over
3621 todo = (long)func_hashtab.ht_used;
3622 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003623 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003624 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003625 }
3626 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003627 }
3628 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629}
3630
3631/*
3632 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3633 * Return 2 if "p" starts with "s:".
3634 * Return 0 otherwise.
3635 */
3636 int
3637eval_fname_script(char_u *p)
3638{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3640 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3642 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3643 return 5;
3644 if (p[0] == 's' && p[1] == ':')
3645 return 2;
3646 return 0;
3647}
3648
3649 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003650translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651{
3652 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003653 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003654 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003655}
3656
3657/*
3658 * Return TRUE when "ufunc" has old-style "..." varargs
3659 * or named varargs "...name: type".
3660 */
3661 int
3662has_varargs(ufunc_T *ufunc)
3663{
3664 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665}
3666
3667/*
3668 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003669 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 */
3671 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003672function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673{
3674 char_u *nm = name;
3675 char_u *p;
3676 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003677 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003678 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003680 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3681 if (no_deref)
3682 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003683 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 nm = skipwhite(nm);
3685
Bram Moolenaare38eab22019-12-05 21:50:01 +01003686 // Only accept "funcname", "funcname ", "funcname (..." and
3687 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003689 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690 vim_free(p);
3691 return n;
3692}
3693
Bram Moolenaar113e1072019-01-20 15:30:40 +01003694#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 char_u *
3696get_expanded_name(char_u *name, int check)
3697{
3698 char_u *nm = name;
3699 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003700 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 p = trans_function_name(&nm, &is_global, FALSE,
3703 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003705 if (p != NULL && *nm == NUL
3706 && (!check || translated_function_exists(p, is_global)))
3707 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708
3709 vim_free(p);
3710 return NULL;
3711}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003712#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714/*
3715 * Function given to ExpandGeneric() to obtain the list of user defined
3716 * function names.
3717 */
3718 char_u *
3719get_user_func_name(expand_T *xp, int idx)
3720{
3721 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003722 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 static hashitem_T *hi;
3724 ufunc_T *fp;
3725
3726 if (idx == 0)
3727 {
3728 done = 0;
3729 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003730 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003731 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003732 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 {
3734 if (done++ > 0)
3735 ++hi;
3736 while (HASHITEM_EMPTY(hi))
3737 ++hi;
3738 fp = HI2UF(hi);
3739
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003740 // don't show dead, dict and lambda functions
3741 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003742 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003743 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744
3745 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003746 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747
3748 cat_func_name(IObuff, fp);
3749 if (xp->xp_context != EXPAND_USER_FUNC)
3750 {
3751 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003752 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 STRCAT(IObuff, ")");
3754 }
3755 return IObuff;
3756 }
3757 return NULL;
3758}
3759
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760/*
3761 * ":delfunction {name}"
3762 */
3763 void
3764ex_delfunction(exarg_T *eap)
3765{
3766 ufunc_T *fp = NULL;
3767 char_u *p;
3768 char_u *name;
3769 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003770 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771
3772 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003773 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 vim_free(fudi.fd_newkey);
3775 if (name == NULL)
3776 {
3777 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003778 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779 return;
3780 }
3781 if (!ends_excmd(*skipwhite(p)))
3782 {
3783 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003784 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 return;
3786 }
3787 eap->nextcmd = check_nextcmd(p);
3788 if (eap->nextcmd != NULL)
3789 *p = NUL;
3790
3791 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003792 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 vim_free(name);
3794
3795 if (!eap->skip)
3796 {
3797 if (fp == NULL)
3798 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003799 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003800 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 return;
3802 }
3803 if (fp->uf_calls > 0)
3804 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003805 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 return;
3807 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003808 if (fp->uf_flags & FC_VIM9)
3809 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003810 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003811 return;
3812 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813
3814 if (fudi.fd_dict != NULL)
3815 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003816 // Delete the dict item that refers to the function, it will
3817 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3819 }
3820 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003821 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003822 // A normal function (not a numbered function or lambda) has a
3823 // refcount of 1 for the entry in the hashtable. When deleting
3824 // it and the refcount is more than one, it should be kept.
3825 // A numbered function and lambda should be kept if the refcount is
3826 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003827 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003828 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003829 // Function is still referenced somewhere. Don't free it but
3830 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003831 if (func_remove(fp))
3832 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003833 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003834 }
3835 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003836 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003837 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 }
3839}
3840
3841/*
3842 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003843 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 */
3845 void
3846func_unref(char_u *name)
3847{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003848 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003850 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003851 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003852 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003853 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003856 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003858 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003860 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003862 // Only delete it when it's not being used. Otherwise it's done
3863 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003864 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003865 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003866 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003867}
3868
3869/*
3870 * Unreference a Function: decrement the reference count and free it when it
3871 * becomes zero.
3872 */
3873 void
3874func_ptr_unref(ufunc_T *fp)
3875{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003876 if (fp != NULL && --fp->uf_refcount <= 0)
3877 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003878 // Only delete it when it's not being used. Otherwise it's done
3879 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003880 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003881 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882 }
3883}
3884
3885/*
3886 * Count a reference to a Function.
3887 */
3888 void
3889func_ref(char_u *name)
3890{
3891 ufunc_T *fp;
3892
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003893 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003895 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003896 if (fp != NULL)
3897 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003898 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003899 // Only give an error for a numbered function.
3900 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003901 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003902}
3903
3904/*
3905 * Count a reference to a Function.
3906 */
3907 void
3908func_ptr_ref(ufunc_T *fp)
3909{
3910 if (fp != NULL)
3911 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912}
3913
3914/*
3915 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3916 * referenced from anywhere that is in use.
3917 */
3918 static int
3919can_free_funccal(funccall_T *fc, int copyID)
3920{
3921 return (fc->l_varlist.lv_copyID != copyID
3922 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003923 && fc->l_avars.dv_copyID != copyID
3924 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925}
3926
3927/*
3928 * ":return [expr]"
3929 */
3930 void
3931ex_return(exarg_T *eap)
3932{
3933 char_u *arg = eap->arg;
3934 typval_T rettv;
3935 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003936 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937
3938 if (current_funccal == NULL)
3939 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003940 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 return;
3942 }
3943
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003944 CLEAR_FIELD(evalarg);
3945 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3946
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 if (eap->skip)
3948 ++emsg_skip;
3949
3950 eap->nextcmd = NULL;
3951 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003952 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 {
3954 if (!eap->skip)
3955 returning = do_return(eap, FALSE, TRUE, &rettv);
3956 else
3957 clear_tv(&rettv);
3958 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003959 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 else if (!eap->skip)
3961 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003962 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003963 update_force_abort();
3964
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 /*
3966 * Return unless the expression evaluation has been cancelled due to an
3967 * aborting error, an interrupt, or an exception.
3968 */
3969 if (!aborting())
3970 returning = do_return(eap, FALSE, TRUE, NULL);
3971 }
3972
Bram Moolenaare38eab22019-12-05 21:50:01 +01003973 // When skipping or the return gets pending, advance to the next command
3974 // in this line (!returning). Otherwise, ignore the rest of the line.
3975 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976 if (returning)
3977 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003978 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 eap->nextcmd = check_nextcmd(arg);
3980
3981 if (eap->skip)
3982 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003983 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984}
3985
3986/*
3987 * ":1,25call func(arg1, arg2)" function call.
3988 */
3989 void
3990ex_call(exarg_T *eap)
3991{
3992 char_u *arg = eap->arg;
3993 char_u *startarg;
3994 char_u *name;
3995 char_u *tofree;
3996 int len;
3997 typval_T rettv;
3998 linenr_T lnum;
3999 int doesrange;
4000 int failed = FALSE;
4001 funcdict_T fudi;
4002 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004003 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004
Bram Moolenaare6b53242020-07-01 17:28:33 +02004005 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006 if (eap->skip)
4007 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004008 // trans_function_name() doesn't work well when skipping, use eval0()
4009 // instead to skip to any following command, e.g. for:
4010 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004012 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004013 clear_tv(&rettv);
4014 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004015 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004016 return;
4017 }
4018
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004019 tofree = trans_function_name(&arg, NULL, eap->skip,
4020 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 if (fudi.fd_newkey != NULL)
4022 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004023 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004024 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 vim_free(fudi.fd_newkey);
4026 }
4027 if (tofree == NULL)
4028 return;
4029
Bram Moolenaare38eab22019-12-05 21:50:01 +01004030 // Increase refcount on dictionary, it could get deleted when evaluating
4031 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 if (fudi.fd_dict != NULL)
4033 ++fudi.fd_dict->dv_refcount;
4034
Bram Moolenaare38eab22019-12-05 21:50:01 +01004035 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4036 // contents. For VAR_PARTIAL get its partial, unless we already have one
4037 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 len = (int)STRLEN(tofree);
4039 name = deref_func_name(tofree, &len,
4040 partial != NULL ? NULL : &partial, FALSE);
4041
Bram Moolenaare38eab22019-12-05 21:50:01 +01004042 // Skip white space to allow ":call func ()". Not good, but required for
4043 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004045 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046
4047 if (*startarg != '(')
4048 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004049 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050 goto end;
4051 }
4052
4053 /*
4054 * When skipping, evaluate the function once, to find the end of the
4055 * arguments.
4056 * When the function takes a range, this is discovered after the first
4057 * call, and the loop is broken.
4058 */
4059 if (eap->skip)
4060 {
4061 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004062 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 }
4064 else
4065 lnum = eap->line1;
4066 for ( ; lnum <= eap->line2; ++lnum)
4067 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004068 funcexe_T funcexe;
4069
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 if (!eap->skip && eap->addr_count > 0)
4071 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004072 if (lnum > curbuf->b_ml.ml_line_count)
4073 {
4074 // If the function deleted lines or switched to another buffer
4075 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004076 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004077 break;
4078 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 curwin->w_cursor.lnum = lnum;
4080 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 }
4083 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004084
Bram Moolenaara80faa82020-04-12 19:37:17 +02004085 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004086 funcexe.firstline = eap->line1;
4087 funcexe.lastline = eap->line2;
4088 funcexe.doesrange = &doesrange;
4089 funcexe.evaluate = !eap->skip;
4090 funcexe.partial = partial;
4091 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004092 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 {
4094 failed = TRUE;
4095 break;
4096 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004097 if (has_watchexpr())
4098 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004100 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004101 if (handle_subscript(&arg, &rettv,
4102 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 {
4104 failed = TRUE;
4105 break;
4106 }
4107
4108 clear_tv(&rettv);
4109 if (doesrange || eap->skip)
4110 break;
4111
Bram Moolenaare38eab22019-12-05 21:50:01 +01004112 // Stop when immediately aborting on error, or when an interrupt
4113 // occurred or an exception was thrown but not caught.
4114 // get_func_tv() returned OK, so that the check for trailing
4115 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116 if (aborting())
4117 break;
4118 }
4119 if (eap->skip)
4120 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004121 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004122
Bram Moolenaare51bb172020-02-16 19:42:23 +01004123 // When inside :try we need to check for following "| catch".
4124 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004125 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004126 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004127 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004128 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004130 if (!failed)
4131 {
4132 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004133 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004134 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135 }
4136 else
4137 eap->nextcmd = check_nextcmd(arg);
4138 }
4139
4140end:
4141 dict_unref(fudi.fd_dict);
4142 vim_free(tofree);
4143}
4144
4145/*
4146 * Return from a function. Possibly makes the return pending. Also called
4147 * for a pending return at the ":endtry" or after returning from an extra
4148 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4149 * when called due to a ":return" command. "rettv" may point to a typval_T
4150 * with the return rettv. Returns TRUE when the return can be carried out,
4151 * FALSE when the return gets pending.
4152 */
4153 int
4154do_return(
4155 exarg_T *eap,
4156 int reanimate,
4157 int is_cmd,
4158 void *rettv)
4159{
4160 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004161 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162
4163 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004164 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 current_funccal->returned = FALSE;
4166
4167 /*
4168 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4169 * not in its finally clause (which then is to be executed next) is found.
4170 * In this case, make the ":return" pending for execution at the ":endtry".
4171 * Otherwise, return normally.
4172 */
4173 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4174 if (idx >= 0)
4175 {
4176 cstack->cs_pending[idx] = CSTP_RETURN;
4177
4178 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004179 // A pending return again gets pending. "rettv" points to an
4180 // allocated variable with the rettv of the original ":return"'s
4181 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 cstack->cs_rettv[idx] = rettv;
4183 else
4184 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004185 // When undoing a return in order to make it pending, get the stored
4186 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 if (reanimate)
4188 rettv = current_funccal->rettv;
4189
4190 if (rettv != NULL)
4191 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004192 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4194 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4195 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004196 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 }
4198 else
4199 cstack->cs_rettv[idx] = NULL;
4200
4201 if (reanimate)
4202 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004203 // The pending return value could be overwritten by a ":return"
4204 // without argument in a finally clause; reset the default
4205 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 current_funccal->rettv->v_type = VAR_NUMBER;
4207 current_funccal->rettv->vval.v_number = 0;
4208 }
4209 }
4210 report_make_pending(CSTP_RETURN, rettv);
4211 }
4212 else
4213 {
4214 current_funccal->returned = TRUE;
4215
Bram Moolenaare38eab22019-12-05 21:50:01 +01004216 // If the return is carried out now, store the return value. For
4217 // a return immediately after reanimation, the value is already
4218 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219 if (!reanimate && rettv != NULL)
4220 {
4221 clear_tv(current_funccal->rettv);
4222 *current_funccal->rettv = *(typval_T *)rettv;
4223 if (!is_cmd)
4224 vim_free(rettv);
4225 }
4226 }
4227
4228 return idx < 0;
4229}
4230
4231/*
4232 * Free the variable with a pending return value.
4233 */
4234 void
4235discard_pending_return(void *rettv)
4236{
4237 free_tv((typval_T *)rettv);
4238}
4239
4240/*
4241 * Generate a return command for producing the value of "rettv". The result
4242 * is an allocated string. Used by report_pending() for verbose messages.
4243 */
4244 char_u *
4245get_return_cmd(void *rettv)
4246{
4247 char_u *s = NULL;
4248 char_u *tofree = NULL;
4249 char_u numbuf[NUMBUFLEN];
4250
4251 if (rettv != NULL)
4252 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4253 if (s == NULL)
4254 s = (char_u *)"";
4255
4256 STRCPY(IObuff, ":return ");
4257 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4258 if (STRLEN(s) + 8 >= IOSIZE)
4259 STRCPY(IObuff + IOSIZE - 4, "...");
4260 vim_free(tofree);
4261 return vim_strsave(IObuff);
4262}
4263
4264/*
4265 * Get next function line.
4266 * Called by do_cmdline() to get the next line.
4267 * Returns allocated string, or NULL for end of function.
4268 */
4269 char_u *
4270get_func_line(
4271 int c UNUSED,
4272 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004273 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004274 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275{
4276 funccall_T *fcp = (funccall_T *)cookie;
4277 ufunc_T *fp = fcp->func;
4278 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004279 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280
Bram Moolenaare38eab22019-12-05 21:50:01 +01004281 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 if (fcp->dbg_tick != debug_tick)
4283 {
4284 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004285 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 fcp->dbg_tick = debug_tick;
4287 }
4288#ifdef FEAT_PROFILE
4289 if (do_profiling == PROF_YES)
4290 func_line_end(cookie);
4291#endif
4292
4293 gap = &fp->uf_lines;
4294 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4295 || fcp->returned)
4296 retval = NULL;
4297 else
4298 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004299 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 while (fcp->linenr < gap->ga_len
4301 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4302 ++fcp->linenr;
4303 if (fcp->linenr >= gap->ga_len)
4304 retval = NULL;
4305 else
4306 {
4307 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004308 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309#ifdef FEAT_PROFILE
4310 if (do_profiling == PROF_YES)
4311 func_line_start(cookie);
4312#endif
4313 }
4314 }
4315
Bram Moolenaare38eab22019-12-05 21:50:01 +01004316 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004317 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004319 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004320 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004322 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 fcp->dbg_tick = debug_tick;
4324 }
4325
4326 return retval;
4327}
4328
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329/*
4330 * Return TRUE if the currently active function should be ended, because a
4331 * return was encountered or an error occurred. Used inside a ":while".
4332 */
4333 int
4334func_has_ended(void *cookie)
4335{
4336 funccall_T *fcp = (funccall_T *)cookie;
4337
Bram Moolenaare38eab22019-12-05 21:50:01 +01004338 // Ignore the "abort" flag if the abortion behavior has been changed due to
4339 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4341 || fcp->returned);
4342}
4343
4344/*
4345 * return TRUE if cookie indicates a function which "abort"s on errors.
4346 */
4347 int
4348func_has_abort(
4349 void *cookie)
4350{
4351 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4352}
4353
4354
4355/*
4356 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4357 * Don't do this when "Func" is already a partial that was bound
4358 * explicitly (pt_auto is FALSE).
4359 * Changes "rettv" in-place.
4360 * Returns the updated "selfdict_in".
4361 */
4362 dict_T *
4363make_partial(dict_T *selfdict_in, typval_T *rettv)
4364{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004365 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366 char_u *tofree = NULL;
4367 ufunc_T *fp;
4368 char_u fname_buf[FLEN_FIXED + 1];
4369 int error;
4370 dict_T *selfdict = selfdict_in;
4371
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004372 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4373 fp = rettv->vval.v_partial->pt_func;
4374 else
4375 {
4376 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4377 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004378 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004379 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004380 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004381 vim_free(tofree);
4382 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383
4384 if (fp != NULL && (fp->uf_flags & FC_DICT))
4385 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004386 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387
4388 if (pt != NULL)
4389 {
4390 pt->pt_refcount = 1;
4391 pt->pt_dict = selfdict;
4392 pt->pt_auto = TRUE;
4393 selfdict = NULL;
4394 if (rettv->v_type == VAR_FUNC)
4395 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004396 // Just a function: Take over the function name and use
4397 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 pt->pt_name = rettv->vval.v_string;
4399 }
4400 else
4401 {
4402 partial_T *ret_pt = rettv->vval.v_partial;
4403 int i;
4404
Bram Moolenaare38eab22019-12-05 21:50:01 +01004405 // Partial: copy the function name, use selfdict and copy
4406 // args. Can't take over name or args, the partial might
4407 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004408 if (ret_pt->pt_name != NULL)
4409 {
4410 pt->pt_name = vim_strsave(ret_pt->pt_name);
4411 func_ref(pt->pt_name);
4412 }
4413 else
4414 {
4415 pt->pt_func = ret_pt->pt_func;
4416 func_ptr_ref(pt->pt_func);
4417 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 if (ret_pt->pt_argc > 0)
4419 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004420 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004422 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 pt->pt_argc = 0;
4424 else
4425 {
4426 pt->pt_argc = ret_pt->pt_argc;
4427 for (i = 0; i < pt->pt_argc; i++)
4428 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4429 }
4430 }
4431 partial_unref(ret_pt);
4432 }
4433 rettv->v_type = VAR_PARTIAL;
4434 rettv->vval.v_partial = pt;
4435 }
4436 }
4437 return selfdict;
4438}
4439
4440/*
4441 * Return the name of the executed function.
4442 */
4443 char_u *
4444func_name(void *cookie)
4445{
4446 return ((funccall_T *)cookie)->func->uf_name;
4447}
4448
4449/*
4450 * Return the address holding the next breakpoint line for a funccall cookie.
4451 */
4452 linenr_T *
4453func_breakpoint(void *cookie)
4454{
4455 return &((funccall_T *)cookie)->breakpoint;
4456}
4457
4458/*
4459 * Return the address holding the debug tick for a funccall cookie.
4460 */
4461 int *
4462func_dbg_tick(void *cookie)
4463{
4464 return &((funccall_T *)cookie)->dbg_tick;
4465}
4466
4467/*
4468 * Return the nesting level for a funccall cookie.
4469 */
4470 int
4471func_level(void *cookie)
4472{
4473 return ((funccall_T *)cookie)->level;
4474}
4475
4476/*
4477 * Return TRUE when a function was ended by a ":return" command.
4478 */
4479 int
4480current_func_returned(void)
4481{
4482 return current_funccal->returned;
4483}
4484
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 int
4486free_unref_funccal(int copyID, int testing)
4487{
4488 int did_free = FALSE;
4489 int did_free_funccal = FALSE;
4490 funccall_T *fc, **pfc;
4491
4492 for (pfc = &previous_funccal; *pfc != NULL; )
4493 {
4494 if (can_free_funccal(*pfc, copyID))
4495 {
4496 fc = *pfc;
4497 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004498 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 did_free = TRUE;
4500 did_free_funccal = TRUE;
4501 }
4502 else
4503 pfc = &(*pfc)->caller;
4504 }
4505 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004506 // When a funccal was freed some more items might be garbage
4507 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508 (void)garbage_collect(testing);
4509
4510 return did_free;
4511}
4512
4513/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004514 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 */
4516 static funccall_T *
4517get_funccal(void)
4518{
4519 int i;
4520 funccall_T *funccal;
4521 funccall_T *temp_funccal;
4522
4523 funccal = current_funccal;
4524 if (debug_backtrace_level > 0)
4525 {
4526 for (i = 0; i < debug_backtrace_level; i++)
4527 {
4528 temp_funccal = funccal->caller;
4529 if (temp_funccal)
4530 funccal = temp_funccal;
4531 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004532 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533 debug_backtrace_level = i;
4534 }
4535 }
4536 return funccal;
4537}
4538
4539/*
4540 * Return the hashtable used for local variables in the current funccal.
4541 * Return NULL if there is no current funccal.
4542 */
4543 hashtab_T *
4544get_funccal_local_ht()
4545{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004546 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547 return NULL;
4548 return &get_funccal()->l_vars.dv_hashtab;
4549}
4550
4551/*
4552 * Return the l: scope variable.
4553 * Return NULL if there is no current funccal.
4554 */
4555 dictitem_T *
4556get_funccal_local_var()
4557{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004558 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 return NULL;
4560 return &get_funccal()->l_vars_var;
4561}
4562
4563/*
4564 * Return the hashtable used for argument in the current funccal.
4565 * Return NULL if there is no current funccal.
4566 */
4567 hashtab_T *
4568get_funccal_args_ht()
4569{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004570 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 return NULL;
4572 return &get_funccal()->l_avars.dv_hashtab;
4573}
4574
4575/*
4576 * Return the a: scope variable.
4577 * Return NULL if there is no current funccal.
4578 */
4579 dictitem_T *
4580get_funccal_args_var()
4581{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004582 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004584 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585}
4586
4587/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588 * List function variables, if there is a function.
4589 */
4590 void
4591list_func_vars(int *first)
4592{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004593 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004595 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596}
4597
4598/*
4599 * If "ht" is the hashtable for local variables in the current funccal, return
4600 * the dict that contains it.
4601 * Otherwise return NULL.
4602 */
4603 dict_T *
4604get_current_funccal_dict(hashtab_T *ht)
4605{
4606 if (current_funccal != NULL
4607 && ht == &current_funccal->l_vars.dv_hashtab)
4608 return &current_funccal->l_vars;
4609 return NULL;
4610}
4611
4612/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004613 * Search hashitem in parent scope.
4614 */
4615 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004616find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004617{
4618 funccall_T *old_current_funccal = current_funccal;
4619 hashtab_T *ht;
4620 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004621 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004622
4623 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4624 return NULL;
4625
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004626 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004627 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004628 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004629 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004630 ht = find_var_ht(name, &varname);
4631 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004632 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004633 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004634 if (!HASHITEM_EMPTY(hi))
4635 {
4636 *pht = ht;
4637 break;
4638 }
4639 }
4640 if (current_funccal == current_funccal->func->uf_scoped)
4641 break;
4642 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004643 }
4644 current_funccal = old_current_funccal;
4645
4646 return hi;
4647}
4648
4649/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004650 * Search variable in parent scope.
4651 */
4652 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004653find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004654{
4655 dictitem_T *v = NULL;
4656 funccall_T *old_current_funccal = current_funccal;
4657 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004658 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004659
4660 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4661 return NULL;
4662
Bram Moolenaare38eab22019-12-05 21:50:01 +01004663 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004664 current_funccal = current_funccal->func->uf_scoped;
4665 while (current_funccal)
4666 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004667 ht = find_var_ht(name, &varname);
4668 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004669 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004670 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004671 if (v != NULL)
4672 break;
4673 }
4674 if (current_funccal == current_funccal->func->uf_scoped)
4675 break;
4676 current_funccal = current_funccal->func->uf_scoped;
4677 }
4678 current_funccal = old_current_funccal;
4679
4680 return v;
4681}
4682
4683/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 * Set "copyID + 1" in previous_funccal and callers.
4685 */
4686 int
4687set_ref_in_previous_funccal(int copyID)
4688{
4689 int abort = FALSE;
4690 funccall_T *fc;
4691
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004692 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004694 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004695 abort = abort
4696 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4697 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004698 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 }
4700 return abort;
4701}
4702
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004703 static int
4704set_ref_in_funccal(funccall_T *fc, int copyID)
4705{
4706 int abort = FALSE;
4707
4708 if (fc->fc_copyID != copyID)
4709 {
4710 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004711 abort = abort
4712 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4713 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004714 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004715 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004716 }
4717 return abort;
4718}
4719
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004720/*
4721 * Set "copyID" in all local vars and arguments in the call stack.
4722 */
4723 int
4724set_ref_in_call_stack(int copyID)
4725{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004726 int abort = FALSE;
4727 funccall_T *fc;
4728 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004730 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004731 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004732
4733 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004734 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4735 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004736 abort = abort || set_ref_in_funccal(fc, copyID);
4737
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004738 return abort;
4739}
4740
4741/*
4742 * Set "copyID" in all functions available by name.
4743 */
4744 int
4745set_ref_in_functions(int copyID)
4746{
4747 int todo;
4748 hashitem_T *hi = NULL;
4749 int abort = FALSE;
4750 ufunc_T *fp;
4751
4752 todo = (int)func_hashtab.ht_used;
4753 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004755 if (!HASHITEM_EMPTY(hi))
4756 {
4757 --todo;
4758 fp = HI2UF(hi);
4759 if (!func_name_refcount(fp->uf_name))
4760 abort = abort || set_ref_in_func(NULL, fp, copyID);
4761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 }
4763 return abort;
4764}
4765
4766/*
4767 * Set "copyID" in all function arguments.
4768 */
4769 int
4770set_ref_in_func_args(int copyID)
4771{
4772 int i;
4773 int abort = FALSE;
4774
4775 for (i = 0; i < funcargs.ga_len; ++i)
4776 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4777 copyID, NULL, NULL);
4778 return abort;
4779}
4780
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004781/*
4782 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004783 * Returns TRUE if setting references failed somehow.
4784 */
4785 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004786set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004787{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004788 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004789 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004790 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004791 char_u fname_buf[FLEN_FIXED + 1];
4792 char_u *tofree = NULL;
4793 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004794 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004795
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004796 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004797 return FALSE;
4798
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004799 if (fp_in == NULL)
4800 {
4801 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004802 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004803 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004804 if (fp != NULL)
4805 {
4806 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004807 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004808 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004809
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004810 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004811 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004812}
4813
Bram Moolenaare38eab22019-12-05 21:50:01 +01004814#endif // FEAT_EVAL