blob: 0f6388d722fb740cf131f921a3a5a36c8e89ff60 [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 Moolenaarbc4c5052020-08-13 22:47:35 +0200122 semsg(_(e_white_space_required_after), ":");
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 Moolenaarbc4c5052020-08-13 22:47:35 +0200279 semsg(_(e_white_space_required_after), ",");
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 Moolenaara9b579f2016-07-17 18:29:19 +0200626
627 /*
628 * Get the arguments.
629 */
630 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200631 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
632 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200633 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200634 // skip the '(' or ',' and possibly line breaks
635 argp = skipwhite_and_linebreak(argp + 1, evalarg);
636
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200637 if (*argp == ')' || *argp == ',' || *argp == NUL)
638 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200639 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200640 {
641 ret = FAIL;
642 break;
643 }
644 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200645 // The comma should come right after the argument, but this wasn't
646 // checked previously, thus only enforce it in Vim9 script.
647 if (!in_vim9script())
648 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200649 if (*argp != ',')
650 break;
651 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200652 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653 if (*argp == ')')
654 ++argp;
655 else
656 ret = FAIL;
657
658 if (ret == OK)
659 {
660 int i = 0;
661
662 if (get_vim_var_nr(VV_TESTING))
663 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100664 // Prepare for calling test_garbagecollect_now(), need to know
665 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200666 if (funcargs.ga_itemsize == 0)
667 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
668 for (i = 0; i < argcount; ++i)
669 if (ga_grow(&funcargs, 1) == OK)
670 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
671 &argvars[i];
672 }
673
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200674 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200675
676 funcargs.ga_len -= i;
677 }
678 else if (!aborting())
679 {
680 if (argcount == MAX_FUNC_ARGS)
681 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
682 else
683 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
684 }
685
686 while (--argcount >= 0)
687 clear_tv(&argvars[argcount]);
688
Bram Moolenaar8294d492020-08-10 22:40:56 +0200689 if (in_vim9script())
690 *arg = argp;
691 else
692 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200693 return ret;
694}
695
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200696/*
697 * Return TRUE if "p" starts with "<SID>" or "s:".
698 * Only works if eval_fname_script() returned non-zero for "p"!
699 */
700 static int
701eval_fname_sid(char_u *p)
702{
703 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
704}
705
706/*
707 * In a script change <SID>name() and s:name() to K_SNR 123_name().
708 * Change <SNR>123_name() to K_SNR 123_name().
709 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
710 * (slow).
711 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100712 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200713fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
714{
715 int llen;
716 char_u *fname;
717 int i;
718
719 llen = eval_fname_script(name);
720 if (llen > 0)
721 {
722 fname_buf[0] = K_SPECIAL;
723 fname_buf[1] = KS_EXTRA;
724 fname_buf[2] = (int)KE_SNR;
725 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100726 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200727 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200728 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100729 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730 else
731 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200732 sprintf((char *)fname_buf + 3, "%ld_",
733 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200734 i = (int)STRLEN(fname_buf);
735 }
736 }
737 if (i + STRLEN(name + llen) < FLEN_FIXED)
738 {
739 STRCPY(fname_buf + i, name + llen);
740 fname = fname_buf;
741 }
742 else
743 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200744 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200745 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100746 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200747 else
748 {
749 *tofree = fname;
750 mch_memmove(fname, fname_buf, (size_t)i);
751 STRCPY(fname + i, name + llen);
752 }
753 }
754 }
755 else
756 fname = name;
757 return fname;
758}
759
760/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100761 * Find a function "name" in script "sid".
762 */
763 static ufunc_T *
764find_func_with_sid(char_u *name, int sid)
765{
766 hashitem_T *hi;
767 char_u buffer[200];
768
769 buffer[0] = K_SPECIAL;
770 buffer[1] = KS_EXTRA;
771 buffer[2] = (int)KE_SNR;
772 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
773 (long)sid, name);
774 hi = hash_find(&func_hashtab, buffer);
775 if (!HASHITEM_EMPTY(hi))
776 return HI2UF(hi);
777
778 return NULL;
779}
780
781/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200782 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200783 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200784 * Return NULL for unknown function.
785 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200786 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200787find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200788{
789 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100790 ufunc_T *func;
791 imported_T *imported;
792
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200793 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100794 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200795 int vim9script = in_vim9script();
796 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200797 long sid = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100798
Bram Moolenaar333894b2020-08-01 18:53:07 +0200799 if (vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100800 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200801 // Find script-local function before global one.
802 func = find_func_with_sid(name, current_sctx.sc_sid);
803 if (func != NULL)
804 return func;
805 }
806
Bram Moolenaarefa94442020-08-08 22:16:00 +0200807 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200808 && name[1] == KS_EXTRA
809 && name[2] == KE_SNR)
810 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200811 // Caller changes s: to <SNR>99_name.
812
813 after_script = name + 3;
814 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200815 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200816 ++after_script;
817 else
818 after_script = NULL;
819 }
Bram Moolenaar333894b2020-08-01 18:53:07 +0200820 if (vim9script || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200821 {
822 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200823 if (after_script != NULL && sid != current_sctx.sc_sid)
824 imported = find_imported_in_script(after_script, 0, sid);
825 else
826 imported = find_imported(after_script == NULL
827 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200828 if (imported != NULL && imported->imp_funcname != NULL)
829 {
830 hi = hash_find(&func_hashtab, imported->imp_funcname);
831 if (!HASHITEM_EMPTY(hi))
832 return HI2UF(hi);
833 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100834 }
835 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200836
Bram Moolenaara26b9702020-04-18 19:53:28 +0200837 hi = hash_find(&func_hashtab,
838 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200839 if (!HASHITEM_EMPTY(hi))
840 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100841
842 return NULL;
843}
844
845/*
846 * Find a function by name, return pointer to it in ufuncs.
847 * "cctx" is passed in a :def function to find imported functions.
848 * Return NULL for unknown or dead function.
849 */
850 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200851find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100852{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200853 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100854
855 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
856 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200857 return NULL;
858}
859
860/*
861 * Copy the function name of "fp" to buffer "buf".
862 * "buf" must be able to hold the function name plus three bytes.
863 * Takes care of script-local function names.
864 */
865 static void
866cat_func_name(char_u *buf, ufunc_T *fp)
867{
868 if (fp->uf_name[0] == K_SPECIAL)
869 {
870 STRCPY(buf, "<SNR>");
871 STRCAT(buf, fp->uf_name + 3);
872 }
873 else
874 STRCPY(buf, fp->uf_name);
875}
876
877/*
878 * Add a number variable "name" to dict "dp" with value "nr".
879 */
880 static void
881add_nr_var(
882 dict_T *dp,
883 dictitem_T *v,
884 char *name,
885 varnumber_T nr)
886{
887 STRCPY(v->di_key, name);
888 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
889 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
890 v->di_tv.v_type = VAR_NUMBER;
891 v->di_tv.v_lock = VAR_FIXED;
892 v->di_tv.vval.v_number = nr;
893}
894
895/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100896 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200897 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100898 static void
899free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200900{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100901 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200902
903 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
904 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100905 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200906
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100907 // When garbage collecting a funccall_T may be freed before the
908 // function that references it, clear its uf_scoped field.
909 // The function may have been redefined and point to another
910 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200911 if (fp != NULL && fp->uf_scoped == fc)
912 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200913 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200914 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200915
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200916 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200917 vim_free(fc);
918}
919
920/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100921 * Free "fc" and what it contains.
922 * Can be called only when "fc" is kept beyond the period of it called,
923 * i.e. after cleanup_function_call(fc).
924 */
925 static void
926free_funccal_contents(funccall_T *fc)
927{
928 listitem_T *li;
929
930 // Free all l: variables.
931 vars_clear(&fc->l_vars.dv_hashtab);
932
933 // Free all a: variables.
934 vars_clear(&fc->l_avars.dv_hashtab);
935
936 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200937 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100938 clear_tv(&li->li_tv);
939
940 free_funccal(fc);
941}
942
943/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200944 * Handle the last part of returning from a function: free the local hashtable.
945 * Unless it is still in use by a closure.
946 */
947 static void
948cleanup_function_call(funccall_T *fc)
949{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100950 int may_free_fc = fc->fc_refcount <= 0;
951 int free_fc = TRUE;
952
Bram Moolenaar6914c642017-04-01 21:21:30 +0200953 current_funccal = fc->caller;
954
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100955 // Free all l: variables if not referred.
956 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
957 vars_clear(&fc->l_vars.dv_hashtab);
958 else
959 free_fc = FALSE;
960
961 // If the a:000 list and the l: and a: dicts are not referenced and
962 // there is no closure using it, we can free the funccall_T and what's
963 // in it.
964 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
965 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200966 else
967 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100968 int todo;
969 hashitem_T *hi;
970 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200971
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100972 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200973
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100974 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200975 todo = (int)fc->l_avars.dv_hashtab.ht_used;
976 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
977 {
978 if (!HASHITEM_EMPTY(hi))
979 {
980 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100981 di = HI2DI(hi);
982 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200983 }
984 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100985 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200986
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100987 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
988 fc->l_varlist.lv_first = NULL;
989 else
990 {
991 listitem_T *li;
992
993 free_fc = FALSE;
994
995 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200996 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200997 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100998 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100999
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001000 if (free_fc)
1001 free_funccal(fc);
1002 else
1003 {
1004 static int made_copy = 0;
1005
1006 // "fc" is still in use. This can happen when returning "a:000",
1007 // assigning "l:" to a global variable or defining a closure.
1008 // Link "fc" in the list for garbage collection later.
1009 fc->caller = previous_funccal;
1010 previous_funccal = fc;
1011
1012 if (want_garbage_collect)
1013 // If garbage collector is ready, clear count.
1014 made_copy = 0;
1015 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001016 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001017 // We have made a lot of copies, worth 4 Mbyte. This can happen
1018 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001019 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001020 // too much memory.
1021 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001022 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001023 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001024 }
1025}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001026/*
1027 * Unreference "fc": decrement the reference count and free it when it
1028 * becomes zero. "fp" is detached from "fc".
1029 * When "force" is TRUE we are exiting.
1030 */
1031 static void
1032funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1033{
1034 funccall_T **pfc;
1035 int i;
1036
1037 if (fc == NULL)
1038 return;
1039
1040 if (--fc->fc_refcount <= 0 && (force || (
1041 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1042 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1043 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1044 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1045 {
1046 if (fc == *pfc)
1047 {
1048 *pfc = fc->caller;
1049 free_funccal_contents(fc);
1050 return;
1051 }
1052 }
1053 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1054 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1055 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1056}
1057
1058/*
1059 * Remove the function from the function hashtable. If the function was
1060 * deleted while it still has references this was already done.
1061 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1062 */
1063 static int
1064func_remove(ufunc_T *fp)
1065{
1066 hashitem_T *hi;
1067
1068 // Return if it was already virtually deleted.
1069 if (fp->uf_flags & FC_DEAD)
1070 return FALSE;
1071
1072 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1073 if (!HASHITEM_EMPTY(hi))
1074 {
1075 // When there is a def-function index do not actually remove the
1076 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001077 // Do remove it when it's a copy.
1078 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001079 fp->uf_flags |= FC_DEAD;
1080 else
1081 hash_remove(&func_hashtab, hi);
1082 return TRUE;
1083 }
1084 return FALSE;
1085}
1086
1087 static void
1088func_clear_items(ufunc_T *fp)
1089{
1090 ga_clear_strings(&(fp->uf_args));
1091 ga_clear_strings(&(fp->uf_def_args));
1092 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001093 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001094 VIM_CLEAR(fp->uf_def_arg_idx);
1095 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001096 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001097
1098#ifdef FEAT_LUA
1099 if (fp->uf_cb_free != NULL)
1100 {
1101 fp->uf_cb_free(fp->uf_cb_state);
1102 fp->uf_cb_free = NULL;
1103 }
1104
1105 fp->uf_cb_state = NULL;
1106 fp->uf_cb = NULL;
1107#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001108#ifdef FEAT_PROFILE
1109 VIM_CLEAR(fp->uf_tml_count);
1110 VIM_CLEAR(fp->uf_tml_total);
1111 VIM_CLEAR(fp->uf_tml_self);
1112#endif
1113}
1114
1115/*
1116 * Free all things that a function contains. Does not free the function
1117 * itself, use func_free() for that.
1118 * When "force" is TRUE we are exiting.
1119 */
1120 static void
1121func_clear(ufunc_T *fp, int force)
1122{
1123 if (fp->uf_cleared)
1124 return;
1125 fp->uf_cleared = TRUE;
1126
1127 // clear this function
1128 func_clear_items(fp);
1129 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001130 if ((fp->uf_flags & FC_COPY) == 0)
1131 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001132}
1133
1134/*
1135 * Free a function and remove it from the list of functions. Does not free
1136 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001137 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001138 */
1139 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001140func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001141{
1142 // Only remove it when not done already, otherwise we would remove a newer
1143 // version of the function with the same name.
1144 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1145 func_remove(fp);
1146
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001147 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001148 {
1149 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001150 vim_free(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001151 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001152}
1153
1154/*
1155 * Free all things that a function contains and free the function itself.
1156 * When "force" is TRUE we are exiting.
1157 */
1158 static void
1159func_clear_free(ufunc_T *fp, int force)
1160{
1161 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001162 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001163 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001164 else
1165 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001166}
1167
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001168/*
1169 * Copy already defined function "lambda" to a new function with name "global".
1170 * This is for when a compiled function defines a global function.
1171 */
1172 void
1173copy_func(char_u *lambda, char_u *global)
1174{
1175 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1176 ufunc_T *fp;
1177
1178 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001179 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001180 else
1181 {
1182 // TODO: handle ! to overwrite
1183 fp = find_func(global, TRUE, NULL);
1184 if (fp != NULL)
1185 {
1186 semsg(_(e_funcexts), global);
1187 return;
1188 }
1189
1190 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1191 if (fp == NULL)
1192 return;
1193
1194 fp->uf_varargs = ufunc->uf_varargs;
1195 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1196 fp->uf_def_status = ufunc->uf_def_status;
1197 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001198 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1199 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001200 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001201 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001202 goto failed;
1203
1204 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1205 : vim_strsave(ufunc->uf_name_exp);
1206 if (ufunc->uf_arg_types != NULL)
1207 {
1208 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1209 if (fp->uf_arg_types == NULL)
1210 goto failed;
1211 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1212 sizeof(type_T *) * fp->uf_args.ga_len);
1213 }
1214 if (ufunc->uf_def_arg_idx != NULL)
1215 {
1216 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1217 if (fp->uf_def_arg_idx == NULL)
1218 goto failed;
1219 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1220 sizeof(int) * fp->uf_def_args.ga_len + 1);
1221 }
1222 if (ufunc->uf_va_name != NULL)
1223 {
1224 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1225 if (fp->uf_va_name == NULL)
1226 goto failed;
1227 }
1228
1229 fp->uf_refcount = 1;
1230 STRCPY(fp->uf_name, global);
1231 hash_add(&func_hashtab, UF2HIKEY(fp));
1232 }
1233 return;
1234
1235failed:
1236 func_clear_free(fp, TRUE);
1237}
1238
Bram Moolenaar6914c642017-04-01 21:21:30 +02001239
1240/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001241 * Call a user function.
1242 */
1243 static void
1244call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001245 ufunc_T *fp, // pointer to function
1246 int argcount, // nr of args
1247 typval_T *argvars, // arguments
1248 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001249 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001250 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001251{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001252 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001253 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001254 funccall_T *fc;
1255 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001256 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001257 static int depth = 0;
1258 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001259 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001260 int i;
1261 int ai;
1262 int islambda = FALSE;
1263 char_u numbuf[NUMBUFLEN];
1264 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001265#ifdef FEAT_PROFILE
1266 proftime_T wait_start;
1267 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001268 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001269#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001270 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001271
Bram Moolenaare38eab22019-12-05 21:50:01 +01001272 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001273 if (depth >= p_mfd)
1274 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001275 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001276 rettv->v_type = VAR_NUMBER;
1277 rettv->vval.v_number = -1;
1278 return;
1279 }
1280 ++depth;
1281
Bram Moolenaare38eab22019-12-05 21:50:01 +01001282 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001284 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001285 if (fc == NULL)
1286 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287 fc->caller = current_funccal;
1288 current_funccal = fc;
1289 fc->func = fp;
1290 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001292 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1294 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001295 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001296 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001297 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001298
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001299 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001300 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001301 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001302 save_current_sctx = current_sctx;
1303 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001304
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001305 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001306 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001307 --depth;
1308 current_funccal = fc->caller;
1309
1310 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001311 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001312 free_funccal(fc);
1313 return;
1314 }
1315
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001316 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1317 islambda = TRUE;
1318
1319 /*
1320 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1321 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1322 * each argument variable and saves a lot of time.
1323 */
1324 /*
1325 * Init l: variables.
1326 */
1327 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1328 if (selfdict != NULL)
1329 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001330 // Set l:self to "selfdict". Use "name" to avoid a warning from
1331 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 v = &fc->fixvar[fixvar_idx++].var;
1333 name = v->di_key;
1334 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001335 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001336 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1337 v->di_tv.v_type = VAR_DICT;
1338 v->di_tv.v_lock = 0;
1339 v->di_tv.vval.v_dict = selfdict;
1340 ++selfdict->dv_refcount;
1341 }
1342
1343 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001344 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001345 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001346 * Set a:000 to a list with room for the "..." arguments.
1347 */
1348 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001349 if ((fp->uf_flags & FC_NOARGS) == 0)
1350 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001351 (varnumber_T)(argcount >= fp->uf_args.ga_len
1352 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001353 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001354 if ((fp->uf_flags & FC_NOARGS) == 0)
1355 {
1356 // Use "name" to avoid a warning from some compiler that checks the
1357 // destination size.
1358 v = &fc->fixvar[fixvar_idx++].var;
1359 name = v->di_key;
1360 STRCPY(name, "000");
1361 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1362 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1363 v->di_tv.v_type = VAR_LIST;
1364 v->di_tv.v_lock = VAR_FIXED;
1365 v->di_tv.vval.v_list = &fc->l_varlist;
1366 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001367 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1369 fc->l_varlist.lv_lock = VAR_FIXED;
1370
1371 /*
1372 * Set a:firstline to "firstline" and a:lastline to "lastline".
1373 * Set a:name to named arguments.
1374 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001375 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001376 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001377 if ((fp->uf_flags & FC_NOARGS) == 0)
1378 {
1379 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001380 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001381 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001382 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001383 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001384 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001385 {
1386 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001387 typval_T def_rettv;
1388 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001389
1390 ai = i - fp->uf_args.ga_len;
1391 if (ai < 0)
1392 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001393 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001394 name = FUNCARG(fp, i);
1395 if (islambda)
1396 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001397
1398 // evaluate named argument default expression
1399 isdefault = ai + fp->uf_def_args.ga_len >= 0
1400 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1401 && argvars[i].vval.v_number == VVAL_NONE));
1402 if (isdefault)
1403 {
1404 char_u *default_expr = NULL;
1405 def_rettv.v_type = VAR_NUMBER;
1406 def_rettv.vval.v_number = -1;
1407
1408 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1409 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001410 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001411 {
1412 default_arg_err = 1;
1413 break;
1414 }
1415 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416 }
1417 else
1418 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001419 if ((fp->uf_flags & FC_NOARGS) != 0)
1420 // Bail out if no a: arguments used (in lambda).
1421 break;
1422
Bram Moolenaare38eab22019-12-05 21:50:01 +01001423 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001424 sprintf((char *)numbuf, "%d", ai + 1);
1425 name = numbuf;
1426 }
1427 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1428 {
1429 v = &fc->fixvar[fixvar_idx++].var;
1430 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001431 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 }
1433 else
1434 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001435 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001436 if (v == NULL)
1437 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001438 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001439 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001441 // Note: the values are copied directly to avoid alloc/free.
1442 // "argvars" must have VAR_FIXED for v_lock.
1443 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 v->di_tv.v_lock = VAR_FIXED;
1445
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001446 if (addlocal)
1447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001448 // Named arguments should be accessed without the "a:" prefix in
1449 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001450 copy_tv(&v->di_tv, &v->di_tv);
1451 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001453 else
1454 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455
1456 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1457 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001458 listitem_T *li = &fc->l_listitems[ai];
1459
1460 li->li_tv = argvars[i];
1461 li->li_tv.v_lock = VAR_FIXED;
1462 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001463 }
1464 }
1465
Bram Moolenaare38eab22019-12-05 21:50:01 +01001466 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001468
1469 if (fp->uf_flags & FC_SANDBOX)
1470 {
1471 using_sandbox = TRUE;
1472 ++sandbox;
1473 }
1474
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001475 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001476 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001477 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001479 ++no_wait_return;
1480 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001482 smsg(_("calling %s"), SOURCING_NAME);
1483 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001485 char_u buf[MSG_BUF_LEN];
1486 char_u numbuf2[NUMBUFLEN];
1487 char_u *tofree;
1488 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001489
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001490 msg_puts("(");
1491 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001493 if (i > 0)
1494 msg_puts(", ");
1495 if (argvars[i].v_type == VAR_NUMBER)
1496 msg_outnum((long)argvars[i].vval.v_number);
1497 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001499 // Do not want errors such as E724 here.
1500 ++emsg_off;
1501 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1502 --emsg_off;
1503 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001504 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001505 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001507 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1508 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001510 msg_puts((char *)s);
1511 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001512 }
1513 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001515 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001517 msg_puts("\n"); // don't overwrite this either
1518
1519 verbose_leave_scroll();
1520 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001521 }
1522#ifdef FEAT_PROFILE
1523 if (do_profiling == PROF_YES)
1524 {
1525 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001526 {
1527 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001530 if (fp->uf_profiling
1531 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1532 {
1533 ++fp->uf_tm_count;
1534 profile_start(&call_start);
1535 profile_zero(&fp->uf_tm_children);
1536 }
1537 script_prof_save(&wait_start);
1538 }
1539#endif
1540
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001541 save_current_sctx = current_sctx;
1542 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 save_did_emsg = did_emsg;
1544 did_emsg = FALSE;
1545
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001546 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1547 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001548 else if (islambda)
1549 {
1550 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1551
1552 // A Lambda always has the command "return {expr}". It is much faster
1553 // to evaluate {expr} directly.
1554 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001555 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001556 --ex_nesting_level;
1557 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001558 else
1559 // call do_cmdline() to execute the lines
1560 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1562
1563 --RedrawingDisabled;
1564
Bram Moolenaare38eab22019-12-05 21:50:01 +01001565 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1567 {
1568 clear_tv(rettv);
1569 rettv->v_type = VAR_NUMBER;
1570 rettv->vval.v_number = -1;
1571 }
1572
1573#ifdef FEAT_PROFILE
1574 if (do_profiling == PROF_YES && (fp->uf_profiling
1575 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1576 {
1577 profile_end(&call_start);
1578 profile_sub_wait(&wait_start, &call_start);
1579 profile_add(&fp->uf_tm_total, &call_start);
1580 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1581 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1582 {
1583 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1584 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1585 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001586 if (started_profiling)
1587 // make a ":profdel func" stop profiling the function
1588 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 }
1590#endif
1591
Bram Moolenaare38eab22019-12-05 21:50:01 +01001592 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593 if (p_verbose >= 12)
1594 {
1595 ++no_wait_return;
1596 verbose_enter_scroll();
1597
1598 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001599 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001601 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001602 (long)fc->rettv->vval.v_number);
1603 else
1604 {
1605 char_u buf[MSG_BUF_LEN];
1606 char_u numbuf2[NUMBUFLEN];
1607 char_u *tofree;
1608 char_u *s;
1609
Bram Moolenaare38eab22019-12-05 21:50:01 +01001610 // The value may be very long. Skip the middle part, so that we
1611 // have some idea how it starts and ends. smsg() would always
1612 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613 ++emsg_off;
1614 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1615 --emsg_off;
1616 if (s != NULL)
1617 {
1618 if (vim_strsize(s) > MSG_BUF_CLEN)
1619 {
1620 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1621 s = buf;
1622 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001623 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624 vim_free(tofree);
1625 }
1626 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001627 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628
1629 verbose_leave_scroll();
1630 --no_wait_return;
1631 }
1632
Bram Moolenaare31ee862020-01-07 20:59:34 +01001633 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001634 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001635 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636#ifdef FEAT_PROFILE
1637 if (do_profiling == PROF_YES)
1638 script_prof_restore(&wait_start);
1639#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001640 if (using_sandbox)
1641 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001643 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644 {
1645 ++no_wait_return;
1646 verbose_enter_scroll();
1647
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001648 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001649 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650
1651 verbose_leave_scroll();
1652 --no_wait_return;
1653 }
1654
1655 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001656 --depth;
1657
Bram Moolenaar6914c642017-04-01 21:21:30 +02001658 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001659}
1660
1661/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001662 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001663 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001664 int
1665call_user_func_check(
1666 ufunc_T *fp,
1667 int argcount,
1668 typval_T *argvars,
1669 typval_T *rettv,
1670 funcexe_T *funcexe,
1671 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001672{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001673 int error;
1674 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001675
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001676 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1677 *funcexe->doesrange = TRUE;
1678 if (argcount < regular_args - fp->uf_def_args.ga_len)
1679 error = FCERR_TOOFEW;
1680 else if (!has_varargs(fp) && argcount > regular_args)
1681 error = FCERR_TOOMANY;
1682 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1683 error = FCERR_DICT;
1684 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001685 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001686 int did_save_redo = FALSE;
1687 save_redo_T save_redo;
1688
1689 /*
1690 * Call the user function.
1691 * Save and restore search patterns, script variables and
1692 * redo buffer.
1693 */
1694 save_search_patterns();
1695 if (!ins_compl_active())
1696 {
1697 saveRedobuff(&save_redo);
1698 did_save_redo = TRUE;
1699 }
1700 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001701 call_user_func(fp, argcount, argvars, rettv, funcexe,
1702 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001703 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1704 // Function was unreferenced while being used, free it now.
1705 func_clear_free(fp, FALSE);
1706 if (did_save_redo)
1707 restoreRedobuff(&save_redo);
1708 restore_search_patterns();
1709 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001710 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001711 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001712}
1713
1714/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001715 * There are two kinds of function names:
1716 * 1. ordinary names, function defined with :function
1717 * 2. numbered functions and lambdas
1718 * For the first we only count the name stored in func_hashtab as a reference,
1719 * using function() does not count as a reference, because the function is
1720 * looked up by name.
1721 */
1722 static int
1723func_name_refcount(char_u *name)
1724{
1725 return isdigit(*name) || *name == '<';
1726}
1727
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001728static funccal_entry_T *funccal_stack = NULL;
1729
1730/*
1731 * Save the current function call pointer, and set it to NULL.
1732 * Used when executing autocommands and for ":source".
1733 */
1734 void
1735save_funccal(funccal_entry_T *entry)
1736{
1737 entry->top_funccal = current_funccal;
1738 entry->next = funccal_stack;
1739 funccal_stack = entry;
1740 current_funccal = NULL;
1741}
1742
1743 void
1744restore_funccal(void)
1745{
1746 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001747 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001748 else
1749 {
1750 current_funccal = funccal_stack->top_funccal;
1751 funccal_stack = funccal_stack->next;
1752 }
1753}
1754
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001755 funccall_T *
1756get_current_funccal(void)
1757{
1758 return current_funccal;
1759}
1760
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001761/*
1762 * Mark all functions of script "sid" as deleted.
1763 */
1764 void
1765delete_script_functions(int sid)
1766{
1767 hashitem_T *hi;
1768 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001769 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001770 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001771 size_t len;
1772
1773 buf[0] = K_SPECIAL;
1774 buf[1] = KS_EXTRA;
1775 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001776 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001777 len = STRLEN(buf);
1778
Bram Moolenaarce658352020-07-31 23:47:12 +02001779 while (todo > 0)
1780 {
1781 todo = func_hashtab.ht_used;
1782 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1783 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001784 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001785 fp = HI2UF(hi);
1786 if (STRNCMP(fp->uf_name, buf, len) == 0)
1787 {
1788 int changed = func_hashtab.ht_changed;
1789
1790 fp->uf_flags |= FC_DEAD;
1791 func_clear(fp, TRUE);
1792 // When clearing a function another function can be cleared
1793 // as a side effect. When that happens start over.
1794 if (changed != func_hashtab.ht_changed)
1795 break;
1796 }
1797 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001798 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001799 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001800}
1801
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802#if defined(EXITFREE) || defined(PROTO)
1803 void
1804free_all_functions(void)
1805{
1806 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001807 ufunc_T *fp;
1808 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001809 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001810 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811
Bram Moolenaare38eab22019-12-05 21:50:01 +01001812 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001813 while (current_funccal != NULL)
1814 {
1815 clear_tv(current_funccal->rettv);
1816 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001817 if (current_funccal == NULL && funccal_stack != NULL)
1818 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001819 }
1820
Bram Moolenaare38eab22019-12-05 21:50:01 +01001821 // First clear what the functions contain. Since this may lower the
1822 // reference count of a function, it may also free a function and change
1823 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001824 while (todo > 0)
1825 {
1826 todo = func_hashtab.ht_used;
1827 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1828 if (!HASHITEM_EMPTY(hi))
1829 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001830 // clear the def function index now
1831 fp = HI2UF(hi);
1832 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001833 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001834
Bram Moolenaare38eab22019-12-05 21:50:01 +01001835 // Only free functions that are not refcounted, those are
1836 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001837 if (func_name_refcount(fp->uf_name))
1838 ++skipped;
1839 else
1840 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001841 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001842 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001843 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001844 {
1845 skipped = 0;
1846 break;
1847 }
1848 }
1849 --todo;
1850 }
1851 }
1852
Bram Moolenaare38eab22019-12-05 21:50:01 +01001853 // Now actually free the functions. Need to start all over every time,
1854 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001855 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001856 while (func_hashtab.ht_used > skipped)
1857 {
1858 todo = func_hashtab.ht_used;
1859 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 if (!HASHITEM_EMPTY(hi))
1861 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001862 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001863 // Only free functions that are not refcounted, those are
1864 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001865 fp = HI2UF(hi);
1866 if (func_name_refcount(fp->uf_name))
1867 ++skipped;
1868 else
1869 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001870 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001871 skipped = 0;
1872 break;
1873 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001874 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001875 }
1876 if (skipped == 0)
1877 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001878
1879 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001880}
1881#endif
1882
1883/*
1884 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001885 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001886 * "len" is the length of "name", or -1 for NUL terminated.
1887 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001889builtin_function(char_u *name, int len)
1890{
1891 char_u *p;
1892
Bram Moolenaara26b9702020-04-18 19:53:28 +02001893 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001894 return FALSE;
1895 p = vim_strchr(name, AUTOLOAD_CHAR);
1896 return p == NULL || (len > 0 && p > name + len);
1897}
1898
1899 int
1900func_call(
1901 char_u *name,
1902 typval_T *args,
1903 partial_T *partial,
1904 dict_T *selfdict,
1905 typval_T *rettv)
1906{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001907 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001908 listitem_T *item;
1909 typval_T argv[MAX_FUNC_ARGS + 1];
1910 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001911 int r = 0;
1912
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001913 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001914 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001915 {
1916 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1917 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001918 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 break;
1920 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001921 // Make a copy of each argument. This is needed to be able to set
1922 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001923 copy_tv(&item->li_tv, &argv[argc++]);
1924 }
1925
1926 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001927 {
1928 funcexe_T funcexe;
1929
Bram Moolenaara80faa82020-04-12 19:37:17 +02001930 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001931 funcexe.firstline = curwin->w_cursor.lnum;
1932 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001933 funcexe.evaluate = TRUE;
1934 funcexe.partial = partial;
1935 funcexe.selfdict = selfdict;
1936 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1937 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938
Bram Moolenaare38eab22019-12-05 21:50:01 +01001939 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001940 while (argc > 0)
1941 clear_tv(&argv[--argc]);
1942
1943 return r;
1944}
1945
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001946static int callback_depth = 0;
1947
1948 int
1949get_callback_depth(void)
1950{
1951 return callback_depth;
1952}
1953
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001954/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001955 * Invoke call_func() with a callback.
1956 */
1957 int
1958call_callback(
1959 callback_T *callback,
1960 int len, // length of "name" or -1 to use strlen()
1961 typval_T *rettv, // return value goes here
1962 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001963 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001964 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001965{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001966 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001967 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001968
Bram Moolenaara80faa82020-04-12 19:37:17 +02001969 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001970 funcexe.evaluate = TRUE;
1971 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001972 ++callback_depth;
1973 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1974 --callback_depth;
1975 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001976}
1977
1978/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001979 * Give an error message for the result of a function.
1980 * Nothing if "error" is FCERR_NONE.
1981 */
1982 void
1983user_func_error(int error, char_u *name)
1984{
1985 switch (error)
1986 {
1987 case FCERR_UNKNOWN:
1988 emsg_funcname(e_unknownfunc, name);
1989 break;
1990 case FCERR_NOTMETHOD:
1991 emsg_funcname(
1992 N_("E276: Cannot use function as a method: %s"), name);
1993 break;
1994 case FCERR_DELETED:
1995 emsg_funcname(N_(e_func_deleted), name);
1996 break;
1997 case FCERR_TOOMANY:
1998 emsg_funcname((char *)e_toomanyarg, name);
1999 break;
2000 case FCERR_TOOFEW:
2001 emsg_funcname((char *)e_toofewarg, name);
2002 break;
2003 case FCERR_SCRIPT:
2004 emsg_funcname(
2005 N_("E120: Using <SID> not in a script context: %s"), name);
2006 break;
2007 case FCERR_DICT:
2008 emsg_funcname(
2009 N_("E725: Calling dict function without Dictionary: %s"),
2010 name);
2011 break;
2012 }
2013}
2014
2015/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002017 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 * Return FAIL when the function can't be called, OK otherwise.
2019 * Also returns OK when an error was encountered while executing the function.
2020 */
2021 int
2022call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002023 char_u *funcname, // name of the function
2024 int len, // length of "name" or -1 to use strlen()
2025 typval_T *rettv, // return value goes here
2026 int argcount_in, // number of "argvars"
2027 typval_T *argvars_in, // vars for arguments, must have "argcount"
2028 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002029 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002030{
2031 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002032 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002034 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002035 char_u fname_buf[FLEN_FIXED + 1];
2036 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002037 char_u *fname = NULL;
2038 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 int argcount = argcount_in;
2040 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002041 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002042 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2043 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002044 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002045 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002046 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002047
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002048 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2049 // even when call_func() returns FAIL.
2050 rettv->v_type = VAR_UNKNOWN;
2051
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002052 if (partial != NULL)
2053 fp = partial->pt_func;
2054 if (fp == NULL)
2055 {
2056 // Make a copy of the name, if it comes from a funcref variable it
2057 // could be changed or deleted in the called function.
2058 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2059 if (name == NULL)
2060 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002061
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002062 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2063 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002064
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002065 if (funcexe->doesrange != NULL)
2066 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002067
2068 if (partial != NULL)
2069 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002070 // When the function has a partial with a dict and there is a dict
2071 // argument, use the dict argument. That is backwards compatible.
2072 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002073 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002074 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002075 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002076 {
2077 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002078 {
2079 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2080 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002081 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002082 goto theend;
2083 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002084 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002085 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002086 for (i = 0; i < argcount_in; ++i)
2087 argv[i + argv_clear] = argvars_in[i];
2088 argvars = argv;
2089 argcount = partial->pt_argc + argcount_in;
2090 }
2091 }
2092
Bram Moolenaaref140542019-12-31 21:27:13 +01002093 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002094 {
2095 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002096 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002097
Bram Moolenaar333894b2020-08-01 18:53:07 +02002098 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002099 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002100 {
2101 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002103 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104
Bram Moolenaare38eab22019-12-05 21:50:01 +01002105 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002106 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002107 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002108
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002109 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 {
2111 /*
2112 * User defined function.
2113 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002114 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002115 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116
Bram Moolenaare38eab22019-12-05 21:50:01 +01002117 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002118 if (fp == NULL
2119 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002120 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002121 && !aborting())
2122 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002123 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002124 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002126 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002127 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2128 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002129 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002130 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002131 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002132 if (fp == NULL)
2133 {
2134 char_u *p = untrans_function_name(rfname);
2135
2136 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002137 // Don't do this if the name starts with "s:".
2138 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002139 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002140 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002142 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002143 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002144#ifdef FEAT_LUA
2145 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2146 {
2147 cfunc_T cb = fp->uf_cb;
2148
2149 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2150 }
2151#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002152 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002154 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002155 // postponed filling in the arguments, do it now
2156 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002157 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002158
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002159 if (funcexe->basetv != NULL)
2160 {
2161 // Method call: base->Method()
2162 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2163 argv[0] = *funcexe->basetv;
2164 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002165 argvars = argv;
2166 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002167 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002168
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002169 error = call_user_func_check(fp, argcount, argvars, rettv,
2170 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002171 }
2172 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002173 else if (funcexe->basetv != NULL)
2174 {
2175 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002176 * expr->method(): Find the method name in the table, call its
2177 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002178 */
2179 error = call_internal_method(fname, argcount, argvars, rettv,
2180 funcexe->basetv);
2181 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002182 else
2183 {
2184 /*
2185 * Find the function name in the table, call its implementation.
2186 */
2187 error = call_internal_func(fname, argcount, argvars, rettv);
2188 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002189
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002190 /*
2191 * The function call (or "FuncUndefined" autocommand sequence) might
2192 * have been aborted by an error, an interrupt, or an explicitly thrown
2193 * exception that has not been caught so far. This situation can be
2194 * tested for by calling aborting(). For an error in an internal
2195 * function or for the "E132" error in call_user_func(), however, the
2196 * throw point at which the "force_abort" flag (temporarily reset by
2197 * emsg()) is normally updated has not been reached yet. We need to
2198 * update that flag first to make aborting() reliable.
2199 */
2200 update_force_abort();
2201 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002202 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002203 ret = OK;
2204
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002205theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206 /*
2207 * Report an error unless the argument evaluation or function call has been
2208 * cancelled due to an aborting error, an interrupt, or an exception.
2209 */
2210 if (!aborting())
2211 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002212 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002213 }
2214
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002215 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002216 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002217 clear_tv(&argv[--argv_clear + argv_base]);
2218
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 vim_free(tofree);
2220 vim_free(name);
2221
2222 return ret;
2223}
2224
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002225 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002226printable_func_name(ufunc_T *fp)
2227{
2228 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2229}
2230
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002232 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002233 */
2234 static void
2235list_func_head(ufunc_T *fp, int indent)
2236{
2237 int j;
2238
2239 msg_start();
2240 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002241 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002242 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002243 msg_puts("def ");
2244 else
2245 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002246 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 msg_putchar('(');
2248 for (j = 0; j < fp->uf_args.ga_len; ++j)
2249 {
2250 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002251 msg_puts(", ");
2252 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002253 if (fp->uf_arg_types != NULL)
2254 {
2255 char *tofree;
2256
2257 msg_puts(": ");
2258 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2259 vim_free(tofree);
2260 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002261 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2262 {
2263 msg_puts(" = ");
2264 msg_puts(((char **)(fp->uf_def_args.ga_data))
2265 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2266 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002267 }
2268 if (fp->uf_varargs)
2269 {
2270 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002271 msg_puts(", ");
2272 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002273 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274 if (fp->uf_va_name != NULL)
2275 {
2276 if (j)
2277 msg_puts(", ");
2278 msg_puts("...");
2279 msg_puts((char *)fp->uf_va_name);
2280 if (fp->uf_va_type)
2281 {
2282 char *tofree;
2283
2284 msg_puts(": ");
2285 msg_puts(type_name(fp->uf_va_type, &tofree));
2286 vim_free(tofree);
2287 }
2288 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002290
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002291 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002292 {
2293 if (fp->uf_ret_type != &t_void)
2294 {
2295 char *tofree;
2296
2297 msg_puts(": ");
2298 msg_puts(type_name(fp->uf_ret_type, &tofree));
2299 vim_free(tofree);
2300 }
2301 }
2302 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002303 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002304 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002305 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002307 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002308 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002309 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002310 msg_clr_eos();
2311 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002312 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002313}
2314
2315/*
2316 * Get a function name, translating "<SID>" and "<SNR>".
2317 * Also handles a Funcref in a List or Dictionary.
2318 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002319 * Set "*is_global" to TRUE when the function must be global, unless
2320 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002321 * flags:
2322 * TFN_INT: internal function name OK
2323 * TFN_QUIET: be quiet
2324 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002325 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326 * Advances "pp" to just after the function name (if no error).
2327 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002328 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002329trans_function_name(
2330 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002331 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002332 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002334 funcdict_T *fdp, // return: info about dictionary used
2335 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336{
2337 char_u *name = NULL;
2338 char_u *start;
2339 char_u *end;
2340 int lead;
2341 char_u sid_buf[20];
2342 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002343 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002345 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002346
2347 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002348 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 start = *pp;
2350
Bram Moolenaare38eab22019-12-05 21:50:01 +01002351 // Check for hard coded <SNR>: already translated function ID (from a user
2352 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2354 && (*pp)[2] == (int)KE_SNR)
2355 {
2356 *pp += 3;
2357 len = get_id_len(pp) + 3;
2358 return vim_strnsave(start, len);
2359 }
2360
Bram Moolenaare38eab22019-12-05 21:50:01 +01002361 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2362 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 lead = eval_fname_script(start);
2364 if (lead > 2)
2365 start += lead;
2366
Bram Moolenaare38eab22019-12-05 21:50:01 +01002367 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002368 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369 lead > 2 ? 0 : FNE_CHECK_START);
2370 if (end == start)
2371 {
2372 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002373 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002374 goto theend;
2375 }
2376 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2377 {
2378 /*
2379 * Report an invalid expression in braces, unless the expression
2380 * evaluation has been cancelled due to an aborting error, an
2381 * interrupt, or an exception.
2382 */
2383 if (!aborting())
2384 {
2385 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002386 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387 }
2388 else
2389 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2390 goto theend;
2391 }
2392
2393 if (lv.ll_tv != NULL)
2394 {
2395 if (fdp != NULL)
2396 {
2397 fdp->fd_dict = lv.ll_dict;
2398 fdp->fd_newkey = lv.ll_newkey;
2399 lv.ll_newkey = NULL;
2400 fdp->fd_di = lv.ll_di;
2401 }
2402 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2403 {
2404 name = vim_strsave(lv.ll_tv->vval.v_string);
2405 *pp = end;
2406 }
2407 else if (lv.ll_tv->v_type == VAR_PARTIAL
2408 && lv.ll_tv->vval.v_partial != NULL)
2409 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002410 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411 *pp = end;
2412 if (partial != NULL)
2413 *partial = lv.ll_tv->vval.v_partial;
2414 }
2415 else
2416 {
2417 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2418 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002419 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420 else
2421 *pp = end;
2422 name = NULL;
2423 }
2424 goto theend;
2425 }
2426
2427 if (lv.ll_name == NULL)
2428 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002429 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 *pp = end;
2431 goto theend;
2432 }
2433
Bram Moolenaare38eab22019-12-05 21:50:01 +01002434 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002435 if (lv.ll_exp_name != NULL)
2436 {
2437 len = (int)STRLEN(lv.ll_exp_name);
2438 name = deref_func_name(lv.ll_exp_name, &len, partial,
2439 flags & TFN_NO_AUTOLOAD);
2440 if (name == lv.ll_exp_name)
2441 name = NULL;
2442 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002443 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444 {
2445 len = (int)(end - *pp);
2446 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2447 if (name == *pp)
2448 name = NULL;
2449 }
2450 if (name != NULL)
2451 {
2452 name = vim_strsave(name);
2453 *pp = end;
2454 if (STRNCMP(name, "<SNR>", 5) == 0)
2455 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002456 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 name[0] = K_SPECIAL;
2458 name[1] = KS_EXTRA;
2459 name[2] = (int)KE_SNR;
2460 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2461 }
2462 goto theend;
2463 }
2464
2465 if (lv.ll_exp_name != NULL)
2466 {
2467 len = (int)STRLEN(lv.ll_exp_name);
2468 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2469 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2470 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002471 // When there was "s:" already or the name expanded to get a
2472 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473 lv.ll_name += 2;
2474 len -= 2;
2475 lead = 2;
2476 }
2477 }
2478 else
2479 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002480 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002482 {
2483 if (is_global != NULL && lv.ll_name[0] == 'g')
2484 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002486 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 len = (int)(end - lv.ll_name);
2488 }
2489
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002490 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002491 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002492
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 /*
2494 * Copy the function name to allocated memory.
2495 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2496 * Accept <SNR>123_name() outside a script.
2497 */
2498 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002499 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002500 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002502 if (!vim9script)
2503 lead = 3;
2504 if (vim9script || (lv.ll_exp_name != NULL
2505 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 || eval_fname_sid(*pp))
2507 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002508 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002509 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002511 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 goto theend;
2513 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002514 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002515 if (vim9script)
2516 extra = 3 + (int)STRLEN(sid_buf);
2517 else
2518 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002519 }
2520 }
2521 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2522 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002523 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 start);
2525 goto theend;
2526 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002527 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 {
2529 char_u *cp = vim_strchr(lv.ll_name, ':');
2530
2531 if (cp != NULL && cp < end)
2532 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002533 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 goto theend;
2535 }
2536 }
2537
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002538 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 if (name != NULL)
2540 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002541 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 {
2543 name[0] = K_SPECIAL;
2544 name[1] = KS_EXTRA;
2545 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002546 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 STRCPY(name + 3, sid_buf);
2548 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002549 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2550 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551 }
2552 *pp = end;
2553
2554theend:
2555 clear_lval(&lv);
2556 return name;
2557}
2558
2559/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002560 * Assuming "name" is the result of trans_function_name() and it was prefixed
2561 * to use the script-local name, return the unmodified name (points into
2562 * "name"). Otherwise return NULL.
2563 * This can be used to first search for a script-local function and fall back
2564 * to the global function if not found.
2565 */
2566 char_u *
2567untrans_function_name(char_u *name)
2568{
2569 char_u *p;
2570
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002571 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002572 {
2573 p = vim_strchr(name, '_');
2574 if (p != NULL)
2575 return p + 1;
2576 }
2577 return NULL;
2578}
2579
2580/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002581 * List functions. When "regmatch" is NULL all of then.
2582 * Otherwise functions matching "regmatch".
2583 */
2584 static void
2585list_functions(regmatch_T *regmatch)
2586{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002587 int changed = func_hashtab.ht_changed;
2588 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002589 hashitem_T *hi;
2590
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002591 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002592 {
2593 if (!HASHITEM_EMPTY(hi))
2594 {
2595 ufunc_T *fp = HI2UF(hi);
2596
2597 --todo;
2598 if ((fp->uf_flags & FC_DEAD) == 0
2599 && (regmatch == NULL
2600 ? !message_filtered(fp->uf_name)
2601 && !func_name_refcount(fp->uf_name)
2602 : !isdigit(*fp->uf_name)
2603 && vim_regexec(regmatch, fp->uf_name, 0)))
2604 {
2605 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002606 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002607 {
2608 emsg(_("E454: function list was modified"));
2609 return;
2610 }
2611 }
2612 }
2613 }
2614}
2615
2616/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002617 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002618 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2619 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002620 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002622 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002623def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624{
2625 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002626 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002627 int j;
2628 int c;
2629 int saved_did_emsg;
2630 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002631 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002632 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 char_u *p;
2634 char_u *arg;
2635 char_u *line_arg = NULL;
2636 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002637 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002638 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 garray_T newlines;
2640 int varargs = FALSE;
2641 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002642 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002643 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002644 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002645 int indent;
2646 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002647#define MAX_FUNC_NESTING 50
2648 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 dictitem_T *v;
2650 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002651 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002654 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002655 linenr_T sourcing_lnum_off;
2656 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002657 int is_heredoc = FALSE;
2658 char_u *skip_until = NULL;
2659 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002660 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002661 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662
2663 /*
2664 * ":function" without argument: list functions.
2665 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002666 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 {
2668 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002669 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002671 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672 }
2673
2674 /*
2675 * ":function /pat": list functions matching pattern.
2676 */
2677 if (*eap->arg == '/')
2678 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002679 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680 if (!eap->skip)
2681 {
2682 regmatch_T regmatch;
2683
2684 c = *p;
2685 *p = NUL;
2686 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2687 *p = c;
2688 if (regmatch.regprog != NULL)
2689 {
2690 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002691 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692 vim_regfree(regmatch.regprog);
2693 }
2694 }
2695 if (*p == '/')
2696 ++p;
2697 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002698 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 }
2700
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002701 ga_init(&newargs);
2702 ga_init(&argtypes);
2703 ga_init(&default_args);
2704
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 /*
2706 * Get the function name. There are these situations:
2707 * func normal function name
2708 * "name" == func, "fudi.fd_dict" == NULL
2709 * dict.func new dictionary entry
2710 * "name" == NULL, "fudi.fd_dict" set,
2711 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2712 * dict.func existing dict entry with a Funcref
2713 * "name" == func, "fudi.fd_dict" set,
2714 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2715 * dict.func existing dict entry that's not a Funcref
2716 * "name" == NULL, "fudi.fd_dict" set,
2717 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2718 * s:func script-local function name
2719 * g:func global function name, same as "func"
2720 */
2721 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002722 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002724 // nested function, argument is (args).
2725 paren = TRUE;
2726 CLEAR_FIELD(fudi);
2727 }
2728 else
2729 {
2730 name = trans_function_name(&p, &is_global, eap->skip,
2731 TFN_NO_AUTOLOAD, &fudi, NULL);
2732 paren = (vim_strchr(p, '(') != NULL);
2733 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002735 /*
2736 * Return on an invalid expression in braces, unless the expression
2737 * evaluation has been cancelled due to an aborting error, an
2738 * interrupt, or an exception.
2739 */
2740 if (!aborting())
2741 {
2742 if (!eap->skip && fudi.fd_newkey != NULL)
2743 semsg(_(e_dictkey), fudi.fd_newkey);
2744 vim_free(fudi.fd_newkey);
2745 return NULL;
2746 }
2747 else
2748 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002749 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 }
2751
Bram Moolenaare38eab22019-12-05 21:50:01 +01002752 // An error in a function call during evaluation of an expression in magic
2753 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 saved_did_emsg = did_emsg;
2755 did_emsg = FALSE;
2756
2757 /*
2758 * ":function func" with only function name: list function.
2759 */
2760 if (!paren)
2761 {
2762 if (!ends_excmd(*skipwhite(p)))
2763 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002764 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 goto ret_free;
2766 }
2767 eap->nextcmd = check_nextcmd(p);
2768 if (eap->nextcmd != NULL)
2769 *p = NUL;
2770 if (!eap->skip && !got_int)
2771 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002772 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002773 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2774 {
2775 char_u *up = untrans_function_name(name);
2776
2777 // With Vim9 script the name was made script-local, if not
2778 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002779 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002780 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002781 }
2782
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 if (fp != NULL)
2784 {
2785 list_func_head(fp, TRUE);
2786 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2787 {
2788 if (FUNCLINE(fp, j) == NULL)
2789 continue;
2790 msg_putchar('\n');
2791 msg_outnum((long)(j + 1));
2792 if (j < 9)
2793 msg_putchar(' ');
2794 if (j < 99)
2795 msg_putchar(' ');
2796 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002797 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 ui_breakcheck();
2799 }
2800 if (!got_int)
2801 {
2802 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002803 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002804 msg_puts(" enddef");
2805 else
2806 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 }
2808 }
2809 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002810 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002811 }
2812 goto ret_free;
2813 }
2814
2815 /*
2816 * ":function name(arg1, arg2)" Define function.
2817 */
2818 p = skipwhite(p);
2819 if (*p != '(')
2820 {
2821 if (!eap->skip)
2822 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002823 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 goto ret_free;
2825 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002826 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 if (vim_strchr(p, '(') != NULL)
2828 p = vim_strchr(p, '(');
2829 }
2830 p = skipwhite(p + 1);
2831
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002832 // In Vim9 script only global functions can be redefined.
2833 if (vim9script && eap->forceit && !is_global)
2834 {
2835 emsg(_(e_nobang));
2836 goto ret_free;
2837 }
2838
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2840
Bram Moolenaar04b12692020-05-04 23:24:44 +02002841 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002843 // Check the name of the function. Unless it's a dictionary function
2844 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845 if (name != NULL)
2846 arg = name;
2847 else
2848 arg = fudi.fd_newkey;
2849 if (arg != NULL && (fudi.fd_di == NULL
2850 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2851 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2852 {
2853 if (*arg == K_SPECIAL)
2854 j = 3;
2855 else
2856 j = 0;
2857 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2858 : eval_isnamec(arg[j])))
2859 ++j;
2860 if (arg[j] != NUL)
2861 emsg_funcname((char *)e_invarg2, arg);
2862 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002863 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002865 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 }
2867
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002868 // This may get more lines and make the pointers into the first line
2869 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002870 if (get_function_args(&p, ')', &newargs,
2871 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002872 &varargs, &default_args, eap->skip,
2873 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 goto errret_2;
2875
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002876 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002877 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002878 // find the return type: :def Func(): type
2879 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002882 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002883 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002884 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002885 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002886 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002887 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002888 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002889 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002890 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002891 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002892 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002894 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002896 else
2897 // find extra arguments "range", "dict", "abort" and "closure"
2898 for (;;)
2899 {
2900 p = skipwhite(p);
2901 if (STRNCMP(p, "range", 5) == 0)
2902 {
2903 flags |= FC_RANGE;
2904 p += 5;
2905 }
2906 else if (STRNCMP(p, "dict", 4) == 0)
2907 {
2908 flags |= FC_DICT;
2909 p += 4;
2910 }
2911 else if (STRNCMP(p, "abort", 5) == 0)
2912 {
2913 flags |= FC_ABORT;
2914 p += 5;
2915 }
2916 else if (STRNCMP(p, "closure", 7) == 0)
2917 {
2918 flags |= FC_CLOSURE;
2919 p += 7;
2920 if (current_funccal == NULL)
2921 {
2922 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2923 name == NULL ? (char_u *)"" : name);
2924 goto erret;
2925 }
2926 }
2927 else
2928 break;
2929 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930
Bram Moolenaare38eab22019-12-05 21:50:01 +01002931 // When there is a line break use what follows for the function body.
2932 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002933 if (*p == '\n')
2934 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002935 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002936 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2937 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002938 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2939 && !eap->skip
2940 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002941 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942
2943 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002944 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2945 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946 */
2947 if (KeyTyped)
2948 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002949 // Check if the function already exists, don't let the user type the
2950 // whole function before telling him it doesn't work! For a script we
2951 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 if (!eap->skip && !eap->forceit)
2953 {
2954 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002955 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002956 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002957 emsg_funcname(e_funcexts, name);
2958 }
2959
2960 if (!eap->skip && did_emsg)
2961 goto erret;
2962
Bram Moolenaare38eab22019-12-05 21:50:01 +01002963 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964 cmdline_row = msg_row;
2965 }
2966
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002967 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002968 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002969
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002970 // Detect having skipped over comment lines to find the return
2971 // type. Add NULL lines to keep the line count correct.
2972 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2973 if (SOURCING_LNUM < sourcing_lnum_off)
2974 {
2975 sourcing_lnum_off -= SOURCING_LNUM;
2976 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
2977 goto erret;
2978 while (sourcing_lnum_off-- > 0)
2979 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2980 }
2981
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002982 indent = 2;
2983 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002984 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002985 for (;;)
2986 {
2987 if (KeyTyped)
2988 {
2989 msg_scroll = TRUE;
2990 saved_wait_return = FALSE;
2991 }
2992 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993
2994 if (line_arg != NULL)
2995 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002996 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002997 theline = line_arg;
2998 p = vim_strchr(theline, '\n');
2999 if (p == NULL)
3000 line_arg += STRLEN(line_arg);
3001 else
3002 {
3003 *p = NUL;
3004 line_arg = p + 1;
3005 }
3006 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003008 {
3009 vim_free(line_to_free);
3010 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003011 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003012 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003013 theline = eap->getline(':', eap->cookie, indent,
3014 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003015 line_to_free = theline;
3016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017 if (KeyTyped)
3018 lines_left = Rows - 1;
3019 if (theline == NULL)
3020 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003021 if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003022 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 else
3024 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025 goto erret;
3026 }
3027
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003028 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003029 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003030 if (SOURCING_LNUM < sourcing_lnum_off)
3031 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003032 else
3033 sourcing_lnum_off = 0;
3034
3035 if (skip_until != NULL)
3036 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003037 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003038 // * ":append" and "."
3039 // * ":python <<EOF" and "EOF"
3040 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3041 if (heredoc_trimmed == NULL
3042 || (is_heredoc && skipwhite(theline) == theline)
3043 || STRNCMP(theline, heredoc_trimmed,
3044 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003045 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003046 if (heredoc_trimmed == NULL)
3047 p = theline;
3048 else if (is_heredoc)
3049 p = skipwhite(theline) == theline
3050 ? theline : theline + STRLEN(heredoc_trimmed);
3051 else
3052 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003053 if (STRCMP(p, skip_until) == 0)
3054 {
3055 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003056 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003057 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003058 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003059 }
3060 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 }
3062 else
3063 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003064 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003065 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 ;
3067
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003068 // Check for "endfunction" or "enddef".
3069 if (checkforcmd(&p, nesting_def[nesting]
3070 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003071 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003072 char_u *nextcmd = NULL;
3073
Bram Moolenaar663bb232017-06-22 19:12:10 +02003074 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003075 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003076 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003077 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003078 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003079 give_warning2(eap->cmdidx == CMD_def
3080 ? (char_u *)_("W1001: Text found after :enddef: %s")
3081 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003082 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003083 if (nextcmd != NULL)
3084 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003085 // Another command follows. If the line came from "eap" we
3086 // can simply point into it, otherwise we need to change
3087 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003088 eap->nextcmd = nextcmd;
3089 if (line_to_free != NULL)
3090 {
3091 vim_free(*eap->cmdlinep);
3092 *eap->cmdlinep = line_to_free;
3093 line_to_free = NULL;
3094 }
3095 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 break;
3097 }
3098
Bram Moolenaare38eab22019-12-05 21:50:01 +01003099 // Increase indent inside "if", "while", "for" and "try", decrease
3100 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003101 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003102 indent -= 2;
3103 else if (STRNCMP(p, "if", 2) == 0
3104 || STRNCMP(p, "wh", 2) == 0
3105 || STRNCMP(p, "for", 3) == 0
3106 || STRNCMP(p, "try", 3) == 0)
3107 indent += 2;
3108
Bram Moolenaare38eab22019-12-05 21:50:01 +01003109 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003110 // Only recognize "def" inside "def", not inside "function",
3111 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003112 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003113 if (checkforcmd(&p, "function", 2)
3114 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 {
3116 if (*p == '!')
3117 p = skipwhite(p + 1);
3118 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003119 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120 if (*skipwhite(p) == '(')
3121 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003122 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003123 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003124 else
3125 {
3126 ++nesting;
3127 nesting_def[nesting] = (c == 'd');
3128 indent += 2;
3129 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 }
3131 }
3132
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003133 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003135 if (eap->cmdidx != CMD_def
3136 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003137 || (p[0] == 'c'
3138 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3139 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3140 && (STRNCMP(&p[3], "nge", 3) != 0
3141 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 || (p[0] == 'i'
3143 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003144 && (!ASCII_ISALPHA(p[2])
3145 || (p[2] == 's'
3146 && (!ASCII_ISALPHA(p[3])
3147 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 skip_until = vim_strsave((char_u *)".");
3149
Bram Moolenaare38eab22019-12-05 21:50:01 +01003150 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 arg = skipwhite(skiptowhite(p));
3152 if (arg[0] == '<' && arg[1] =='<'
3153 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003154 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3155 || ((p[2] == '3' || p[2] == 'x')
3156 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 || (p[0] == 'p' && p[1] == 'e'
3158 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3159 || (p[0] == 't' && p[1] == 'c'
3160 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3161 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3162 && !ASCII_ISALPHA(p[3]))
3163 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3164 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3165 || (p[0] == 'm' && p[1] == 'z'
3166 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3167 ))
3168 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003169 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003170 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003171 if (STRNCMP(p, "trim", 4) == 0)
3172 {
3173 // Ignore leading white space.
3174 p = skipwhite(p + 4);
3175 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003176 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003177 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 if (*p == NUL)
3179 skip_until = vim_strsave((char_u *)".");
3180 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003181 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003182 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003183 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003185
3186 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003187 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003188 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003189 if (*arg == '[')
3190 arg = vim_strchr(arg, ']');
3191 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003192 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003193 arg = skipwhite(skiptowhite(arg));
3194 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3195 && ((p[0] == 'l'
3196 && p[1] == 'e'
3197 && (!ASCII_ISALNUM(p[2])
3198 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003199 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003200 p = skipwhite(arg + 3);
3201 if (STRNCMP(p, "trim", 4) == 0)
3202 {
3203 // Ignore leading white space.
3204 p = skipwhite(p + 4);
3205 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003206 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003207 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003208 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003209 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003210 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003211 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003212 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 }
3214
Bram Moolenaare38eab22019-12-05 21:50:01 +01003215 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218
Bram Moolenaare38eab22019-12-05 21:50:01 +01003219 // Copy the line to newly allocated memory. get_one_sourceline()
3220 // allocates 250 bytes per line, this saves 80% on average. The cost
3221 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003222 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003223 if (p == NULL)
3224 goto erret;
3225 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226
Bram Moolenaare38eab22019-12-05 21:50:01 +01003227 // Add NULL lines for continuation lines, so that the line count is
3228 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 while (sourcing_lnum_off-- > 0)
3230 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3231
Bram Moolenaare38eab22019-12-05 21:50:01 +01003232 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233 if (line_arg != NULL && *line_arg == NUL)
3234 line_arg = NULL;
3235 }
3236
Bram Moolenaare38eab22019-12-05 21:50:01 +01003237 // Don't define the function when skipping commands or when an error was
3238 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239 if (eap->skip || did_emsg)
3240 goto erret;
3241
3242 /*
3243 * If there are no errors, add the function
3244 */
3245 if (fudi.fd_dict == NULL)
3246 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003247 hashtab_T *ht;
3248
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 v = find_var(name, &ht, FALSE);
3250 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3251 {
3252 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3253 name);
3254 goto erret;
3255 }
3256
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003257 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003258 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003260 char_u *uname = untrans_function_name(name);
3261
3262 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3263 }
3264
3265 if (fp != NULL || import != NULL)
3266 {
3267 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003269 // Function can be replaced with "function!" and when sourcing the
3270 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003271 // A name that is used by an import can not be overruled.
3272 if (import != NULL
3273 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003274 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003275 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003277 if (vim9script)
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02003278 emsg_funcname(e_name_already_defined, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003279 else
3280 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 goto erret;
3282 }
3283 if (fp->uf_calls > 0)
3284 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003285 emsg_funcname(
3286 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287 name);
3288 goto erret;
3289 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003290 if (fp->uf_refcount > 1)
3291 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003292 // This function is referenced somewhere, don't redefine it but
3293 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003294 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003295 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003296 fp = NULL;
3297 overwrite = TRUE;
3298 }
3299 else
3300 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003301 char_u *exp_name = fp->uf_name_exp;
3302
3303 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003304 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003305 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003306 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003307 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003308 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003309#ifdef FEAT_PROFILE
3310 fp->uf_profiling = FALSE;
3311 fp->uf_prof_initialized = FALSE;
3312#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003313 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003314 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 }
3316 }
3317 else
3318 {
3319 char numbuf[20];
3320
3321 fp = NULL;
3322 if (fudi.fd_newkey == NULL && !eap->forceit)
3323 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003324 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 goto erret;
3326 }
3327 if (fudi.fd_di == NULL)
3328 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003329 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003330 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 goto erret;
3332 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003333 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003334 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 goto erret;
3336
Bram Moolenaare38eab22019-12-05 21:50:01 +01003337 // Give the function a sequential number. Can only be used with a
3338 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 vim_free(name);
3340 sprintf(numbuf, "%d", ++func_nr);
3341 name = vim_strsave((char_u *)numbuf);
3342 if (name == NULL)
3343 goto erret;
3344 }
3345
3346 if (fp == NULL)
3347 {
3348 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3349 {
3350 int slen, plen;
3351 char_u *scriptname;
3352
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003355 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356 {
3357 scriptname = autoload_name(name);
3358 if (scriptname != NULL)
3359 {
3360 p = vim_strchr(scriptname, '/');
3361 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003362 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003364 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365 j = OK;
3366 vim_free(scriptname);
3367 }
3368 }
3369 if (j == FAIL)
3370 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003371 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 goto erret;
3373 }
3374 }
3375
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003376 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 if (fp == NULL)
3378 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003379 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003380 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381
3382 if (fudi.fd_dict != NULL)
3383 {
3384 if (fudi.fd_di == NULL)
3385 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003386 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3388 if (fudi.fd_di == NULL)
3389 {
3390 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003391 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 goto erret;
3393 }
3394 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3395 {
3396 vim_free(fudi.fd_di);
3397 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003398 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399 goto erret;
3400 }
3401 }
3402 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003403 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 clear_tv(&fudi.fd_di->di_tv);
3405 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407
Bram Moolenaare38eab22019-12-05 21:50:01 +01003408 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 flags |= FC_DICT;
3410 }
3411
Bram Moolenaare38eab22019-12-05 21:50:01 +01003412 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003413 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003414 if (overwrite)
3415 {
3416 hi = hash_find(&func_hashtab, name);
3417 hi->hi_key = UF2HIKEY(fp);
3418 }
3419 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 {
3421 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003422 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 goto erret;
3424 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003425 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 }
3427 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003428 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003429 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003430 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003431
3432 if (eap->cmdidx == CMD_def)
3433 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003434 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003435
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003436 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003437
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003438 // error messages are for the first function line
3439 SOURCING_LNUM = sourcing_lnum_top;
3440
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003441 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003442 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003443
3444 if (argtypes.ga_len > 0)
3445 {
3446 // When "varargs" is set the last name/type goes into uf_va_name
3447 // and uf_va_type.
3448 int len = argtypes.ga_len - (varargs ? 1 : 0);
3449
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003450 if (len > 0)
3451 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452 if (fp->uf_arg_types != NULL)
3453 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003454 int i;
3455 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003456
3457 for (i = 0; i < len; ++ i)
3458 {
3459 p = ((char_u **)argtypes.ga_data)[i];
3460 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003461 // will get the type from the default value
3462 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003463 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003464 type = parse_type(&p, &fp->uf_type_list);
3465 if (type == NULL)
3466 {
3467 SOURCING_LNUM = lnum_save;
3468 goto errret_2;
3469 }
3470 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003471 }
3472 }
3473 if (varargs)
3474 {
3475 // Move the last argument "...name: type" to uf_va_name and
3476 // uf_va_type.
3477 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3478 [fp->uf_args.ga_len - 1];
3479 --fp->uf_args.ga_len;
3480 p = ((char_u **)argtypes.ga_data)[len];
3481 if (p == NULL)
3482 // todo: get type from default value
3483 fp->uf_va_type = &t_any;
3484 else
3485 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003486 if (fp->uf_va_type == NULL)
3487 {
3488 SOURCING_LNUM = lnum_save;
3489 goto errret_2;
3490 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003491 }
3492 varargs = FALSE;
3493 }
3494
3495 // parse the return type, if any
3496 if (ret_type == NULL)
3497 fp->uf_ret_type = &t_void;
3498 else
3499 {
3500 p = ret_type;
3501 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3502 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003503 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003504 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003505 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003506 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003507
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003509 if ((flags & FC_CLOSURE) != 0)
3510 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003511 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003512 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003513 }
3514 else
3515 fp->uf_scoped = NULL;
3516
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003517#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003518 if (prof_def_func())
3519 func_do_profile(fp);
3520#endif
3521 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003522 if (sandbox)
3523 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003524 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003525 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 fp->uf_flags = flags;
3527 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003528 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003529 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003530 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003531 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003532 if (is_export)
3533 {
3534 fp->uf_flags |= FC_EXPORT;
3535 // let ex_export() know the export worked.
3536 is_export = FALSE;
3537 }
3538
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003539 if (eap->cmdidx == CMD_def)
3540 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003541 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3542 // :func does not use Vim9 script syntax, even in a Vim9 script file
3543 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 goto ret_free;
3546
3547erret:
3548 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003549 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550errret_2:
3551 ga_clear_strings(&newlines);
3552ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003553 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003555 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003557 if (name != name_arg)
3558 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003559 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 did_emsg |= saved_did_emsg;
3561 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003562
3563 return fp;
3564}
3565
3566/*
3567 * ":function"
3568 */
3569 void
3570ex_function(exarg_T *eap)
3571{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003572 (void)def_function(eap, NULL);
3573}
3574
3575/*
3576 * :defcompile - compile all :def functions in the current script.
3577 */
3578 void
3579ex_defcompile(exarg_T *eap UNUSED)
3580{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003581 long todo = (long)func_hashtab.ht_used;
3582 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003583 hashitem_T *hi;
3584 ufunc_T *ufunc;
3585
3586 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3587 {
3588 if (!HASHITEM_EMPTY(hi))
3589 {
3590 --todo;
3591 ufunc = HI2UF(hi);
3592 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003593 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003594 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003595 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003596
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003597 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003598 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003599 // a function has been added or removed, need to start over
3600 todo = (long)func_hashtab.ht_used;
3601 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003602 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003603 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003604 }
3605 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003606 }
3607 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608}
3609
3610/*
3611 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3612 * Return 2 if "p" starts with "s:".
3613 * Return 0 otherwise.
3614 */
3615 int
3616eval_fname_script(char_u *p)
3617{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003618 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3619 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3621 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3622 return 5;
3623 if (p[0] == 's' && p[1] == ':')
3624 return 2;
3625 return 0;
3626}
3627
3628 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003629translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630{
3631 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003632 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003633 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003634}
3635
3636/*
3637 * Return TRUE when "ufunc" has old-style "..." varargs
3638 * or named varargs "...name: type".
3639 */
3640 int
3641has_varargs(ufunc_T *ufunc)
3642{
3643 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644}
3645
3646/*
3647 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003648 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 */
3650 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003651function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652{
3653 char_u *nm = name;
3654 char_u *p;
3655 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003656 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003657 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003659 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3660 if (no_deref)
3661 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003662 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 nm = skipwhite(nm);
3664
Bram Moolenaare38eab22019-12-05 21:50:01 +01003665 // Only accept "funcname", "funcname ", "funcname (..." and
3666 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003668 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 vim_free(p);
3670 return n;
3671}
3672
Bram Moolenaar113e1072019-01-20 15:30:40 +01003673#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 char_u *
3675get_expanded_name(char_u *name, int check)
3676{
3677 char_u *nm = name;
3678 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003679 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003681 p = trans_function_name(&nm, &is_global, FALSE,
3682 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003684 if (p != NULL && *nm == NUL
3685 && (!check || translated_function_exists(p, is_global)))
3686 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687
3688 vim_free(p);
3689 return NULL;
3690}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003691#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693/*
3694 * Function given to ExpandGeneric() to obtain the list of user defined
3695 * function names.
3696 */
3697 char_u *
3698get_user_func_name(expand_T *xp, int idx)
3699{
3700 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003701 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 static hashitem_T *hi;
3703 ufunc_T *fp;
3704
3705 if (idx == 0)
3706 {
3707 done = 0;
3708 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003709 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003711 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 {
3713 if (done++ > 0)
3714 ++hi;
3715 while (HASHITEM_EMPTY(hi))
3716 ++hi;
3717 fp = HI2UF(hi);
3718
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003719 // don't show dead, dict and lambda functions
3720 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003721 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003722 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723
3724 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003725 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726
3727 cat_func_name(IObuff, fp);
3728 if (xp->xp_context != EXPAND_USER_FUNC)
3729 {
3730 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003731 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732 STRCAT(IObuff, ")");
3733 }
3734 return IObuff;
3735 }
3736 return NULL;
3737}
3738
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739/*
3740 * ":delfunction {name}"
3741 */
3742 void
3743ex_delfunction(exarg_T *eap)
3744{
3745 ufunc_T *fp = NULL;
3746 char_u *p;
3747 char_u *name;
3748 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003749 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750
3751 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003752 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 vim_free(fudi.fd_newkey);
3754 if (name == NULL)
3755 {
3756 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003757 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 return;
3759 }
3760 if (!ends_excmd(*skipwhite(p)))
3761 {
3762 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003763 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 return;
3765 }
3766 eap->nextcmd = check_nextcmd(p);
3767 if (eap->nextcmd != NULL)
3768 *p = NUL;
3769
3770 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003771 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 vim_free(name);
3773
3774 if (!eap->skip)
3775 {
3776 if (fp == NULL)
3777 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003778 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003779 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 return;
3781 }
3782 if (fp->uf_calls > 0)
3783 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003784 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 return;
3786 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003787 if (fp->uf_flags & FC_VIM9)
3788 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003789 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003790 return;
3791 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792
3793 if (fudi.fd_dict != NULL)
3794 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003795 // Delete the dict item that refers to the function, it will
3796 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3798 }
3799 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003800 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003801 // A normal function (not a numbered function or lambda) has a
3802 // refcount of 1 for the entry in the hashtable. When deleting
3803 // it and the refcount is more than one, it should be kept.
3804 // A numbered function and lambda should be kept if the refcount is
3805 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003806 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003807 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003808 // Function is still referenced somewhere. Don't free it but
3809 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003810 if (func_remove(fp))
3811 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003812 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003813 }
3814 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003815 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003816 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 }
3818}
3819
3820/*
3821 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003822 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 */
3824 void
3825func_unref(char_u *name)
3826{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003827 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003829 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003831 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003832 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003835 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003837 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003839 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003841 // Only delete it when it's not being used. Otherwise it's done
3842 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003843 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003844 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003845 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003846}
3847
3848/*
3849 * Unreference a Function: decrement the reference count and free it when it
3850 * becomes zero.
3851 */
3852 void
3853func_ptr_unref(ufunc_T *fp)
3854{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003855 if (fp != NULL && --fp->uf_refcount <= 0)
3856 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003857 // Only delete it when it's not being used. Otherwise it's done
3858 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003859 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003860 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 }
3862}
3863
3864/*
3865 * Count a reference to a Function.
3866 */
3867 void
3868func_ref(char_u *name)
3869{
3870 ufunc_T *fp;
3871
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003872 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003874 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003875 if (fp != NULL)
3876 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003878 // Only give an error for a numbered function.
3879 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003880 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003881}
3882
3883/*
3884 * Count a reference to a Function.
3885 */
3886 void
3887func_ptr_ref(ufunc_T *fp)
3888{
3889 if (fp != NULL)
3890 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003891}
3892
3893/*
3894 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3895 * referenced from anywhere that is in use.
3896 */
3897 static int
3898can_free_funccal(funccall_T *fc, int copyID)
3899{
3900 return (fc->l_varlist.lv_copyID != copyID
3901 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003902 && fc->l_avars.dv_copyID != copyID
3903 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003904}
3905
3906/*
3907 * ":return [expr]"
3908 */
3909 void
3910ex_return(exarg_T *eap)
3911{
3912 char_u *arg = eap->arg;
3913 typval_T rettv;
3914 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003915 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916
3917 if (current_funccal == NULL)
3918 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003919 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 return;
3921 }
3922
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003923 CLEAR_FIELD(evalarg);
3924 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3925
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 if (eap->skip)
3927 ++emsg_skip;
3928
3929 eap->nextcmd = NULL;
3930 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003931 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932 {
3933 if (!eap->skip)
3934 returning = do_return(eap, FALSE, TRUE, &rettv);
3935 else
3936 clear_tv(&rettv);
3937 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003938 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 else if (!eap->skip)
3940 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003941 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003942 update_force_abort();
3943
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 /*
3945 * Return unless the expression evaluation has been cancelled due to an
3946 * aborting error, an interrupt, or an exception.
3947 */
3948 if (!aborting())
3949 returning = do_return(eap, FALSE, TRUE, NULL);
3950 }
3951
Bram Moolenaare38eab22019-12-05 21:50:01 +01003952 // When skipping or the return gets pending, advance to the next command
3953 // in this line (!returning). Otherwise, ignore the rest of the line.
3954 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 if (returning)
3956 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003957 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 eap->nextcmd = check_nextcmd(arg);
3959
3960 if (eap->skip)
3961 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003962 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963}
3964
3965/*
3966 * ":1,25call func(arg1, arg2)" function call.
3967 */
3968 void
3969ex_call(exarg_T *eap)
3970{
3971 char_u *arg = eap->arg;
3972 char_u *startarg;
3973 char_u *name;
3974 char_u *tofree;
3975 int len;
3976 typval_T rettv;
3977 linenr_T lnum;
3978 int doesrange;
3979 int failed = FALSE;
3980 funcdict_T fudi;
3981 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003982 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983
Bram Moolenaare6b53242020-07-01 17:28:33 +02003984 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 if (eap->skip)
3986 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003987 // trans_function_name() doesn't work well when skipping, use eval0()
3988 // instead to skip to any following command, e.g. for:
3989 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003991 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003992 clear_tv(&rettv);
3993 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003994 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 return;
3996 }
3997
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003998 tofree = trans_function_name(&arg, NULL, eap->skip,
3999 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000 if (fudi.fd_newkey != NULL)
4001 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004002 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004003 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 vim_free(fudi.fd_newkey);
4005 }
4006 if (tofree == NULL)
4007 return;
4008
Bram Moolenaare38eab22019-12-05 21:50:01 +01004009 // Increase refcount on dictionary, it could get deleted when evaluating
4010 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 if (fudi.fd_dict != NULL)
4012 ++fudi.fd_dict->dv_refcount;
4013
Bram Moolenaare38eab22019-12-05 21:50:01 +01004014 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4015 // contents. For VAR_PARTIAL get its partial, unless we already have one
4016 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 len = (int)STRLEN(tofree);
4018 name = deref_func_name(tofree, &len,
4019 partial != NULL ? NULL : &partial, FALSE);
4020
Bram Moolenaare38eab22019-12-05 21:50:01 +01004021 // Skip white space to allow ":call func ()". Not good, but required for
4022 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004024 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025
4026 if (*startarg != '(')
4027 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004028 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 goto end;
4030 }
4031
4032 /*
4033 * When skipping, evaluate the function once, to find the end of the
4034 * arguments.
4035 * When the function takes a range, this is discovered after the first
4036 * call, and the loop is broken.
4037 */
4038 if (eap->skip)
4039 {
4040 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004041 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 }
4043 else
4044 lnum = eap->line1;
4045 for ( ; lnum <= eap->line2; ++lnum)
4046 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004047 funcexe_T funcexe;
4048
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049 if (!eap->skip && eap->addr_count > 0)
4050 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004051 if (lnum > curbuf->b_ml.ml_line_count)
4052 {
4053 // If the function deleted lines or switched to another buffer
4054 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004055 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004056 break;
4057 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 curwin->w_cursor.lnum = lnum;
4059 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061 }
4062 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004063
Bram Moolenaara80faa82020-04-12 19:37:17 +02004064 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004065 funcexe.firstline = eap->line1;
4066 funcexe.lastline = eap->line2;
4067 funcexe.doesrange = &doesrange;
4068 funcexe.evaluate = !eap->skip;
4069 funcexe.partial = partial;
4070 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004071 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 {
4073 failed = TRUE;
4074 break;
4075 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004076 if (has_watchexpr())
4077 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004079 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004080 if (handle_subscript(&arg, &rettv,
4081 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 {
4083 failed = TRUE;
4084 break;
4085 }
4086
4087 clear_tv(&rettv);
4088 if (doesrange || eap->skip)
4089 break;
4090
Bram Moolenaare38eab22019-12-05 21:50:01 +01004091 // Stop when immediately aborting on error, or when an interrupt
4092 // occurred or an exception was thrown but not caught.
4093 // get_func_tv() returned OK, so that the check for trailing
4094 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 if (aborting())
4096 break;
4097 }
4098 if (eap->skip)
4099 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004100 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101
Bram Moolenaare51bb172020-02-16 19:42:23 +01004102 // When inside :try we need to check for following "| catch".
4103 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004105 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004106 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004107 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004109 if (!failed)
4110 {
4111 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004112 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004113 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004114 }
4115 else
4116 eap->nextcmd = check_nextcmd(arg);
4117 }
4118
4119end:
4120 dict_unref(fudi.fd_dict);
4121 vim_free(tofree);
4122}
4123
4124/*
4125 * Return from a function. Possibly makes the return pending. Also called
4126 * for a pending return at the ":endtry" or after returning from an extra
4127 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4128 * when called due to a ":return" command. "rettv" may point to a typval_T
4129 * with the return rettv. Returns TRUE when the return can be carried out,
4130 * FALSE when the return gets pending.
4131 */
4132 int
4133do_return(
4134 exarg_T *eap,
4135 int reanimate,
4136 int is_cmd,
4137 void *rettv)
4138{
4139 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004140 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141
4142 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004143 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004144 current_funccal->returned = FALSE;
4145
4146 /*
4147 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4148 * not in its finally clause (which then is to be executed next) is found.
4149 * In this case, make the ":return" pending for execution at the ":endtry".
4150 * Otherwise, return normally.
4151 */
4152 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4153 if (idx >= 0)
4154 {
4155 cstack->cs_pending[idx] = CSTP_RETURN;
4156
4157 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004158 // A pending return again gets pending. "rettv" points to an
4159 // allocated variable with the rettv of the original ":return"'s
4160 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161 cstack->cs_rettv[idx] = rettv;
4162 else
4163 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004164 // When undoing a return in order to make it pending, get the stored
4165 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166 if (reanimate)
4167 rettv = current_funccal->rettv;
4168
4169 if (rettv != NULL)
4170 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004171 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4173 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4174 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004175 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 }
4177 else
4178 cstack->cs_rettv[idx] = NULL;
4179
4180 if (reanimate)
4181 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004182 // The pending return value could be overwritten by a ":return"
4183 // without argument in a finally clause; reset the default
4184 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 current_funccal->rettv->v_type = VAR_NUMBER;
4186 current_funccal->rettv->vval.v_number = 0;
4187 }
4188 }
4189 report_make_pending(CSTP_RETURN, rettv);
4190 }
4191 else
4192 {
4193 current_funccal->returned = TRUE;
4194
Bram Moolenaare38eab22019-12-05 21:50:01 +01004195 // If the return is carried out now, store the return value. For
4196 // a return immediately after reanimation, the value is already
4197 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004198 if (!reanimate && rettv != NULL)
4199 {
4200 clear_tv(current_funccal->rettv);
4201 *current_funccal->rettv = *(typval_T *)rettv;
4202 if (!is_cmd)
4203 vim_free(rettv);
4204 }
4205 }
4206
4207 return idx < 0;
4208}
4209
4210/*
4211 * Free the variable with a pending return value.
4212 */
4213 void
4214discard_pending_return(void *rettv)
4215{
4216 free_tv((typval_T *)rettv);
4217}
4218
4219/*
4220 * Generate a return command for producing the value of "rettv". The result
4221 * is an allocated string. Used by report_pending() for verbose messages.
4222 */
4223 char_u *
4224get_return_cmd(void *rettv)
4225{
4226 char_u *s = NULL;
4227 char_u *tofree = NULL;
4228 char_u numbuf[NUMBUFLEN];
4229
4230 if (rettv != NULL)
4231 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4232 if (s == NULL)
4233 s = (char_u *)"";
4234
4235 STRCPY(IObuff, ":return ");
4236 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4237 if (STRLEN(s) + 8 >= IOSIZE)
4238 STRCPY(IObuff + IOSIZE - 4, "...");
4239 vim_free(tofree);
4240 return vim_strsave(IObuff);
4241}
4242
4243/*
4244 * Get next function line.
4245 * Called by do_cmdline() to get the next line.
4246 * Returns allocated string, or NULL for end of function.
4247 */
4248 char_u *
4249get_func_line(
4250 int c UNUSED,
4251 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004252 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004253 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254{
4255 funccall_T *fcp = (funccall_T *)cookie;
4256 ufunc_T *fp = fcp->func;
4257 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004258 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 if (fcp->dbg_tick != debug_tick)
4262 {
4263 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004264 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265 fcp->dbg_tick = debug_tick;
4266 }
4267#ifdef FEAT_PROFILE
4268 if (do_profiling == PROF_YES)
4269 func_line_end(cookie);
4270#endif
4271
4272 gap = &fp->uf_lines;
4273 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4274 || fcp->returned)
4275 retval = NULL;
4276 else
4277 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004278 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 while (fcp->linenr < gap->ga_len
4280 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4281 ++fcp->linenr;
4282 if (fcp->linenr >= gap->ga_len)
4283 retval = NULL;
4284 else
4285 {
4286 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004287 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288#ifdef FEAT_PROFILE
4289 if (do_profiling == PROF_YES)
4290 func_line_start(cookie);
4291#endif
4292 }
4293 }
4294
Bram Moolenaare38eab22019-12-05 21:50:01 +01004295 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004296 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004298 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004299 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004301 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004302 fcp->dbg_tick = debug_tick;
4303 }
4304
4305 return retval;
4306}
4307
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308/*
4309 * Return TRUE if the currently active function should be ended, because a
4310 * return was encountered or an error occurred. Used inside a ":while".
4311 */
4312 int
4313func_has_ended(void *cookie)
4314{
4315 funccall_T *fcp = (funccall_T *)cookie;
4316
Bram Moolenaare38eab22019-12-05 21:50:01 +01004317 // Ignore the "abort" flag if the abortion behavior has been changed due to
4318 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4320 || fcp->returned);
4321}
4322
4323/*
4324 * return TRUE if cookie indicates a function which "abort"s on errors.
4325 */
4326 int
4327func_has_abort(
4328 void *cookie)
4329{
4330 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4331}
4332
4333
4334/*
4335 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4336 * Don't do this when "Func" is already a partial that was bound
4337 * explicitly (pt_auto is FALSE).
4338 * Changes "rettv" in-place.
4339 * Returns the updated "selfdict_in".
4340 */
4341 dict_T *
4342make_partial(dict_T *selfdict_in, typval_T *rettv)
4343{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004344 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 char_u *tofree = NULL;
4346 ufunc_T *fp;
4347 char_u fname_buf[FLEN_FIXED + 1];
4348 int error;
4349 dict_T *selfdict = selfdict_in;
4350
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004351 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4352 fp = rettv->vval.v_partial->pt_func;
4353 else
4354 {
4355 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4356 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004357 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004358 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004359 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004360 vim_free(tofree);
4361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004362
4363 if (fp != NULL && (fp->uf_flags & FC_DICT))
4364 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004365 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366
4367 if (pt != NULL)
4368 {
4369 pt->pt_refcount = 1;
4370 pt->pt_dict = selfdict;
4371 pt->pt_auto = TRUE;
4372 selfdict = NULL;
4373 if (rettv->v_type == VAR_FUNC)
4374 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004375 // Just a function: Take over the function name and use
4376 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 pt->pt_name = rettv->vval.v_string;
4378 }
4379 else
4380 {
4381 partial_T *ret_pt = rettv->vval.v_partial;
4382 int i;
4383
Bram Moolenaare38eab22019-12-05 21:50:01 +01004384 // Partial: copy the function name, use selfdict and copy
4385 // args. Can't take over name or args, the partial might
4386 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004387 if (ret_pt->pt_name != NULL)
4388 {
4389 pt->pt_name = vim_strsave(ret_pt->pt_name);
4390 func_ref(pt->pt_name);
4391 }
4392 else
4393 {
4394 pt->pt_func = ret_pt->pt_func;
4395 func_ptr_ref(pt->pt_func);
4396 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397 if (ret_pt->pt_argc > 0)
4398 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004399 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004401 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 pt->pt_argc = 0;
4403 else
4404 {
4405 pt->pt_argc = ret_pt->pt_argc;
4406 for (i = 0; i < pt->pt_argc; i++)
4407 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4408 }
4409 }
4410 partial_unref(ret_pt);
4411 }
4412 rettv->v_type = VAR_PARTIAL;
4413 rettv->vval.v_partial = pt;
4414 }
4415 }
4416 return selfdict;
4417}
4418
4419/*
4420 * Return the name of the executed function.
4421 */
4422 char_u *
4423func_name(void *cookie)
4424{
4425 return ((funccall_T *)cookie)->func->uf_name;
4426}
4427
4428/*
4429 * Return the address holding the next breakpoint line for a funccall cookie.
4430 */
4431 linenr_T *
4432func_breakpoint(void *cookie)
4433{
4434 return &((funccall_T *)cookie)->breakpoint;
4435}
4436
4437/*
4438 * Return the address holding the debug tick for a funccall cookie.
4439 */
4440 int *
4441func_dbg_tick(void *cookie)
4442{
4443 return &((funccall_T *)cookie)->dbg_tick;
4444}
4445
4446/*
4447 * Return the nesting level for a funccall cookie.
4448 */
4449 int
4450func_level(void *cookie)
4451{
4452 return ((funccall_T *)cookie)->level;
4453}
4454
4455/*
4456 * Return TRUE when a function was ended by a ":return" command.
4457 */
4458 int
4459current_func_returned(void)
4460{
4461 return current_funccal->returned;
4462}
4463
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 int
4465free_unref_funccal(int copyID, int testing)
4466{
4467 int did_free = FALSE;
4468 int did_free_funccal = FALSE;
4469 funccall_T *fc, **pfc;
4470
4471 for (pfc = &previous_funccal; *pfc != NULL; )
4472 {
4473 if (can_free_funccal(*pfc, copyID))
4474 {
4475 fc = *pfc;
4476 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004477 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 did_free = TRUE;
4479 did_free_funccal = TRUE;
4480 }
4481 else
4482 pfc = &(*pfc)->caller;
4483 }
4484 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004485 // When a funccal was freed some more items might be garbage
4486 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 (void)garbage_collect(testing);
4488
4489 return did_free;
4490}
4491
4492/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004493 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 */
4495 static funccall_T *
4496get_funccal(void)
4497{
4498 int i;
4499 funccall_T *funccal;
4500 funccall_T *temp_funccal;
4501
4502 funccal = current_funccal;
4503 if (debug_backtrace_level > 0)
4504 {
4505 for (i = 0; i < debug_backtrace_level; i++)
4506 {
4507 temp_funccal = funccal->caller;
4508 if (temp_funccal)
4509 funccal = temp_funccal;
4510 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004511 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004512 debug_backtrace_level = i;
4513 }
4514 }
4515 return funccal;
4516}
4517
4518/*
4519 * Return the hashtable used for local variables in the current funccal.
4520 * Return NULL if there is no current funccal.
4521 */
4522 hashtab_T *
4523get_funccal_local_ht()
4524{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004525 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526 return NULL;
4527 return &get_funccal()->l_vars.dv_hashtab;
4528}
4529
4530/*
4531 * Return the l: scope variable.
4532 * Return NULL if there is no current funccal.
4533 */
4534 dictitem_T *
4535get_funccal_local_var()
4536{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004537 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004538 return NULL;
4539 return &get_funccal()->l_vars_var;
4540}
4541
4542/*
4543 * Return the hashtable used for argument in the current funccal.
4544 * Return NULL if there is no current funccal.
4545 */
4546 hashtab_T *
4547get_funccal_args_ht()
4548{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004549 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 return NULL;
4551 return &get_funccal()->l_avars.dv_hashtab;
4552}
4553
4554/*
4555 * Return the a: scope variable.
4556 * Return NULL if there is no current funccal.
4557 */
4558 dictitem_T *
4559get_funccal_args_var()
4560{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004561 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004563 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564}
4565
4566/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 * List function variables, if there is a function.
4568 */
4569 void
4570list_func_vars(int *first)
4571{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004572 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004574 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575}
4576
4577/*
4578 * If "ht" is the hashtable for local variables in the current funccal, return
4579 * the dict that contains it.
4580 * Otherwise return NULL.
4581 */
4582 dict_T *
4583get_current_funccal_dict(hashtab_T *ht)
4584{
4585 if (current_funccal != NULL
4586 && ht == &current_funccal->l_vars.dv_hashtab)
4587 return &current_funccal->l_vars;
4588 return NULL;
4589}
4590
4591/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004592 * Search hashitem in parent scope.
4593 */
4594 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004595find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004596{
4597 funccall_T *old_current_funccal = current_funccal;
4598 hashtab_T *ht;
4599 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004600 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004601
4602 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4603 return NULL;
4604
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004605 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004606 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004607 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004608 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004609 ht = find_var_ht(name, &varname);
4610 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004611 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004612 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004613 if (!HASHITEM_EMPTY(hi))
4614 {
4615 *pht = ht;
4616 break;
4617 }
4618 }
4619 if (current_funccal == current_funccal->func->uf_scoped)
4620 break;
4621 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004622 }
4623 current_funccal = old_current_funccal;
4624
4625 return hi;
4626}
4627
4628/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004629 * Search variable in parent scope.
4630 */
4631 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004632find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004633{
4634 dictitem_T *v = NULL;
4635 funccall_T *old_current_funccal = current_funccal;
4636 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004637 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004638
4639 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4640 return NULL;
4641
Bram Moolenaare38eab22019-12-05 21:50:01 +01004642 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004643 current_funccal = current_funccal->func->uf_scoped;
4644 while (current_funccal)
4645 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004646 ht = find_var_ht(name, &varname);
4647 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004648 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004649 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004650 if (v != NULL)
4651 break;
4652 }
4653 if (current_funccal == current_funccal->func->uf_scoped)
4654 break;
4655 current_funccal = current_funccal->func->uf_scoped;
4656 }
4657 current_funccal = old_current_funccal;
4658
4659 return v;
4660}
4661
4662/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663 * Set "copyID + 1" in previous_funccal and callers.
4664 */
4665 int
4666set_ref_in_previous_funccal(int copyID)
4667{
4668 int abort = FALSE;
4669 funccall_T *fc;
4670
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004671 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004673 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004674 abort = abort
4675 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4676 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004677 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004678 }
4679 return abort;
4680}
4681
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004682 static int
4683set_ref_in_funccal(funccall_T *fc, int copyID)
4684{
4685 int abort = FALSE;
4686
4687 if (fc->fc_copyID != copyID)
4688 {
4689 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004690 abort = abort
4691 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4692 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004693 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004694 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004695 }
4696 return abort;
4697}
4698
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699/*
4700 * Set "copyID" in all local vars and arguments in the call stack.
4701 */
4702 int
4703set_ref_in_call_stack(int copyID)
4704{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004705 int abort = FALSE;
4706 funccall_T *fc;
4707 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004709 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004710 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004711
4712 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004713 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4714 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004715 abort = abort || set_ref_in_funccal(fc, copyID);
4716
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004717 return abort;
4718}
4719
4720/*
4721 * Set "copyID" in all functions available by name.
4722 */
4723 int
4724set_ref_in_functions(int copyID)
4725{
4726 int todo;
4727 hashitem_T *hi = NULL;
4728 int abort = FALSE;
4729 ufunc_T *fp;
4730
4731 todo = (int)func_hashtab.ht_used;
4732 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004734 if (!HASHITEM_EMPTY(hi))
4735 {
4736 --todo;
4737 fp = HI2UF(hi);
4738 if (!func_name_refcount(fp->uf_name))
4739 abort = abort || set_ref_in_func(NULL, fp, copyID);
4740 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004741 }
4742 return abort;
4743}
4744
4745/*
4746 * Set "copyID" in all function arguments.
4747 */
4748 int
4749set_ref_in_func_args(int copyID)
4750{
4751 int i;
4752 int abort = FALSE;
4753
4754 for (i = 0; i < funcargs.ga_len; ++i)
4755 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4756 copyID, NULL, NULL);
4757 return abort;
4758}
4759
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004760/*
4761 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004762 * Returns TRUE if setting references failed somehow.
4763 */
4764 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004765set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004766{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004767 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004768 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004769 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004770 char_u fname_buf[FLEN_FIXED + 1];
4771 char_u *tofree = NULL;
4772 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004773 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004774
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004775 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004776 return FALSE;
4777
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004778 if (fp_in == NULL)
4779 {
4780 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004781 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004782 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004783 if (fp != NULL)
4784 {
4785 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004786 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004787 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004788
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004789 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004790 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004791}
4792
Bram Moolenaare38eab22019-12-05 21:50:01 +01004793#endif // FEAT_EVAL