blob: d91890373adfa8c961c34c6bde4b2d104cc429bf [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010057 * Return a pointer to after the type.
58 * When something is wrong return "arg".
59 */
60 static char_u *
61one_function_arg(char_u *arg, garray_T *newargs, garray_T *argtypes, int skip)
62{
Bram Moolenaar6e949782020-04-13 17:21:00 +020063 char_u *p = arg;
64 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010065
66 while (ASCII_ISALNUM(*p) || *p == '_')
67 ++p;
68 if (arg == p || isdigit(*arg)
69 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
70 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
71 {
72 if (!skip)
73 semsg(_("E125: Illegal argument: %s"), arg);
74 return arg;
75 }
76 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
77 return arg;
78 if (newargs != NULL)
79 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010080 int c;
81 int i;
82
83 c = *p;
84 *p = NUL;
85 arg_copy = vim_strsave(arg);
86 if (arg_copy == NULL)
87 {
88 *p = c;
89 return arg;
90 }
91
92 // Check for duplicate argument name.
93 for (i = 0; i < newargs->ga_len; ++i)
94 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
95 {
96 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
97 vim_free(arg_copy);
98 return arg;
99 }
100 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
101 newargs->ga_len++;
102
103 *p = c;
104 }
105
106 // get any type from "arg: type"
107 if (argtypes != NULL && ga_grow(argtypes, 1) == OK)
108 {
109 char_u *type = NULL;
110
Bram Moolenaar6e949782020-04-13 17:21:00 +0200111 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
112 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200113 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200114 arg_copy == NULL ? arg : arg_copy);
115 p = skipwhite(p);
116 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100117 if (*p == ':')
118 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200119 ++p;
120 if (!VIM_ISWHITE(*p))
121 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200122 semsg(_(e_white_space_required_after_str), ":");
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200123 return arg;
124 }
125 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200126 p = skip_type(type, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100127 type = vim_strnsave(type, p - type);
128 }
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 else if (*skipwhite(p) != '=')
130 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200131 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 arg_copy == NULL ? arg : arg_copy);
133 return arg;
134 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
136 }
137
138 return p;
139}
140
141/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200142 * Get function arguments.
143 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100144 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200145get_function_args(
146 char_u **argp,
147 char_u endchar,
148 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149 garray_T *argtypes, // NULL unless using :def
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200150 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200151 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200152 int skip,
153 exarg_T *eap,
154 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200155{
156 int mustend = FALSE;
157 char_u *arg = *argp;
158 char_u *p = arg;
159 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200160 int any_default = FALSE;
161 char_u *expr;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200162 char_u *whitep = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200163
164 if (newargs != NULL)
165 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100166 if (argtypes != NULL)
167 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 if (default_args != NULL)
169 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170
171 if (varargs != NULL)
172 *varargs = FALSE;
173
174 /*
175 * Isolate the arguments: "arg1, arg2, ...)"
176 */
177 while (*p != endchar)
178 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200179 while (eap != NULL && eap->getline != NULL
180 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200181 {
182 char_u *theline;
183
184 // End of the line, get the next one.
185 theline = eap->getline(':', eap->cookie, 0, TRUE);
186 if (theline == NULL)
187 break;
188 vim_free(*line_to_free);
189 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200190 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200191 p = skipwhite(theline);
192 }
193
194 if (mustend && *p != endchar)
195 {
196 if (!skip)
197 semsg(_(e_invarg2), *argp);
198 break;
199 }
200 if (*p == endchar)
201 break;
202
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
204 {
205 if (varargs != NULL)
206 *varargs = TRUE;
207 p += 3;
208 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100209
210 if (argtypes != NULL)
211 {
212 // ...name: list<type>
213 if (!ASCII_ISALPHA(*p))
214 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200215 emsg(_(e_missing_name_after_dots));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100216 break;
217 }
218
219 arg = p;
220 p = one_function_arg(p, newargs, argtypes, skip);
221 if (p == arg)
222 break;
223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200224 }
225 else
226 {
227 arg = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228 p = one_function_arg(p, newargs, argtypes, skip);
229 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200231
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200232 if (*skipwhite(p) == '=' && default_args != NULL)
233 {
234 typval_T rettv;
235
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100236 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200237 any_default = TRUE;
238 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200239 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200240 p = skipwhite(p);
241 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200242 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200243 {
244 if (ga_grow(default_args, 1) == FAIL)
245 goto err_ret;
246
247 // trim trailing whitespace
248 while (p > expr && VIM_ISWHITE(p[-1]))
249 p--;
250 c = *p;
251 *p = NUL;
252 expr = vim_strsave(expr);
253 if (expr == NULL)
254 {
255 *p = c;
256 goto err_ret;
257 }
258 ((char_u **)(default_args->ga_data))
259 [default_args->ga_len] = expr;
260 default_args->ga_len++;
261 *p = c;
262 }
263 else
264 mustend = TRUE;
265 }
266 else if (any_default)
267 {
268 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200269 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200272 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200273 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200274 // Don't give this error when skipping, it makes the "->" not
275 // found in "{k,v -> x}" and give a confusing error.
276 if (!skip && in_vim9script()
277 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
278 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200279 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200280 goto err_ret;
281 }
282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200283 else
284 mustend = TRUE;
285 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200286 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200287 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200288 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200289
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200290 if (*p != endchar)
291 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100292 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200293
294 *argp = p;
295 return OK;
296
297err_ret:
298 if (newargs != NULL)
299 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200300 if (default_args != NULL)
301 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200302 return FAIL;
303}
304
305/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200306 * Register function "fp" as using "current_funccal" as its scope.
307 */
308 static int
309register_closure(ufunc_T *fp)
310{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200311 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100312 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200313 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200314 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200315 fp->uf_scoped = current_funccal;
316 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200317
Bram Moolenaar58016442016-07-31 18:30:22 +0200318 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
319 return FAIL;
320 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
321 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200322 return OK;
323}
324
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100325 static void
326set_ufunc_name(ufunc_T *fp, char_u *name)
327{
328 STRCPY(fp->uf_name, name);
329
330 if (name[0] == K_SPECIAL)
331 {
332 fp->uf_name_exp = alloc(STRLEN(name) + 3);
333 if (fp->uf_name_exp != NULL)
334 {
335 STRCPY(fp->uf_name_exp, "<SNR>");
336 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
337 }
338 }
339}
340
Bram Moolenaar58016442016-07-31 18:30:22 +0200341/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200342 * Get a name for a lambda. Returned in static memory.
343 */
344 char_u *
345get_lambda_name(void)
346{
347 static char_u name[30];
348 static int lambda_no = 0;
349
350 sprintf((char*)name, "<lambda>%d", ++lambda_no);
351 return name;
352}
353
Bram Moolenaar801ab062020-06-25 19:27:56 +0200354#if defined(FEAT_LUA) || defined(PROTO)
355/*
356 * Registers a native C callback which can be called from Vim script.
357 * Returns the name of the Vim script function.
358 */
359 char_u *
360register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
361{
362 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200363 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200364
365 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
366 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200367 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200368
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200369 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200370 fp->uf_refcount = 1;
371 fp->uf_varargs = TRUE;
372 fp->uf_flags = FC_CFUNC;
373 fp->uf_calls = 0;
374 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200375 fp->uf_cb = cb;
376 fp->uf_cb_free = cb_free;
377 fp->uf_cb_state = state;
378
379 set_ufunc_name(fp, name);
380 hash_add(&func_hashtab, UF2HIKEY(fp));
381
382 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200383}
384#endif
385
Bram Moolenaar04b12692020-05-04 23:24:44 +0200386/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200387 * Parse a lambda expression and get a Funcref from "*arg".
388 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
389 */
390 int
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200391get_lambda_tv(char_u **arg, typval_T *rettv, evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200392{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200393 int evaluate = evalarg != NULL
394 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200395 garray_T newargs;
396 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200397 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200398 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100399 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200400 int varargs;
401 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200402 char_u *s;
403 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200404 int *old_eval_lavars = eval_lavars_used;
405 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200406 char_u *tofree = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200407
408 ga_init(&newargs);
409 ga_init(&newlines);
410
Bram Moolenaare38eab22019-12-05 21:50:01 +0100411 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200412 s = skipwhite(*arg + 1);
413 ret = get_function_args(&s, '-', NULL, NULL, NULL, NULL, TRUE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200414 NULL, NULL);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200415 if (ret == FAIL || *s != '>')
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200416 return NOTDONE;
417
Bram Moolenaare38eab22019-12-05 21:50:01 +0100418 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200419 if (evaluate)
420 pnewargs = &newargs;
421 else
422 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200423 *arg = skipwhite(*arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100424 // TODO: argument types
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200425 ret = get_function_args(arg, '-', pnewargs, NULL, &varargs, NULL, FALSE,
426 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200427 if (ret == FAIL || **arg != '>')
428 goto errret;
429
Bram Moolenaare38eab22019-12-05 21:50:01 +0100430 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200431 if (evaluate)
432 eval_lavars_used = &eval_lavars;
433
Bram Moolenaare38eab22019-12-05 21:50:01 +0100434 // Get the start and the end of the expression.
Bram Moolenaar9215f012020-06-27 21:18:00 +0200435 *arg = skipwhite_and_linebreak(*arg + 1, evalarg);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200436 start = *arg;
437 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200438 if (ret == FAIL)
439 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200440 if (evalarg != NULL)
441 {
442 // avoid that the expression gets freed when another line break follows
443 tofree = evalarg->eval_tofree;
444 evalarg->eval_tofree = NULL;
445 }
446
Bram Moolenaar9215f012020-06-27 21:18:00 +0200447 *arg = skipwhite_and_linebreak(*arg, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200448 if (**arg != '}')
Bram Moolenaaree619e52020-03-28 21:38:06 +0100449 {
450 semsg(_("E451: Expected }: %s"), *arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200451 goto errret;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200453 ++*arg;
454
455 if (evaluate)
456 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200457 int len;
458 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200459 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200460 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200461
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200462 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200463 if (fp == NULL)
464 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200465 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200466 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200467 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200468 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200469
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200470 ga_init2(&newlines, (int)sizeof(char_u *), 1);
471 if (ga_grow(&newlines, 1) == FAIL)
472 goto errret;
473
Bram Moolenaare38eab22019-12-05 21:50:01 +0100474 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200475 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200476 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200477 if (p == NULL)
478 goto errret;
479 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
480 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200481 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200482 if (strstr((char *)p + 7, "a:") == NULL)
483 // No a: variables are used for sure.
484 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200485
486 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100487 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200488 hash_add(&func_hashtab, UF2HIKEY(fp));
489 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200490 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200491 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200492 if (current_funccal != NULL && eval_lavars)
493 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200494 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200496 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200497 }
498 else
499 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200500
501#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200502 if (prof_def_func())
503 func_do_profile(fp);
504#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200505 if (sandbox)
506 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100507 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200508 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200509 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200510 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200511 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100512 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200513
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200514 pt->pt_func = fp;
515 pt->pt_refcount = 1;
516 rettv->vval.v_partial = pt;
517 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200519
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200520 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200521 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200522 evalarg->eval_tofree = tofree;
523 else
524 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200525 return OK;
526
527errret:
528 ga_clear_strings(&newargs);
529 ga_clear_strings(&newlines);
530 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100531 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200532 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200533 evalarg->eval_tofree = tofree;
534 else
535 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200536 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 return FAIL;
538}
539
540/*
541 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
542 * name it contains, otherwise return "name".
543 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
544 * "partialp".
545 */
546 char_u *
547deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
548{
549 dictitem_T *v;
550 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200551 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200552
553 if (partialp != NULL)
554 *partialp = NULL;
555
556 cc = name[*lenp];
557 name[*lenp] = NUL;
558 v = find_var(name, NULL, no_autoload);
559 name[*lenp] = cc;
560 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
561 {
562 if (v->di_tv.vval.v_string == NULL)
563 {
564 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100565 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200566 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200567 s = v->di_tv.vval.v_string;
568 *lenp = (int)STRLEN(s);
569 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200570 }
571
572 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
573 {
574 partial_T *pt = v->di_tv.vval.v_partial;
575
576 if (pt == NULL)
577 {
578 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100579 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200580 }
581 if (partialp != NULL)
582 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200583 s = partial_name(pt);
584 *lenp = (int)STRLEN(s);
585 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200586 }
587
588 return name;
589}
590
591/*
592 * Give an error message with a function name. Handle <SNR> things.
593 * "ermsg" is to be passed without translation, use N_() instead of _().
594 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100595 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200596emsg_funcname(char *ermsg, char_u *name)
597{
598 char_u *p;
599
600 if (*name == K_SPECIAL)
601 p = concat_str((char_u *)"<SNR>", name + 3);
602 else
603 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100604 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200605 if (p != name)
606 vim_free(p);
607}
608
609/*
610 * Allocate a variable for the result of a function.
611 * Return OK or FAIL.
612 */
613 int
614get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200615 char_u *name, // name of the function
616 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200617 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200618 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200619 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200620 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200621{
622 char_u *argp;
623 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100624 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
625 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200626 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200627
628 /*
629 * Get the arguments.
630 */
631 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200632 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
633 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200634 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200635 // skip the '(' or ',' and possibly line breaks
636 argp = skipwhite_and_linebreak(argp + 1, evalarg);
637
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200638 if (*argp == ')' || *argp == ',' || *argp == NUL)
639 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200640 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200641 {
642 ret = FAIL;
643 break;
644 }
645 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200646 // The comma should come right after the argument, but this wasn't
647 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200648 if (vim9script)
649 {
650 if (*argp != ',' && *skipwhite(argp) == ',')
651 {
652 semsg(_(e_no_white_space_allowed_before_str), ",");
653 ret = FAIL;
654 break;
655 }
656 }
657 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200658 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200659 if (*argp != ',')
660 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200661 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
662 {
663 semsg(_(e_white_space_required_after_str), ",");
664 ret = FAIL;
665 break;
666 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200667 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200668 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200669 if (*argp == ')')
670 ++argp;
671 else
672 ret = FAIL;
673
674 if (ret == OK)
675 {
676 int i = 0;
677
678 if (get_vim_var_nr(VV_TESTING))
679 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100680 // Prepare for calling test_garbagecollect_now(), need to know
681 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200682 if (funcargs.ga_itemsize == 0)
683 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
684 for (i = 0; i < argcount; ++i)
685 if (ga_grow(&funcargs, 1) == OK)
686 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
687 &argvars[i];
688 }
689
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200690 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691
692 funcargs.ga_len -= i;
693 }
694 else if (!aborting())
695 {
696 if (argcount == MAX_FUNC_ARGS)
697 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
698 else
699 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
700 }
701
702 while (--argcount >= 0)
703 clear_tv(&argvars[argcount]);
704
Bram Moolenaar8294d492020-08-10 22:40:56 +0200705 if (in_vim9script())
706 *arg = argp;
707 else
708 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200709 return ret;
710}
711
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200712/*
713 * Return TRUE if "p" starts with "<SID>" or "s:".
714 * Only works if eval_fname_script() returned non-zero for "p"!
715 */
716 static int
717eval_fname_sid(char_u *p)
718{
719 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
720}
721
722/*
723 * In a script change <SID>name() and s:name() to K_SNR 123_name().
724 * Change <SNR>123_name() to K_SNR 123_name().
725 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
726 * (slow).
727 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100728 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200729fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
730{
731 int llen;
732 char_u *fname;
733 int i;
734
735 llen = eval_fname_script(name);
736 if (llen > 0)
737 {
738 fname_buf[0] = K_SPECIAL;
739 fname_buf[1] = KS_EXTRA;
740 fname_buf[2] = (int)KE_SNR;
741 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100742 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200743 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200744 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100745 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200746 else
747 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200748 sprintf((char *)fname_buf + 3, "%ld_",
749 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200750 i = (int)STRLEN(fname_buf);
751 }
752 }
753 if (i + STRLEN(name + llen) < FLEN_FIXED)
754 {
755 STRCPY(fname_buf + i, name + llen);
756 fname = fname_buf;
757 }
758 else
759 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200760 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200761 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100762 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200763 else
764 {
765 *tofree = fname;
766 mch_memmove(fname, fname_buf, (size_t)i);
767 STRCPY(fname + i, name + llen);
768 }
769 }
770 }
771 else
772 fname = name;
773 return fname;
774}
775
776/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100777 * Find a function "name" in script "sid".
778 */
779 static ufunc_T *
780find_func_with_sid(char_u *name, int sid)
781{
782 hashitem_T *hi;
783 char_u buffer[200];
784
785 buffer[0] = K_SPECIAL;
786 buffer[1] = KS_EXTRA;
787 buffer[2] = (int)KE_SNR;
788 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
789 (long)sid, name);
790 hi = hash_find(&func_hashtab, buffer);
791 if (!HASHITEM_EMPTY(hi))
792 return HI2UF(hi);
793
794 return NULL;
795}
796
797/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200798 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200799 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200800 * Return NULL for unknown function.
801 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200802 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200803find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200804{
805 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100806 ufunc_T *func;
807 imported_T *imported;
808
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200809 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100810 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200811 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200812 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +0200813 int find_script_local = in_vim9script()
814 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100815
Bram Moolenaar95006e32020-08-29 17:47:08 +0200816 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100817 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200818 // Find script-local function before global one.
819 func = find_func_with_sid(name, current_sctx.sc_sid);
820 if (func != NULL)
821 return func;
822 }
823
Bram Moolenaarefa94442020-08-08 22:16:00 +0200824 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200825 && name[1] == KS_EXTRA
826 && name[2] == KE_SNR)
827 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200828 // Caller changes s: to <SNR>99_name.
829
830 after_script = name + 3;
831 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200832 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200833 ++after_script;
834 else
835 after_script = NULL;
836 }
Bram Moolenaar95006e32020-08-29 17:47:08 +0200837 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200838 {
839 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200840 if (after_script != NULL && sid != current_sctx.sc_sid)
841 imported = find_imported_in_script(after_script, 0, sid);
842 else
843 imported = find_imported(after_script == NULL
844 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200845 if (imported != NULL && imported->imp_funcname != NULL)
846 {
847 hi = hash_find(&func_hashtab, imported->imp_funcname);
848 if (!HASHITEM_EMPTY(hi))
849 return HI2UF(hi);
850 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100851 }
852 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200853
Bram Moolenaara26b9702020-04-18 19:53:28 +0200854 hi = hash_find(&func_hashtab,
855 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200856 if (!HASHITEM_EMPTY(hi))
857 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100858
859 return NULL;
860}
861
862/*
863 * Find a function by name, return pointer to it in ufuncs.
864 * "cctx" is passed in a :def function to find imported functions.
865 * Return NULL for unknown or dead function.
866 */
867 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200868find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100869{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200870 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100871
872 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
873 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200874 return NULL;
875}
876
877/*
878 * Copy the function name of "fp" to buffer "buf".
879 * "buf" must be able to hold the function name plus three bytes.
880 * Takes care of script-local function names.
881 */
882 static void
883cat_func_name(char_u *buf, ufunc_T *fp)
884{
885 if (fp->uf_name[0] == K_SPECIAL)
886 {
887 STRCPY(buf, "<SNR>");
888 STRCAT(buf, fp->uf_name + 3);
889 }
890 else
891 STRCPY(buf, fp->uf_name);
892}
893
894/*
895 * Add a number variable "name" to dict "dp" with value "nr".
896 */
897 static void
898add_nr_var(
899 dict_T *dp,
900 dictitem_T *v,
901 char *name,
902 varnumber_T nr)
903{
904 STRCPY(v->di_key, name);
905 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
906 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
907 v->di_tv.v_type = VAR_NUMBER;
908 v->di_tv.v_lock = VAR_FIXED;
909 v->di_tv.vval.v_number = nr;
910}
911
912/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100913 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200914 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100915 static void
916free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200917{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100918 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200919
920 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
921 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100922 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200923
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100924 // When garbage collecting a funccall_T may be freed before the
925 // function that references it, clear its uf_scoped field.
926 // The function may have been redefined and point to another
927 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200928 if (fp != NULL && fp->uf_scoped == fc)
929 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200930 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200931 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200932
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200933 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200934 vim_free(fc);
935}
936
937/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100938 * Free "fc" and what it contains.
939 * Can be called only when "fc" is kept beyond the period of it called,
940 * i.e. after cleanup_function_call(fc).
941 */
942 static void
943free_funccal_contents(funccall_T *fc)
944{
945 listitem_T *li;
946
947 // Free all l: variables.
948 vars_clear(&fc->l_vars.dv_hashtab);
949
950 // Free all a: variables.
951 vars_clear(&fc->l_avars.dv_hashtab);
952
953 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200954 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100955 clear_tv(&li->li_tv);
956
957 free_funccal(fc);
958}
959
960/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200961 * Handle the last part of returning from a function: free the local hashtable.
962 * Unless it is still in use by a closure.
963 */
964 static void
965cleanup_function_call(funccall_T *fc)
966{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100967 int may_free_fc = fc->fc_refcount <= 0;
968 int free_fc = TRUE;
969
Bram Moolenaar6914c642017-04-01 21:21:30 +0200970 current_funccal = fc->caller;
971
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100972 // Free all l: variables if not referred.
973 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
974 vars_clear(&fc->l_vars.dv_hashtab);
975 else
976 free_fc = FALSE;
977
978 // If the a:000 list and the l: and a: dicts are not referenced and
979 // there is no closure using it, we can free the funccall_T and what's
980 // in it.
981 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
982 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200983 else
984 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100985 int todo;
986 hashitem_T *hi;
987 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200988
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100989 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200990
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100991 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200992 todo = (int)fc->l_avars.dv_hashtab.ht_used;
993 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
994 {
995 if (!HASHITEM_EMPTY(hi))
996 {
997 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100998 di = HI2DI(hi);
999 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001000 }
1001 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001002 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001003
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001004 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1005 fc->l_varlist.lv_first = NULL;
1006 else
1007 {
1008 listitem_T *li;
1009
1010 free_fc = FALSE;
1011
1012 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001013 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001014 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001015 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001016
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001017 if (free_fc)
1018 free_funccal(fc);
1019 else
1020 {
1021 static int made_copy = 0;
1022
1023 // "fc" is still in use. This can happen when returning "a:000",
1024 // assigning "l:" to a global variable or defining a closure.
1025 // Link "fc" in the list for garbage collection later.
1026 fc->caller = previous_funccal;
1027 previous_funccal = fc;
1028
1029 if (want_garbage_collect)
1030 // If garbage collector is ready, clear count.
1031 made_copy = 0;
1032 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001033 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001034 // We have made a lot of copies, worth 4 Mbyte. This can happen
1035 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001036 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001037 // too much memory.
1038 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001039 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001040 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001041 }
1042}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001043/*
1044 * Unreference "fc": decrement the reference count and free it when it
1045 * becomes zero. "fp" is detached from "fc".
1046 * When "force" is TRUE we are exiting.
1047 */
1048 static void
1049funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1050{
1051 funccall_T **pfc;
1052 int i;
1053
1054 if (fc == NULL)
1055 return;
1056
1057 if (--fc->fc_refcount <= 0 && (force || (
1058 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1059 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1060 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1061 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1062 {
1063 if (fc == *pfc)
1064 {
1065 *pfc = fc->caller;
1066 free_funccal_contents(fc);
1067 return;
1068 }
1069 }
1070 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1071 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1072 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1073}
1074
1075/*
1076 * Remove the function from the function hashtable. If the function was
1077 * deleted while it still has references this was already done.
1078 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1079 */
1080 static int
1081func_remove(ufunc_T *fp)
1082{
1083 hashitem_T *hi;
1084
1085 // Return if it was already virtually deleted.
1086 if (fp->uf_flags & FC_DEAD)
1087 return FALSE;
1088
1089 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1090 if (!HASHITEM_EMPTY(hi))
1091 {
1092 // When there is a def-function index do not actually remove the
1093 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001094 // Do remove it when it's a copy.
1095 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001096 fp->uf_flags |= FC_DEAD;
1097 else
1098 hash_remove(&func_hashtab, hi);
1099 return TRUE;
1100 }
1101 return FALSE;
1102}
1103
1104 static void
1105func_clear_items(ufunc_T *fp)
1106{
1107 ga_clear_strings(&(fp->uf_args));
1108 ga_clear_strings(&(fp->uf_def_args));
1109 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001110 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001111 VIM_CLEAR(fp->uf_def_arg_idx);
1112 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001113 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001114
1115#ifdef FEAT_LUA
1116 if (fp->uf_cb_free != NULL)
1117 {
1118 fp->uf_cb_free(fp->uf_cb_state);
1119 fp->uf_cb_free = NULL;
1120 }
1121
1122 fp->uf_cb_state = NULL;
1123 fp->uf_cb = NULL;
1124#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001125#ifdef FEAT_PROFILE
1126 VIM_CLEAR(fp->uf_tml_count);
1127 VIM_CLEAR(fp->uf_tml_total);
1128 VIM_CLEAR(fp->uf_tml_self);
1129#endif
1130}
1131
1132/*
1133 * Free all things that a function contains. Does not free the function
1134 * itself, use func_free() for that.
1135 * When "force" is TRUE we are exiting.
1136 */
1137 static void
1138func_clear(ufunc_T *fp, int force)
1139{
1140 if (fp->uf_cleared)
1141 return;
1142 fp->uf_cleared = TRUE;
1143
1144 // clear this function
1145 func_clear_items(fp);
1146 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001147 if ((fp->uf_flags & FC_COPY) == 0)
1148 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001149}
1150
1151/*
1152 * Free a function and remove it from the list of functions. Does not free
1153 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001154 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001155 */
1156 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001157func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001158{
1159 // Only remove it when not done already, otherwise we would remove a newer
1160 // version of the function with the same name.
1161 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1162 func_remove(fp);
1163
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001164 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001165 {
1166 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001167 vim_free(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001168 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001169}
1170
1171/*
1172 * Free all things that a function contains and free the function itself.
1173 * When "force" is TRUE we are exiting.
1174 */
1175 static void
1176func_clear_free(ufunc_T *fp, int force)
1177{
1178 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001179 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001180 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001181 else
1182 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001183}
1184
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001185/*
1186 * Copy already defined function "lambda" to a new function with name "global".
1187 * This is for when a compiled function defines a global function.
1188 */
1189 void
1190copy_func(char_u *lambda, char_u *global)
1191{
1192 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1193 ufunc_T *fp;
1194
1195 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001196 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001197 else
1198 {
1199 // TODO: handle ! to overwrite
1200 fp = find_func(global, TRUE, NULL);
1201 if (fp != NULL)
1202 {
1203 semsg(_(e_funcexts), global);
1204 return;
1205 }
1206
1207 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1208 if (fp == NULL)
1209 return;
1210
1211 fp->uf_varargs = ufunc->uf_varargs;
1212 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1213 fp->uf_def_status = ufunc->uf_def_status;
1214 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001215 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1216 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001217 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001218 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001219 goto failed;
1220
1221 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1222 : vim_strsave(ufunc->uf_name_exp);
1223 if (ufunc->uf_arg_types != NULL)
1224 {
1225 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1226 if (fp->uf_arg_types == NULL)
1227 goto failed;
1228 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1229 sizeof(type_T *) * fp->uf_args.ga_len);
1230 }
1231 if (ufunc->uf_def_arg_idx != NULL)
1232 {
1233 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1234 if (fp->uf_def_arg_idx == NULL)
1235 goto failed;
1236 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1237 sizeof(int) * fp->uf_def_args.ga_len + 1);
1238 }
1239 if (ufunc->uf_va_name != NULL)
1240 {
1241 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1242 if (fp->uf_va_name == NULL)
1243 goto failed;
1244 }
1245
1246 fp->uf_refcount = 1;
1247 STRCPY(fp->uf_name, global);
1248 hash_add(&func_hashtab, UF2HIKEY(fp));
1249 }
1250 return;
1251
1252failed:
1253 func_clear_free(fp, TRUE);
1254}
1255
Bram Moolenaar6914c642017-04-01 21:21:30 +02001256
1257/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001258 * Call a user function.
1259 */
1260 static void
1261call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001262 ufunc_T *fp, // pointer to function
1263 int argcount, // nr of args
1264 typval_T *argvars, // arguments
1265 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001266 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001267 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001268{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001269 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001270 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001271 funccall_T *fc;
1272 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001273 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 static int depth = 0;
1275 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001276 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001277 int i;
1278 int ai;
1279 int islambda = FALSE;
1280 char_u numbuf[NUMBUFLEN];
1281 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001282#ifdef FEAT_PROFILE
1283 proftime_T wait_start;
1284 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001285 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001287 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288
Bram Moolenaare38eab22019-12-05 21:50:01 +01001289 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001290 if (depth >= p_mfd)
1291 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001292 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293 rettv->v_type = VAR_NUMBER;
1294 rettv->vval.v_number = -1;
1295 return;
1296 }
1297 ++depth;
1298
Bram Moolenaare38eab22019-12-05 21:50:01 +01001299 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001300
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001301 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001302 if (fc == NULL)
1303 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001304 fc->caller = current_funccal;
1305 current_funccal = fc;
1306 fc->func = fp;
1307 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001308 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001309 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001310 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1311 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001312 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001313 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001314 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001315
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001316 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001317 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001318 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001319 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001320 --depth;
1321 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001322 free_funccal(fc);
1323 return;
1324 }
1325
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1327 islambda = TRUE;
1328
1329 /*
1330 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1331 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1332 * each argument variable and saves a lot of time.
1333 */
1334 /*
1335 * Init l: variables.
1336 */
1337 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1338 if (selfdict != NULL)
1339 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001340 // Set l:self to "selfdict". Use "name" to avoid a warning from
1341 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001342 v = &fc->fixvar[fixvar_idx++].var;
1343 name = v->di_key;
1344 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001345 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001346 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1347 v->di_tv.v_type = VAR_DICT;
1348 v->di_tv.v_lock = 0;
1349 v->di_tv.vval.v_dict = selfdict;
1350 ++selfdict->dv_refcount;
1351 }
1352
1353 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001354 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001355 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 * Set a:000 to a list with room for the "..." arguments.
1357 */
1358 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001359 if ((fp->uf_flags & FC_NOARGS) == 0)
1360 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001361 (varnumber_T)(argcount >= fp->uf_args.ga_len
1362 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001363 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001364 if ((fp->uf_flags & FC_NOARGS) == 0)
1365 {
1366 // Use "name" to avoid a warning from some compiler that checks the
1367 // destination size.
1368 v = &fc->fixvar[fixvar_idx++].var;
1369 name = v->di_key;
1370 STRCPY(name, "000");
1371 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1372 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1373 v->di_tv.v_type = VAR_LIST;
1374 v->di_tv.v_lock = VAR_FIXED;
1375 v->di_tv.vval.v_list = &fc->l_varlist;
1376 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001377 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001378 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1379 fc->l_varlist.lv_lock = VAR_FIXED;
1380
1381 /*
1382 * Set a:firstline to "firstline" and a:lastline to "lastline".
1383 * Set a:name to named arguments.
1384 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001385 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001386 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001387 if ((fp->uf_flags & FC_NOARGS) == 0)
1388 {
1389 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001390 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001391 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001392 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001393 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001394 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001395 {
1396 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001397 typval_T def_rettv;
1398 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399
1400 ai = i - fp->uf_args.ga_len;
1401 if (ai < 0)
1402 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001403 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404 name = FUNCARG(fp, i);
1405 if (islambda)
1406 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001407
1408 // evaluate named argument default expression
1409 isdefault = ai + fp->uf_def_args.ga_len >= 0
1410 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1411 && argvars[i].vval.v_number == VVAL_NONE));
1412 if (isdefault)
1413 {
1414 char_u *default_expr = NULL;
1415 def_rettv.v_type = VAR_NUMBER;
1416 def_rettv.vval.v_number = -1;
1417
1418 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1419 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001420 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001421 {
1422 default_arg_err = 1;
1423 break;
1424 }
1425 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001426 }
1427 else
1428 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001429 if ((fp->uf_flags & FC_NOARGS) != 0)
1430 // Bail out if no a: arguments used (in lambda).
1431 break;
1432
Bram Moolenaare38eab22019-12-05 21:50:01 +01001433 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434 sprintf((char *)numbuf, "%d", ai + 1);
1435 name = numbuf;
1436 }
1437 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1438 {
1439 v = &fc->fixvar[fixvar_idx++].var;
1440 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001441 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442 }
1443 else
1444 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001445 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001446 if (v == NULL)
1447 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001448 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001451 // Note: the values are copied directly to avoid alloc/free.
1452 // "argvars" must have VAR_FIXED for v_lock.
1453 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454 v->di_tv.v_lock = VAR_FIXED;
1455
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456 if (addlocal)
1457 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001458 // Named arguments should be accessed without the "a:" prefix in
1459 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001460 copy_tv(&v->di_tv, &v->di_tv);
1461 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001463 else
1464 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465
1466 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1467 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001468 listitem_T *li = &fc->l_listitems[ai];
1469
1470 li->li_tv = argvars[i];
1471 li->li_tv.v_lock = VAR_FIXED;
1472 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001473 }
1474 }
1475
Bram Moolenaare38eab22019-12-05 21:50:01 +01001476 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001478
1479 if (fp->uf_flags & FC_SANDBOX)
1480 {
1481 using_sandbox = TRUE;
1482 ++sandbox;
1483 }
1484
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001485 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001486 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001487 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001489 ++no_wait_return;
1490 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001491
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001492 smsg(_("calling %s"), SOURCING_NAME);
1493 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001495 char_u buf[MSG_BUF_LEN];
1496 char_u numbuf2[NUMBUFLEN];
1497 char_u *tofree;
1498 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001500 msg_puts("(");
1501 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001502 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001503 if (i > 0)
1504 msg_puts(", ");
1505 if (argvars[i].v_type == VAR_NUMBER)
1506 msg_outnum((long)argvars[i].vval.v_number);
1507 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001509 // Do not want errors such as E724 here.
1510 ++emsg_off;
1511 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1512 --emsg_off;
1513 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001515 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001517 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1518 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001520 msg_puts((char *)s);
1521 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 }
1523 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001525 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001527 msg_puts("\n"); // don't overwrite this either
1528
1529 verbose_leave_scroll();
1530 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 }
1532#ifdef FEAT_PROFILE
1533 if (do_profiling == PROF_YES)
1534 {
1535 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001536 {
1537 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001538 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001539 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 if (fp->uf_profiling
1541 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1542 {
1543 ++fp->uf_tm_count;
1544 profile_start(&call_start);
1545 profile_zero(&fp->uf_tm_children);
1546 }
1547 script_prof_save(&wait_start);
1548 }
1549#endif
1550
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001551 save_current_sctx = current_sctx;
1552 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 save_did_emsg = did_emsg;
1554 did_emsg = FALSE;
1555
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001556 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1557 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001558 else if (islambda)
1559 {
1560 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1561
1562 // A Lambda always has the command "return {expr}". It is much faster
1563 // to evaluate {expr} directly.
1564 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001565 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001566 --ex_nesting_level;
1567 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001568 else
1569 // call do_cmdline() to execute the lines
1570 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1572
1573 --RedrawingDisabled;
1574
Bram Moolenaare38eab22019-12-05 21:50:01 +01001575 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1577 {
1578 clear_tv(rettv);
1579 rettv->v_type = VAR_NUMBER;
1580 rettv->vval.v_number = -1;
1581 }
1582
1583#ifdef FEAT_PROFILE
1584 if (do_profiling == PROF_YES && (fp->uf_profiling
1585 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1586 {
1587 profile_end(&call_start);
1588 profile_sub_wait(&wait_start, &call_start);
1589 profile_add(&fp->uf_tm_total, &call_start);
1590 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1591 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1592 {
1593 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1594 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1595 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001596 if (started_profiling)
1597 // make a ":profdel func" stop profiling the function
1598 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 }
1600#endif
1601
Bram Moolenaare38eab22019-12-05 21:50:01 +01001602 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 if (p_verbose >= 12)
1604 {
1605 ++no_wait_return;
1606 verbose_enter_scroll();
1607
1608 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001609 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001611 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 (long)fc->rettv->vval.v_number);
1613 else
1614 {
1615 char_u buf[MSG_BUF_LEN];
1616 char_u numbuf2[NUMBUFLEN];
1617 char_u *tofree;
1618 char_u *s;
1619
Bram Moolenaare38eab22019-12-05 21:50:01 +01001620 // The value may be very long. Skip the middle part, so that we
1621 // have some idea how it starts and ends. smsg() would always
1622 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 ++emsg_off;
1624 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1625 --emsg_off;
1626 if (s != NULL)
1627 {
1628 if (vim_strsize(s) > MSG_BUF_CLEN)
1629 {
1630 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1631 s = buf;
1632 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001633 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 vim_free(tofree);
1635 }
1636 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001637 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638
1639 verbose_leave_scroll();
1640 --no_wait_return;
1641 }
1642
Bram Moolenaare31ee862020-01-07 20:59:34 +01001643 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001644 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001645 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001646#ifdef FEAT_PROFILE
1647 if (do_profiling == PROF_YES)
1648 script_prof_restore(&wait_start);
1649#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001650 if (using_sandbox)
1651 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001653 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 {
1655 ++no_wait_return;
1656 verbose_enter_scroll();
1657
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001658 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001659 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660
1661 verbose_leave_scroll();
1662 --no_wait_return;
1663 }
1664
1665 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001666 --depth;
1667
Bram Moolenaar6914c642017-04-01 21:21:30 +02001668 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001669}
1670
1671/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001672 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001673 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001674 int
1675call_user_func_check(
1676 ufunc_T *fp,
1677 int argcount,
1678 typval_T *argvars,
1679 typval_T *rettv,
1680 funcexe_T *funcexe,
1681 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001682{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001683 int error;
1684 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001685
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001686 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1687 *funcexe->doesrange = TRUE;
1688 if (argcount < regular_args - fp->uf_def_args.ga_len)
1689 error = FCERR_TOOFEW;
1690 else if (!has_varargs(fp) && argcount > regular_args)
1691 error = FCERR_TOOMANY;
1692 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1693 error = FCERR_DICT;
1694 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001695 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001696 int did_save_redo = FALSE;
1697 save_redo_T save_redo;
1698
1699 /*
1700 * Call the user function.
1701 * Save and restore search patterns, script variables and
1702 * redo buffer.
1703 */
1704 save_search_patterns();
1705 if (!ins_compl_active())
1706 {
1707 saveRedobuff(&save_redo);
1708 did_save_redo = TRUE;
1709 }
1710 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001711 call_user_func(fp, argcount, argvars, rettv, funcexe,
1712 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001713 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1714 // Function was unreferenced while being used, free it now.
1715 func_clear_free(fp, FALSE);
1716 if (did_save_redo)
1717 restoreRedobuff(&save_redo);
1718 restore_search_patterns();
1719 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001720 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001721 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001722}
1723
1724/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001725 * There are two kinds of function names:
1726 * 1. ordinary names, function defined with :function
1727 * 2. numbered functions and lambdas
1728 * For the first we only count the name stored in func_hashtab as a reference,
1729 * using function() does not count as a reference, because the function is
1730 * looked up by name.
1731 */
1732 static int
1733func_name_refcount(char_u *name)
1734{
1735 return isdigit(*name) || *name == '<';
1736}
1737
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001738static funccal_entry_T *funccal_stack = NULL;
1739
1740/*
1741 * Save the current function call pointer, and set it to NULL.
1742 * Used when executing autocommands and for ":source".
1743 */
1744 void
1745save_funccal(funccal_entry_T *entry)
1746{
1747 entry->top_funccal = current_funccal;
1748 entry->next = funccal_stack;
1749 funccal_stack = entry;
1750 current_funccal = NULL;
1751}
1752
1753 void
1754restore_funccal(void)
1755{
1756 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001757 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001758 else
1759 {
1760 current_funccal = funccal_stack->top_funccal;
1761 funccal_stack = funccal_stack->next;
1762 }
1763}
1764
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001765 funccall_T *
1766get_current_funccal(void)
1767{
1768 return current_funccal;
1769}
1770
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001771/*
1772 * Mark all functions of script "sid" as deleted.
1773 */
1774 void
1775delete_script_functions(int sid)
1776{
1777 hashitem_T *hi;
1778 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001779 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001780 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001781 size_t len;
1782
1783 buf[0] = K_SPECIAL;
1784 buf[1] = KS_EXTRA;
1785 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001786 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001787 len = STRLEN(buf);
1788
Bram Moolenaarce658352020-07-31 23:47:12 +02001789 while (todo > 0)
1790 {
1791 todo = func_hashtab.ht_used;
1792 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1793 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001794 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001795 fp = HI2UF(hi);
1796 if (STRNCMP(fp->uf_name, buf, len) == 0)
1797 {
1798 int changed = func_hashtab.ht_changed;
1799
1800 fp->uf_flags |= FC_DEAD;
1801 func_clear(fp, TRUE);
1802 // When clearing a function another function can be cleared
1803 // as a side effect. When that happens start over.
1804 if (changed != func_hashtab.ht_changed)
1805 break;
1806 }
1807 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001808 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001809 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001810}
1811
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001812#if defined(EXITFREE) || defined(PROTO)
1813 void
1814free_all_functions(void)
1815{
1816 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001817 ufunc_T *fp;
1818 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001819 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001820 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821
Bram Moolenaare38eab22019-12-05 21:50:01 +01001822 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001823 while (current_funccal != NULL)
1824 {
1825 clear_tv(current_funccal->rettv);
1826 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001827 if (current_funccal == NULL && funccal_stack != NULL)
1828 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001829 }
1830
Bram Moolenaare38eab22019-12-05 21:50:01 +01001831 // First clear what the functions contain. Since this may lower the
1832 // reference count of a function, it may also free a function and change
1833 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001834 while (todo > 0)
1835 {
1836 todo = func_hashtab.ht_used;
1837 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1838 if (!HASHITEM_EMPTY(hi))
1839 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001840 // clear the def function index now
1841 fp = HI2UF(hi);
1842 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001843 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001844
Bram Moolenaare38eab22019-12-05 21:50:01 +01001845 // Only free functions that are not refcounted, those are
1846 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001847 if (func_name_refcount(fp->uf_name))
1848 ++skipped;
1849 else
1850 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001851 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001852 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001853 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001854 {
1855 skipped = 0;
1856 break;
1857 }
1858 }
1859 --todo;
1860 }
1861 }
1862
Bram Moolenaare38eab22019-12-05 21:50:01 +01001863 // Now actually free the functions. Need to start all over every time,
1864 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001865 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001866 while (func_hashtab.ht_used > skipped)
1867 {
1868 todo = func_hashtab.ht_used;
1869 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870 if (!HASHITEM_EMPTY(hi))
1871 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001872 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001873 // Only free functions that are not refcounted, those are
1874 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001875 fp = HI2UF(hi);
1876 if (func_name_refcount(fp->uf_name))
1877 ++skipped;
1878 else
1879 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001880 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001881 skipped = 0;
1882 break;
1883 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001885 }
1886 if (skipped == 0)
1887 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888
1889 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890}
1891#endif
1892
1893/*
1894 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001895 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 * "len" is the length of "name", or -1 for NUL terminated.
1897 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001898 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001899builtin_function(char_u *name, int len)
1900{
1901 char_u *p;
1902
Bram Moolenaara26b9702020-04-18 19:53:28 +02001903 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001904 return FALSE;
1905 p = vim_strchr(name, AUTOLOAD_CHAR);
1906 return p == NULL || (len > 0 && p > name + len);
1907}
1908
1909 int
1910func_call(
1911 char_u *name,
1912 typval_T *args,
1913 partial_T *partial,
1914 dict_T *selfdict,
1915 typval_T *rettv)
1916{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001917 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 listitem_T *item;
1919 typval_T argv[MAX_FUNC_ARGS + 1];
1920 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001921 int r = 0;
1922
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001923 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001924 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001925 {
1926 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1927 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001928 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001929 break;
1930 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001931 // Make a copy of each argument. This is needed to be able to set
1932 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001933 copy_tv(&item->li_tv, &argv[argc++]);
1934 }
1935
1936 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001937 {
1938 funcexe_T funcexe;
1939
Bram Moolenaara80faa82020-04-12 19:37:17 +02001940 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001941 funcexe.firstline = curwin->w_cursor.lnum;
1942 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001943 funcexe.evaluate = TRUE;
1944 funcexe.partial = partial;
1945 funcexe.selfdict = selfdict;
1946 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1947 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001948
Bram Moolenaare38eab22019-12-05 21:50:01 +01001949 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950 while (argc > 0)
1951 clear_tv(&argv[--argc]);
1952
1953 return r;
1954}
1955
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001956static int callback_depth = 0;
1957
1958 int
1959get_callback_depth(void)
1960{
1961 return callback_depth;
1962}
1963
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001964/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001965 * Invoke call_func() with a callback.
1966 */
1967 int
1968call_callback(
1969 callback_T *callback,
1970 int len, // length of "name" or -1 to use strlen()
1971 typval_T *rettv, // return value goes here
1972 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001973 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001974 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001975{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001976 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001977 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001978
Bram Moolenaara80faa82020-04-12 19:37:17 +02001979 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001980 funcexe.evaluate = TRUE;
1981 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001982 ++callback_depth;
1983 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1984 --callback_depth;
1985 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001986}
1987
1988/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001989 * Give an error message for the result of a function.
1990 * Nothing if "error" is FCERR_NONE.
1991 */
1992 void
1993user_func_error(int error, char_u *name)
1994{
1995 switch (error)
1996 {
1997 case FCERR_UNKNOWN:
1998 emsg_funcname(e_unknownfunc, name);
1999 break;
2000 case FCERR_NOTMETHOD:
2001 emsg_funcname(
2002 N_("E276: Cannot use function as a method: %s"), name);
2003 break;
2004 case FCERR_DELETED:
2005 emsg_funcname(N_(e_func_deleted), name);
2006 break;
2007 case FCERR_TOOMANY:
2008 emsg_funcname((char *)e_toomanyarg, name);
2009 break;
2010 case FCERR_TOOFEW:
2011 emsg_funcname((char *)e_toofewarg, name);
2012 break;
2013 case FCERR_SCRIPT:
2014 emsg_funcname(
2015 N_("E120: Using <SID> not in a script context: %s"), name);
2016 break;
2017 case FCERR_DICT:
2018 emsg_funcname(
2019 N_("E725: Calling dict function without Dictionary: %s"),
2020 name);
2021 break;
2022 }
2023}
2024
2025/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002026 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002027 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 * Return FAIL when the function can't be called, OK otherwise.
2029 * Also returns OK when an error was encountered while executing the function.
2030 */
2031 int
2032call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002033 char_u *funcname, // name of the function
2034 int len, // length of "name" or -1 to use strlen()
2035 typval_T *rettv, // return value goes here
2036 int argcount_in, // number of "argvars"
2037 typval_T *argvars_in, // vars for arguments, must have "argcount"
2038 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002039 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002040{
2041 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002042 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002043 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002044 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002045 char_u fname_buf[FLEN_FIXED + 1];
2046 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002047 char_u *fname = NULL;
2048 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002049 int argcount = argcount_in;
2050 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002051 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002052 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2053 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002054 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002055 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002056 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002057
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002058 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2059 // even when call_func() returns FAIL.
2060 rettv->v_type = VAR_UNKNOWN;
2061
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002062 if (partial != NULL)
2063 fp = partial->pt_func;
2064 if (fp == NULL)
2065 {
2066 // Make a copy of the name, if it comes from a funcref variable it
2067 // could be changed or deleted in the called function.
2068 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2069 if (name == NULL)
2070 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002071
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002072 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2073 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002074
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002075 if (funcexe->doesrange != NULL)
2076 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002077
2078 if (partial != NULL)
2079 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002080 // When the function has a partial with a dict and there is a dict
2081 // argument, use the dict argument. That is backwards compatible.
2082 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002083 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002084 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002085 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002086 {
2087 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002088 {
2089 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2090 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002091 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002092 goto theend;
2093 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002094 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002095 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002096 for (i = 0; i < argcount_in; ++i)
2097 argv[i + argv_clear] = argvars_in[i];
2098 argvars = argv;
2099 argcount = partial->pt_argc + argcount_in;
2100 }
2101 }
2102
Bram Moolenaaref140542019-12-31 21:27:13 +01002103 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104 {
2105 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002106 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002107
Bram Moolenaar333894b2020-08-01 18:53:07 +02002108 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002109 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002110 {
2111 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002113 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002114
Bram Moolenaare38eab22019-12-05 21:50:01 +01002115 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002117 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002118
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002119 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120 {
2121 /*
2122 * User defined function.
2123 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002124 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002125 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002126
Bram Moolenaare38eab22019-12-05 21:50:01 +01002127 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002128 if (fp == NULL
2129 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002130 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002131 && !aborting())
2132 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002133 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002134 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002135 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002136 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002137 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2138 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002139 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002140 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002142 if (fp == NULL)
2143 {
2144 char_u *p = untrans_function_name(rfname);
2145
2146 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002147 // Don't do this if the name starts with "s:".
2148 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002149 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002150 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002152 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002153 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002154#ifdef FEAT_LUA
2155 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2156 {
2157 cfunc_T cb = fp->uf_cb;
2158
2159 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2160 }
2161#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002162 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002163 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002164 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002165 // postponed filling in the arguments, do it now
2166 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002167 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002168
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002169 if (funcexe->basetv != NULL)
2170 {
2171 // Method call: base->Method()
2172 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2173 argv[0] = *funcexe->basetv;
2174 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002175 argvars = argv;
2176 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002177 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002178
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002179 error = call_user_func_check(fp, argcount, argvars, rettv,
2180 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002181 }
2182 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002183 else if (funcexe->basetv != NULL)
2184 {
2185 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002186 * expr->method(): Find the method name in the table, call its
2187 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002188 */
2189 error = call_internal_method(fname, argcount, argvars, rettv,
2190 funcexe->basetv);
2191 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002192 else
2193 {
2194 /*
2195 * Find the function name in the table, call its implementation.
2196 */
2197 error = call_internal_func(fname, argcount, argvars, rettv);
2198 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002199
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002200 /*
2201 * The function call (or "FuncUndefined" autocommand sequence) might
2202 * have been aborted by an error, an interrupt, or an explicitly thrown
2203 * exception that has not been caught so far. This situation can be
2204 * tested for by calling aborting(). For an error in an internal
2205 * function or for the "E132" error in call_user_func(), however, the
2206 * throw point at which the "force_abort" flag (temporarily reset by
2207 * emsg()) is normally updated has not been reached yet. We need to
2208 * update that flag first to make aborting() reliable.
2209 */
2210 update_force_abort();
2211 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002212 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002213 ret = OK;
2214
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002215theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002216 /*
2217 * Report an error unless the argument evaluation or function call has been
2218 * cancelled due to an aborting error, an interrupt, or an exception.
2219 */
2220 if (!aborting())
2221 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002222 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002223 }
2224
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002225 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002227 clear_tv(&argv[--argv_clear + argv_base]);
2228
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229 vim_free(tofree);
2230 vim_free(name);
2231
2232 return ret;
2233}
2234
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002235 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002236printable_func_name(ufunc_T *fp)
2237{
2238 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2239}
2240
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002242 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002243 */
2244 static void
2245list_func_head(ufunc_T *fp, int indent)
2246{
2247 int j;
2248
2249 msg_start();
2250 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002251 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002252 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002253 msg_puts("def ");
2254 else
2255 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002256 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002257 msg_putchar('(');
2258 for (j = 0; j < fp->uf_args.ga_len; ++j)
2259 {
2260 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002261 msg_puts(", ");
2262 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002263 if (fp->uf_arg_types != NULL)
2264 {
2265 char *tofree;
2266
2267 msg_puts(": ");
2268 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2269 vim_free(tofree);
2270 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002271 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2272 {
2273 msg_puts(" = ");
2274 msg_puts(((char **)(fp->uf_def_args.ga_data))
2275 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2276 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 }
2278 if (fp->uf_varargs)
2279 {
2280 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002281 msg_puts(", ");
2282 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002284 if (fp->uf_va_name != NULL)
2285 {
2286 if (j)
2287 msg_puts(", ");
2288 msg_puts("...");
2289 msg_puts((char *)fp->uf_va_name);
2290 if (fp->uf_va_type)
2291 {
2292 char *tofree;
2293
2294 msg_puts(": ");
2295 msg_puts(type_name(fp->uf_va_type, &tofree));
2296 vim_free(tofree);
2297 }
2298 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002299 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002300
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002301 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002302 {
2303 if (fp->uf_ret_type != &t_void)
2304 {
2305 char *tofree;
2306
2307 msg_puts(": ");
2308 msg_puts(type_name(fp->uf_ret_type, &tofree));
2309 vim_free(tofree);
2310 }
2311 }
2312 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002313 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002314 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002315 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002316 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002317 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002318 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002319 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320 msg_clr_eos();
2321 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002322 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002323}
2324
2325/*
2326 * Get a function name, translating "<SID>" and "<SNR>".
2327 * Also handles a Funcref in a List or Dictionary.
2328 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002329 * Set "*is_global" to TRUE when the function must be global, unless
2330 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331 * flags:
2332 * TFN_INT: internal function name OK
2333 * TFN_QUIET: be quiet
2334 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002335 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 * Advances "pp" to just after the function name (if no error).
2337 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002338 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002339trans_function_name(
2340 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002341 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002342 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002344 funcdict_T *fdp, // return: info about dictionary used
2345 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002346{
2347 char_u *name = NULL;
2348 char_u *start;
2349 char_u *end;
2350 int lead;
2351 char_u sid_buf[20];
2352 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002353 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002354 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002355 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002356
2357 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002358 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359 start = *pp;
2360
Bram Moolenaare38eab22019-12-05 21:50:01 +01002361 // Check for hard coded <SNR>: already translated function ID (from a user
2362 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2364 && (*pp)[2] == (int)KE_SNR)
2365 {
2366 *pp += 3;
2367 len = get_id_len(pp) + 3;
2368 return vim_strnsave(start, len);
2369 }
2370
Bram Moolenaare38eab22019-12-05 21:50:01 +01002371 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2372 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 lead = eval_fname_script(start);
2374 if (lead > 2)
2375 start += lead;
2376
Bram Moolenaare38eab22019-12-05 21:50:01 +01002377 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002378 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 lead > 2 ? 0 : FNE_CHECK_START);
2380 if (end == start)
2381 {
2382 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002383 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384 goto theend;
2385 }
2386 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2387 {
2388 /*
2389 * Report an invalid expression in braces, unless the expression
2390 * evaluation has been cancelled due to an aborting error, an
2391 * interrupt, or an exception.
2392 */
2393 if (!aborting())
2394 {
2395 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002396 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002397 }
2398 else
2399 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2400 goto theend;
2401 }
2402
2403 if (lv.ll_tv != NULL)
2404 {
2405 if (fdp != NULL)
2406 {
2407 fdp->fd_dict = lv.ll_dict;
2408 fdp->fd_newkey = lv.ll_newkey;
2409 lv.ll_newkey = NULL;
2410 fdp->fd_di = lv.ll_di;
2411 }
2412 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2413 {
2414 name = vim_strsave(lv.ll_tv->vval.v_string);
2415 *pp = end;
2416 }
2417 else if (lv.ll_tv->v_type == VAR_PARTIAL
2418 && lv.ll_tv->vval.v_partial != NULL)
2419 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002420 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421 *pp = end;
2422 if (partial != NULL)
2423 *partial = lv.ll_tv->vval.v_partial;
2424 }
2425 else
2426 {
2427 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2428 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002429 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 else
2431 *pp = end;
2432 name = NULL;
2433 }
2434 goto theend;
2435 }
2436
2437 if (lv.ll_name == NULL)
2438 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002439 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 *pp = end;
2441 goto theend;
2442 }
2443
Bram Moolenaare38eab22019-12-05 21:50:01 +01002444 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445 if (lv.ll_exp_name != NULL)
2446 {
2447 len = (int)STRLEN(lv.ll_exp_name);
2448 name = deref_func_name(lv.ll_exp_name, &len, partial,
2449 flags & TFN_NO_AUTOLOAD);
2450 if (name == lv.ll_exp_name)
2451 name = NULL;
2452 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002453 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 {
2455 len = (int)(end - *pp);
2456 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2457 if (name == *pp)
2458 name = NULL;
2459 }
2460 if (name != NULL)
2461 {
2462 name = vim_strsave(name);
2463 *pp = end;
2464 if (STRNCMP(name, "<SNR>", 5) == 0)
2465 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002466 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 name[0] = K_SPECIAL;
2468 name[1] = KS_EXTRA;
2469 name[2] = (int)KE_SNR;
2470 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2471 }
2472 goto theend;
2473 }
2474
2475 if (lv.ll_exp_name != NULL)
2476 {
2477 len = (int)STRLEN(lv.ll_exp_name);
2478 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2479 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2480 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002481 // When there was "s:" already or the name expanded to get a
2482 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 lv.ll_name += 2;
2484 len -= 2;
2485 lead = 2;
2486 }
2487 }
2488 else
2489 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002490 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002492 {
2493 if (is_global != NULL && lv.ll_name[0] == 'g')
2494 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002496 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 len = (int)(end - lv.ll_name);
2498 }
2499
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002500 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002501 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002502
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503 /*
2504 * Copy the function name to allocated memory.
2505 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2506 * Accept <SNR>123_name() outside a script.
2507 */
2508 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002509 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002512 if (!vim9script)
2513 lead = 3;
2514 if (vim9script || (lv.ll_exp_name != NULL
2515 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 || eval_fname_sid(*pp))
2517 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002518 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002519 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002521 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 goto theend;
2523 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002524 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002525 if (vim9script)
2526 extra = 3 + (int)STRLEN(sid_buf);
2527 else
2528 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 }
2530 }
2531 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2532 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002533 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 start);
2535 goto theend;
2536 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002537 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 {
2539 char_u *cp = vim_strchr(lv.ll_name, ':');
2540
2541 if (cp != NULL && cp < end)
2542 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002543 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 goto theend;
2545 }
2546 }
2547
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002548 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 if (name != NULL)
2550 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002551 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552 {
2553 name[0] = K_SPECIAL;
2554 name[1] = KS_EXTRA;
2555 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002556 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 STRCPY(name + 3, sid_buf);
2558 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002559 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2560 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 }
2562 *pp = end;
2563
2564theend:
2565 clear_lval(&lv);
2566 return name;
2567}
2568
2569/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002570 * Assuming "name" is the result of trans_function_name() and it was prefixed
2571 * to use the script-local name, return the unmodified name (points into
2572 * "name"). Otherwise return NULL.
2573 * This can be used to first search for a script-local function and fall back
2574 * to the global function if not found.
2575 */
2576 char_u *
2577untrans_function_name(char_u *name)
2578{
2579 char_u *p;
2580
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002581 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002582 {
2583 p = vim_strchr(name, '_');
2584 if (p != NULL)
2585 return p + 1;
2586 }
2587 return NULL;
2588}
2589
2590/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002591 * List functions. When "regmatch" is NULL all of then.
2592 * Otherwise functions matching "regmatch".
2593 */
2594 static void
2595list_functions(regmatch_T *regmatch)
2596{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002597 int changed = func_hashtab.ht_changed;
2598 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002599 hashitem_T *hi;
2600
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002601 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002602 {
2603 if (!HASHITEM_EMPTY(hi))
2604 {
2605 ufunc_T *fp = HI2UF(hi);
2606
2607 --todo;
2608 if ((fp->uf_flags & FC_DEAD) == 0
2609 && (regmatch == NULL
2610 ? !message_filtered(fp->uf_name)
2611 && !func_name_refcount(fp->uf_name)
2612 : !isdigit(*fp->uf_name)
2613 && vim_regexec(regmatch, fp->uf_name, 0)))
2614 {
2615 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002616 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002617 {
2618 emsg(_("E454: function list was modified"));
2619 return;
2620 }
2621 }
2622 }
2623 }
2624}
2625
2626/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002627 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002628 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2629 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002630 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002632 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002633def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634{
2635 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002636 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 int j;
2638 int c;
2639 int saved_did_emsg;
2640 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002641 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002642 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 char_u *p;
2644 char_u *arg;
2645 char_u *line_arg = NULL;
2646 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002647 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002648 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 garray_T newlines;
2650 int varargs = FALSE;
2651 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002652 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002653 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002654 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 int indent;
2656 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002657#define MAX_FUNC_NESTING 50
2658 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 dictitem_T *v;
2660 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002661 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002664 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002665 linenr_T sourcing_lnum_off;
2666 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002667 int is_heredoc = FALSE;
2668 char_u *skip_until = NULL;
2669 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002670 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002671 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672
2673 /*
2674 * ":function" without argument: list functions.
2675 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002676 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 {
2678 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002679 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002681 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 }
2683
2684 /*
2685 * ":function /pat": list functions matching pattern.
2686 */
2687 if (*eap->arg == '/')
2688 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002689 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 if (!eap->skip)
2691 {
2692 regmatch_T regmatch;
2693
2694 c = *p;
2695 *p = NUL;
2696 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2697 *p = c;
2698 if (regmatch.regprog != NULL)
2699 {
2700 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002701 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 vim_regfree(regmatch.regprog);
2703 }
2704 }
2705 if (*p == '/')
2706 ++p;
2707 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002708 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 }
2710
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002711 ga_init(&newargs);
2712 ga_init(&argtypes);
2713 ga_init(&default_args);
2714
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 /*
2716 * Get the function name. There are these situations:
2717 * func normal function name
2718 * "name" == func, "fudi.fd_dict" == NULL
2719 * dict.func new dictionary entry
2720 * "name" == NULL, "fudi.fd_dict" set,
2721 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2722 * dict.func existing dict entry with a Funcref
2723 * "name" == func, "fudi.fd_dict" set,
2724 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2725 * dict.func existing dict entry that's not a Funcref
2726 * "name" == NULL, "fudi.fd_dict" set,
2727 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2728 * s:func script-local function name
2729 * g:func global function name, same as "func"
2730 */
2731 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002732 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002734 // nested function, argument is (args).
2735 paren = TRUE;
2736 CLEAR_FIELD(fudi);
2737 }
2738 else
2739 {
2740 name = trans_function_name(&p, &is_global, eap->skip,
2741 TFN_NO_AUTOLOAD, &fudi, NULL);
2742 paren = (vim_strchr(p, '(') != NULL);
2743 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002745 /*
2746 * Return on an invalid expression in braces, unless the expression
2747 * evaluation has been cancelled due to an aborting error, an
2748 * interrupt, or an exception.
2749 */
2750 if (!aborting())
2751 {
2752 if (!eap->skip && fudi.fd_newkey != NULL)
2753 semsg(_(e_dictkey), fudi.fd_newkey);
2754 vim_free(fudi.fd_newkey);
2755 return NULL;
2756 }
2757 else
2758 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002759 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 }
2761
Bram Moolenaare38eab22019-12-05 21:50:01 +01002762 // An error in a function call during evaluation of an expression in magic
2763 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764 saved_did_emsg = did_emsg;
2765 did_emsg = FALSE;
2766
2767 /*
2768 * ":function func" with only function name: list function.
2769 */
2770 if (!paren)
2771 {
2772 if (!ends_excmd(*skipwhite(p)))
2773 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002774 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 goto ret_free;
2776 }
2777 eap->nextcmd = check_nextcmd(p);
2778 if (eap->nextcmd != NULL)
2779 *p = NUL;
2780 if (!eap->skip && !got_int)
2781 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002782 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002783 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2784 {
2785 char_u *up = untrans_function_name(name);
2786
2787 // With Vim9 script the name was made script-local, if not
2788 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002789 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002790 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002791 }
2792
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793 if (fp != NULL)
2794 {
2795 list_func_head(fp, TRUE);
2796 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2797 {
2798 if (FUNCLINE(fp, j) == NULL)
2799 continue;
2800 msg_putchar('\n');
2801 msg_outnum((long)(j + 1));
2802 if (j < 9)
2803 msg_putchar(' ');
2804 if (j < 99)
2805 msg_putchar(' ');
2806 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002807 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808 ui_breakcheck();
2809 }
2810 if (!got_int)
2811 {
2812 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002813 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002814 msg_puts(" enddef");
2815 else
2816 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 }
2818 }
2819 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002820 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 }
2822 goto ret_free;
2823 }
2824
2825 /*
2826 * ":function name(arg1, arg2)" Define function.
2827 */
2828 p = skipwhite(p);
2829 if (*p != '(')
2830 {
2831 if (!eap->skip)
2832 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002833 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 goto ret_free;
2835 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002836 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 if (vim_strchr(p, '(') != NULL)
2838 p = vim_strchr(p, '(');
2839 }
2840 p = skipwhite(p + 1);
2841
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002842 // In Vim9 script only global functions can be redefined.
2843 if (vim9script && eap->forceit && !is_global)
2844 {
2845 emsg(_(e_nobang));
2846 goto ret_free;
2847 }
2848
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2850
Bram Moolenaar04b12692020-05-04 23:24:44 +02002851 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002853 // Check the name of the function. Unless it's a dictionary function
2854 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 if (name != NULL)
2856 arg = name;
2857 else
2858 arg = fudi.fd_newkey;
2859 if (arg != NULL && (fudi.fd_di == NULL
2860 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2861 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2862 {
2863 if (*arg == K_SPECIAL)
2864 j = 3;
2865 else
2866 j = 0;
2867 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2868 : eval_isnamec(arg[j])))
2869 ++j;
2870 if (arg[j] != NUL)
2871 emsg_funcname((char *)e_invarg2, arg);
2872 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002873 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002875 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 }
2877
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002878 // This may get more lines and make the pointers into the first line
2879 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002880 if (get_function_args(&p, ')', &newargs,
2881 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002882 &varargs, &default_args, eap->skip,
2883 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884 goto errret_2;
2885
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002886 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002888 // find the return type: :def Func(): type
2889 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002891 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002892 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002893 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002894 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002895 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002896 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002897 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002898 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002899 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002900 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002901 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002902 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002904 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002906 else
2907 // find extra arguments "range", "dict", "abort" and "closure"
2908 for (;;)
2909 {
2910 p = skipwhite(p);
2911 if (STRNCMP(p, "range", 5) == 0)
2912 {
2913 flags |= FC_RANGE;
2914 p += 5;
2915 }
2916 else if (STRNCMP(p, "dict", 4) == 0)
2917 {
2918 flags |= FC_DICT;
2919 p += 4;
2920 }
2921 else if (STRNCMP(p, "abort", 5) == 0)
2922 {
2923 flags |= FC_ABORT;
2924 p += 5;
2925 }
2926 else if (STRNCMP(p, "closure", 7) == 0)
2927 {
2928 flags |= FC_CLOSURE;
2929 p += 7;
2930 if (current_funccal == NULL)
2931 {
2932 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2933 name == NULL ? (char_u *)"" : name);
2934 goto erret;
2935 }
2936 }
2937 else
2938 break;
2939 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940
Bram Moolenaare38eab22019-12-05 21:50:01 +01002941 // When there is a line break use what follows for the function body.
2942 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002943 if (*p == '\n')
2944 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002945 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002946 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2947 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002948 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2949 && !eap->skip
2950 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002951 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952
2953 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002954 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2955 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 */
2957 if (KeyTyped)
2958 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002959 // Check if the function already exists, don't let the user type the
2960 // whole function before telling him it doesn't work! For a script we
2961 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002962 if (!eap->skip && !eap->forceit)
2963 {
2964 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002965 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002966 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967 emsg_funcname(e_funcexts, name);
2968 }
2969
2970 if (!eap->skip && did_emsg)
2971 goto erret;
2972
Bram Moolenaare38eab22019-12-05 21:50:01 +01002973 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002974 cmdline_row = msg_row;
2975 }
2976
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002977 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002978 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002979
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002980 // Detect having skipped over comment lines to find the return
2981 // type. Add NULL lines to keep the line count correct.
2982 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2983 if (SOURCING_LNUM < sourcing_lnum_off)
2984 {
2985 sourcing_lnum_off -= SOURCING_LNUM;
2986 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
2987 goto erret;
2988 while (sourcing_lnum_off-- > 0)
2989 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2990 }
2991
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992 indent = 2;
2993 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002994 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 for (;;)
2996 {
2997 if (KeyTyped)
2998 {
2999 msg_scroll = TRUE;
3000 saved_wait_return = FALSE;
3001 }
3002 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003
3004 if (line_arg != NULL)
3005 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003006 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 theline = line_arg;
3008 p = vim_strchr(theline, '\n');
3009 if (p == NULL)
3010 line_arg += STRLEN(line_arg);
3011 else
3012 {
3013 *p = NUL;
3014 line_arg = p + 1;
3015 }
3016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003018 {
3019 vim_free(line_to_free);
3020 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003021 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003022 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003023 theline = eap->getline(':', eap->cookie, indent,
3024 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003025 line_to_free = theline;
3026 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027 if (KeyTyped)
3028 lines_left = Rows - 1;
3029 if (theline == NULL)
3030 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003031 if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003032 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033 else
3034 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 goto erret;
3036 }
3037
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003038 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003039 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003040 if (SOURCING_LNUM < sourcing_lnum_off)
3041 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042 else
3043 sourcing_lnum_off = 0;
3044
3045 if (skip_until != NULL)
3046 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003047 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003048 // * ":append" and "."
3049 // * ":python <<EOF" and "EOF"
3050 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3051 if (heredoc_trimmed == NULL
3052 || (is_heredoc && skipwhite(theline) == theline)
3053 || STRNCMP(theline, heredoc_trimmed,
3054 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003055 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003056 if (heredoc_trimmed == NULL)
3057 p = theline;
3058 else if (is_heredoc)
3059 p = skipwhite(theline) == theline
3060 ? theline : theline + STRLEN(heredoc_trimmed);
3061 else
3062 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003063 if (STRCMP(p, skip_until) == 0)
3064 {
3065 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003066 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003067 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003068 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003069 }
3070 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003071 }
3072 else
3073 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003074 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003075 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003076 ;
3077
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003078 // Check for "endfunction" or "enddef".
3079 if (checkforcmd(&p, nesting_def[nesting]
3080 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003081 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003082 char_u *nextcmd = NULL;
3083
Bram Moolenaar663bb232017-06-22 19:12:10 +02003084 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003085 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003086 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003087 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003088 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003089 give_warning2(eap->cmdidx == CMD_def
3090 ? (char_u *)_("W1001: Text found after :enddef: %s")
3091 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003092 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003093 if (nextcmd != NULL)
3094 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003095 // Another command follows. If the line came from "eap" we
3096 // can simply point into it, otherwise we need to change
3097 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003098 eap->nextcmd = nextcmd;
3099 if (line_to_free != NULL)
3100 {
3101 vim_free(*eap->cmdlinep);
3102 *eap->cmdlinep = line_to_free;
3103 line_to_free = NULL;
3104 }
3105 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106 break;
3107 }
3108
Bram Moolenaare38eab22019-12-05 21:50:01 +01003109 // Increase indent inside "if", "while", "for" and "try", decrease
3110 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003111 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 indent -= 2;
3113 else if (STRNCMP(p, "if", 2) == 0
3114 || STRNCMP(p, "wh", 2) == 0
3115 || STRNCMP(p, "for", 3) == 0
3116 || STRNCMP(p, "try", 3) == 0)
3117 indent += 2;
3118
Bram Moolenaare38eab22019-12-05 21:50:01 +01003119 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003120 // Only recognize "def" inside "def", not inside "function",
3121 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003122 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003123 if (checkforcmd(&p, "function", 2)
3124 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125 {
3126 if (*p == '!')
3127 p = skipwhite(p + 1);
3128 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003129 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 if (*skipwhite(p) == '(')
3131 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003132 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003133 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003134 else
3135 {
3136 ++nesting;
3137 nesting_def[nesting] = (c == 'd');
3138 indent += 2;
3139 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003140 }
3141 }
3142
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003143 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003145 if (eap->cmdidx != CMD_def
3146 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003147 || (p[0] == 'c'
3148 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3149 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3150 && (STRNCMP(&p[3], "nge", 3) != 0
3151 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 || (p[0] == 'i'
3153 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003154 && (!ASCII_ISALPHA(p[2])
3155 || (p[2] == 's'
3156 && (!ASCII_ISALPHA(p[3])
3157 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003158 skip_until = vim_strsave((char_u *)".");
3159
Bram Moolenaare38eab22019-12-05 21:50:01 +01003160 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 arg = skipwhite(skiptowhite(p));
3162 if (arg[0] == '<' && arg[1] =='<'
3163 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003164 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3165 || ((p[2] == '3' || p[2] == 'x')
3166 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 || (p[0] == 'p' && p[1] == 'e'
3168 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3169 || (p[0] == 't' && p[1] == 'c'
3170 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3171 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3172 && !ASCII_ISALPHA(p[3]))
3173 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3174 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3175 || (p[0] == 'm' && p[1] == 'z'
3176 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3177 ))
3178 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003179 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003181 if (STRNCMP(p, "trim", 4) == 0)
3182 {
3183 // Ignore leading white space.
3184 p = skipwhite(p + 4);
3185 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003186 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003187 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003188 if (*p == NUL)
3189 skip_until = vim_strsave((char_u *)".");
3190 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003191 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003192 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003193 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003195
3196 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003197 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003198 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003199 if (*arg == '[')
3200 arg = vim_strchr(arg, ']');
3201 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003202 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003203 arg = skipwhite(skiptowhite(arg));
3204 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3205 && ((p[0] == 'l'
3206 && p[1] == 'e'
3207 && (!ASCII_ISALNUM(p[2])
3208 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003209 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003210 p = skipwhite(arg + 3);
3211 if (STRNCMP(p, "trim", 4) == 0)
3212 {
3213 // Ignore leading white space.
3214 p = skipwhite(p + 4);
3215 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003216 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003217 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003218 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003219 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003220 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003221 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003222 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 }
3224
Bram Moolenaare38eab22019-12-05 21:50:01 +01003225 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 // Copy the line to newly allocated memory. get_one_sourceline()
3230 // allocates 250 bytes per line, this saves 80% on average. The cost
3231 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003233 if (p == NULL)
3234 goto erret;
3235 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236
Bram Moolenaare38eab22019-12-05 21:50:01 +01003237 // Add NULL lines for continuation lines, so that the line count is
3238 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239 while (sourcing_lnum_off-- > 0)
3240 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3241
Bram Moolenaare38eab22019-12-05 21:50:01 +01003242 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 if (line_arg != NULL && *line_arg == NUL)
3244 line_arg = NULL;
3245 }
3246
Bram Moolenaare38eab22019-12-05 21:50:01 +01003247 // Don't define the function when skipping commands or when an error was
3248 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 if (eap->skip || did_emsg)
3250 goto erret;
3251
3252 /*
3253 * If there are no errors, add the function
3254 */
3255 if (fudi.fd_dict == NULL)
3256 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003257 hashtab_T *ht;
3258
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 v = find_var(name, &ht, FALSE);
3260 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3261 {
3262 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3263 name);
3264 goto erret;
3265 }
3266
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003267 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003268 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003270 char_u *uname = untrans_function_name(name);
3271
3272 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3273 }
3274
3275 if (fp != NULL || import != NULL)
3276 {
3277 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003278
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003279 // Function can be replaced with "function!" and when sourcing the
3280 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003281 // A name that is used by an import can not be overruled.
3282 if (import != NULL
3283 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003284 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003285 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003287 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003288 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003289 else
3290 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003291 goto erret;
3292 }
3293 if (fp->uf_calls > 0)
3294 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003295 emsg_funcname(
3296 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 name);
3298 goto erret;
3299 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003300 if (fp->uf_refcount > 1)
3301 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003302 // This function is referenced somewhere, don't redefine it but
3303 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003304 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003305 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003306 fp = NULL;
3307 overwrite = TRUE;
3308 }
3309 else
3310 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003311 char_u *exp_name = fp->uf_name_exp;
3312
3313 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003314 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003315 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003316 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003317 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003318 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003319#ifdef FEAT_PROFILE
3320 fp->uf_profiling = FALSE;
3321 fp->uf_prof_initialized = FALSE;
3322#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003323 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 }
3326 }
3327 else
3328 {
3329 char numbuf[20];
3330
3331 fp = NULL;
3332 if (fudi.fd_newkey == NULL && !eap->forceit)
3333 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003334 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 goto erret;
3336 }
3337 if (fudi.fd_di == NULL)
3338 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003339 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003340 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 goto erret;
3342 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003343 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003344 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 goto erret;
3346
Bram Moolenaare38eab22019-12-05 21:50:01 +01003347 // Give the function a sequential number. Can only be used with a
3348 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 vim_free(name);
3350 sprintf(numbuf, "%d", ++func_nr);
3351 name = vim_strsave((char_u *)numbuf);
3352 if (name == NULL)
3353 goto erret;
3354 }
3355
3356 if (fp == NULL)
3357 {
3358 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3359 {
3360 int slen, plen;
3361 char_u *scriptname;
3362
Bram Moolenaare38eab22019-12-05 21:50:01 +01003363 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003365 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 {
3367 scriptname = autoload_name(name);
3368 if (scriptname != NULL)
3369 {
3370 p = vim_strchr(scriptname, '/');
3371 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003372 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003374 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 j = OK;
3376 vim_free(scriptname);
3377 }
3378 }
3379 if (j == FAIL)
3380 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003381 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 goto erret;
3383 }
3384 }
3385
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003386 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 if (fp == NULL)
3388 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003389 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003390 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391
3392 if (fudi.fd_dict != NULL)
3393 {
3394 if (fudi.fd_di == NULL)
3395 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003396 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3398 if (fudi.fd_di == NULL)
3399 {
3400 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003401 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402 goto erret;
3403 }
3404 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3405 {
3406 vim_free(fudi.fd_di);
3407 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003408 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 goto erret;
3410 }
3411 }
3412 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003413 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 clear_tv(&fudi.fd_di->di_tv);
3415 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417
Bram Moolenaare38eab22019-12-05 21:50:01 +01003418 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 flags |= FC_DICT;
3420 }
3421
Bram Moolenaare38eab22019-12-05 21:50:01 +01003422 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003423 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003424 if (overwrite)
3425 {
3426 hi = hash_find(&func_hashtab, name);
3427 hi->hi_key = UF2HIKEY(fp);
3428 }
3429 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430 {
3431 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003432 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 goto erret;
3434 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003435 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 }
3437 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003438 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003439 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003440 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003441
3442 if (eap->cmdidx == CMD_def)
3443 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003444 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003445
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003446 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003447
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003448 // error messages are for the first function line
3449 SOURCING_LNUM = sourcing_lnum_top;
3450
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003451 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003452 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003453
3454 if (argtypes.ga_len > 0)
3455 {
3456 // When "varargs" is set the last name/type goes into uf_va_name
3457 // and uf_va_type.
3458 int len = argtypes.ga_len - (varargs ? 1 : 0);
3459
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003460 if (len > 0)
3461 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 if (fp->uf_arg_types != NULL)
3463 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003464 int i;
3465 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466
3467 for (i = 0; i < len; ++ i)
3468 {
3469 p = ((char_u **)argtypes.ga_data)[i];
3470 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003471 // will get the type from the default value
3472 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003473 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003474 type = parse_type(&p, &fp->uf_type_list);
3475 if (type == NULL)
3476 {
3477 SOURCING_LNUM = lnum_save;
3478 goto errret_2;
3479 }
3480 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003481 }
3482 }
3483 if (varargs)
3484 {
3485 // Move the last argument "...name: type" to uf_va_name and
3486 // uf_va_type.
3487 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3488 [fp->uf_args.ga_len - 1];
3489 --fp->uf_args.ga_len;
3490 p = ((char_u **)argtypes.ga_data)[len];
3491 if (p == NULL)
3492 // todo: get type from default value
3493 fp->uf_va_type = &t_any;
3494 else
3495 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003496 if (fp->uf_va_type == NULL)
3497 {
3498 SOURCING_LNUM = lnum_save;
3499 goto errret_2;
3500 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003501 }
3502 varargs = FALSE;
3503 }
3504
3505 // parse the return type, if any
3506 if (ret_type == NULL)
3507 fp->uf_ret_type = &t_void;
3508 else
3509 {
3510 p = ret_type;
3511 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3512 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003513 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003514 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003515 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003516 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003517
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003518 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003519 if ((flags & FC_CLOSURE) != 0)
3520 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003521 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003522 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003523 }
3524 else
3525 fp->uf_scoped = NULL;
3526
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003527#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003528 if (prof_def_func())
3529 func_do_profile(fp);
3530#endif
3531 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003532 if (sandbox)
3533 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003534 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003535 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 fp->uf_flags = flags;
3537 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003538 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003539 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003540 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003541 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003542 if (is_export)
3543 {
3544 fp->uf_flags |= FC_EXPORT;
3545 // let ex_export() know the export worked.
3546 is_export = FALSE;
3547 }
3548
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003549 if (eap->cmdidx == CMD_def)
3550 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003551 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3552 // :func does not use Vim9 script syntax, even in a Vim9 script file
3553 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003554
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 goto ret_free;
3556
3557erret:
3558 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003559 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560errret_2:
3561 ga_clear_strings(&newlines);
3562ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003563 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003565 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003567 if (name != name_arg)
3568 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003569 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 did_emsg |= saved_did_emsg;
3571 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003572
3573 return fp;
3574}
3575
3576/*
3577 * ":function"
3578 */
3579 void
3580ex_function(exarg_T *eap)
3581{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003582 (void)def_function(eap, NULL);
3583}
3584
3585/*
3586 * :defcompile - compile all :def functions in the current script.
3587 */
3588 void
3589ex_defcompile(exarg_T *eap UNUSED)
3590{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003591 long todo = (long)func_hashtab.ht_used;
3592 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003593 hashitem_T *hi;
3594 ufunc_T *ufunc;
3595
3596 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3597 {
3598 if (!HASHITEM_EMPTY(hi))
3599 {
3600 --todo;
3601 ufunc = HI2UF(hi);
3602 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003603 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003604 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003605 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003606
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003607 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003608 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003609 // a function has been added or removed, need to start over
3610 todo = (long)func_hashtab.ht_used;
3611 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003612 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003613 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003614 }
3615 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003616 }
3617 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618}
3619
3620/*
3621 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3622 * Return 2 if "p" starts with "s:".
3623 * Return 0 otherwise.
3624 */
3625 int
3626eval_fname_script(char_u *p)
3627{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003628 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3629 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3631 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3632 return 5;
3633 if (p[0] == 's' && p[1] == ':')
3634 return 2;
3635 return 0;
3636}
3637
3638 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003639translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640{
3641 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003642 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003643 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003644}
3645
3646/*
3647 * Return TRUE when "ufunc" has old-style "..." varargs
3648 * or named varargs "...name: type".
3649 */
3650 int
3651has_varargs(ufunc_T *ufunc)
3652{
3653 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654}
3655
3656/*
3657 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003658 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 */
3660 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003661function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662{
3663 char_u *nm = name;
3664 char_u *p;
3665 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003666 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003667 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003669 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3670 if (no_deref)
3671 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003672 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 nm = skipwhite(nm);
3674
Bram Moolenaare38eab22019-12-05 21:50:01 +01003675 // Only accept "funcname", "funcname ", "funcname (..." and
3676 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003678 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 vim_free(p);
3680 return n;
3681}
3682
Bram Moolenaar113e1072019-01-20 15:30:40 +01003683#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 char_u *
3685get_expanded_name(char_u *name, int check)
3686{
3687 char_u *nm = name;
3688 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003689 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003691 p = trans_function_name(&nm, &is_global, FALSE,
3692 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003694 if (p != NULL && *nm == NUL
3695 && (!check || translated_function_exists(p, is_global)))
3696 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697
3698 vim_free(p);
3699 return NULL;
3700}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003701#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703/*
3704 * Function given to ExpandGeneric() to obtain the list of user defined
3705 * function names.
3706 */
3707 char_u *
3708get_user_func_name(expand_T *xp, int idx)
3709{
3710 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003711 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 static hashitem_T *hi;
3713 ufunc_T *fp;
3714
3715 if (idx == 0)
3716 {
3717 done = 0;
3718 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003719 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003721 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 {
3723 if (done++ > 0)
3724 ++hi;
3725 while (HASHITEM_EMPTY(hi))
3726 ++hi;
3727 fp = HI2UF(hi);
3728
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003729 // don't show dead, dict and lambda functions
3730 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003731 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003732 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733
3734 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003735 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736
3737 cat_func_name(IObuff, fp);
3738 if (xp->xp_context != EXPAND_USER_FUNC)
3739 {
3740 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003741 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742 STRCAT(IObuff, ")");
3743 }
3744 return IObuff;
3745 }
3746 return NULL;
3747}
3748
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749/*
3750 * ":delfunction {name}"
3751 */
3752 void
3753ex_delfunction(exarg_T *eap)
3754{
3755 ufunc_T *fp = NULL;
3756 char_u *p;
3757 char_u *name;
3758 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003759 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760
3761 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003762 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763 vim_free(fudi.fd_newkey);
3764 if (name == NULL)
3765 {
3766 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003767 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768 return;
3769 }
3770 if (!ends_excmd(*skipwhite(p)))
3771 {
3772 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003773 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 return;
3775 }
3776 eap->nextcmd = check_nextcmd(p);
3777 if (eap->nextcmd != NULL)
3778 *p = NUL;
3779
3780 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003781 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 vim_free(name);
3783
3784 if (!eap->skip)
3785 {
3786 if (fp == NULL)
3787 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003788 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003789 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 return;
3791 }
3792 if (fp->uf_calls > 0)
3793 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003794 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 return;
3796 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003797 if (fp->uf_flags & FC_VIM9)
3798 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003799 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003800 return;
3801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802
3803 if (fudi.fd_dict != NULL)
3804 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003805 // Delete the dict item that refers to the function, it will
3806 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3808 }
3809 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003810 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003811 // A normal function (not a numbered function or lambda) has a
3812 // refcount of 1 for the entry in the hashtable. When deleting
3813 // it and the refcount is more than one, it should be kept.
3814 // A numbered function and lambda should be kept if the refcount is
3815 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003816 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003817 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003818 // Function is still referenced somewhere. Don't free it but
3819 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003820 if (func_remove(fp))
3821 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003822 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003823 }
3824 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003825 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003826 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 }
3828}
3829
3830/*
3831 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003832 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 */
3834 void
3835func_unref(char_u *name)
3836{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003837 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003839 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003841 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003842 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003845 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003847 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003849 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003851 // Only delete it when it's not being used. Otherwise it's done
3852 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003853 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003854 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003855 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003856}
3857
3858/*
3859 * Unreference a Function: decrement the reference count and free it when it
3860 * becomes zero.
3861 */
3862 void
3863func_ptr_unref(ufunc_T *fp)
3864{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003865 if (fp != NULL && --fp->uf_refcount <= 0)
3866 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003867 // Only delete it when it's not being used. Otherwise it's done
3868 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003869 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003870 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 }
3872}
3873
3874/*
3875 * Count a reference to a Function.
3876 */
3877 void
3878func_ref(char_u *name)
3879{
3880 ufunc_T *fp;
3881
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003882 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003884 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003885 if (fp != NULL)
3886 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003888 // Only give an error for a numbered function.
3889 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003890 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003891}
3892
3893/*
3894 * Count a reference to a Function.
3895 */
3896 void
3897func_ptr_ref(ufunc_T *fp)
3898{
3899 if (fp != NULL)
3900 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901}
3902
3903/*
3904 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3905 * referenced from anywhere that is in use.
3906 */
3907 static int
3908can_free_funccal(funccall_T *fc, int copyID)
3909{
3910 return (fc->l_varlist.lv_copyID != copyID
3911 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003912 && fc->l_avars.dv_copyID != copyID
3913 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914}
3915
3916/*
3917 * ":return [expr]"
3918 */
3919 void
3920ex_return(exarg_T *eap)
3921{
3922 char_u *arg = eap->arg;
3923 typval_T rettv;
3924 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003925 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926
3927 if (current_funccal == NULL)
3928 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003929 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 return;
3931 }
3932
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003933 CLEAR_FIELD(evalarg);
3934 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3935
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 if (eap->skip)
3937 ++emsg_skip;
3938
3939 eap->nextcmd = NULL;
3940 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003941 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003942 {
3943 if (!eap->skip)
3944 returning = do_return(eap, FALSE, TRUE, &rettv);
3945 else
3946 clear_tv(&rettv);
3947 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003948 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 else if (!eap->skip)
3950 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003951 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003952 update_force_abort();
3953
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954 /*
3955 * Return unless the expression evaluation has been cancelled due to an
3956 * aborting error, an interrupt, or an exception.
3957 */
3958 if (!aborting())
3959 returning = do_return(eap, FALSE, TRUE, NULL);
3960 }
3961
Bram Moolenaare38eab22019-12-05 21:50:01 +01003962 // When skipping or the return gets pending, advance to the next command
3963 // in this line (!returning). Otherwise, ignore the rest of the line.
3964 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 if (returning)
3966 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003967 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 eap->nextcmd = check_nextcmd(arg);
3969
3970 if (eap->skip)
3971 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003972 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973}
3974
3975/*
3976 * ":1,25call func(arg1, arg2)" function call.
3977 */
3978 void
3979ex_call(exarg_T *eap)
3980{
3981 char_u *arg = eap->arg;
3982 char_u *startarg;
3983 char_u *name;
3984 char_u *tofree;
3985 int len;
3986 typval_T rettv;
3987 linenr_T lnum;
3988 int doesrange;
3989 int failed = FALSE;
3990 funcdict_T fudi;
3991 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003992 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993
Bram Moolenaare6b53242020-07-01 17:28:33 +02003994 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 if (eap->skip)
3996 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003997 // trans_function_name() doesn't work well when skipping, use eval0()
3998 // instead to skip to any following command, e.g. for:
3999 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004001 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 clear_tv(&rettv);
4003 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004004 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 return;
4006 }
4007
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004008 tofree = trans_function_name(&arg, NULL, eap->skip,
4009 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 if (fudi.fd_newkey != NULL)
4011 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004012 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004013 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 vim_free(fudi.fd_newkey);
4015 }
4016 if (tofree == NULL)
4017 return;
4018
Bram Moolenaare38eab22019-12-05 21:50:01 +01004019 // Increase refcount on dictionary, it could get deleted when evaluating
4020 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 if (fudi.fd_dict != NULL)
4022 ++fudi.fd_dict->dv_refcount;
4023
Bram Moolenaare38eab22019-12-05 21:50:01 +01004024 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4025 // contents. For VAR_PARTIAL get its partial, unless we already have one
4026 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 len = (int)STRLEN(tofree);
4028 name = deref_func_name(tofree, &len,
4029 partial != NULL ? NULL : &partial, FALSE);
4030
Bram Moolenaare38eab22019-12-05 21:50:01 +01004031 // Skip white space to allow ":call func ()". Not good, but required for
4032 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004034 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035
4036 if (*startarg != '(')
4037 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004038 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 goto end;
4040 }
4041
4042 /*
4043 * When skipping, evaluate the function once, to find the end of the
4044 * arguments.
4045 * When the function takes a range, this is discovered after the first
4046 * call, and the loop is broken.
4047 */
4048 if (eap->skip)
4049 {
4050 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004051 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 }
4053 else
4054 lnum = eap->line1;
4055 for ( ; lnum <= eap->line2; ++lnum)
4056 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004057 funcexe_T funcexe;
4058
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 if (!eap->skip && eap->addr_count > 0)
4060 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004061 if (lnum > curbuf->b_ml.ml_line_count)
4062 {
4063 // If the function deleted lines or switched to another buffer
4064 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004065 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004066 break;
4067 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068 curwin->w_cursor.lnum = lnum;
4069 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 }
4072 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004073
Bram Moolenaara80faa82020-04-12 19:37:17 +02004074 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004075 funcexe.firstline = eap->line1;
4076 funcexe.lastline = eap->line2;
4077 funcexe.doesrange = &doesrange;
4078 funcexe.evaluate = !eap->skip;
4079 funcexe.partial = partial;
4080 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004081 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 {
4083 failed = TRUE;
4084 break;
4085 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004086 if (has_watchexpr())
4087 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004089 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004090 if (handle_subscript(&arg, &rettv,
4091 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 {
4093 failed = TRUE;
4094 break;
4095 }
4096
4097 clear_tv(&rettv);
4098 if (doesrange || eap->skip)
4099 break;
4100
Bram Moolenaare38eab22019-12-05 21:50:01 +01004101 // Stop when immediately aborting on error, or when an interrupt
4102 // occurred or an exception was thrown but not caught.
4103 // get_func_tv() returned OK, so that the check for trailing
4104 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 if (aborting())
4106 break;
4107 }
4108 if (eap->skip)
4109 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004110 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111
Bram Moolenaare51bb172020-02-16 19:42:23 +01004112 // When inside :try we need to check for following "| catch".
4113 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004114 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004115 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004116 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004117 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004119 if (!failed)
4120 {
4121 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004122 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004123 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 }
4125 else
4126 eap->nextcmd = check_nextcmd(arg);
4127 }
4128
4129end:
4130 dict_unref(fudi.fd_dict);
4131 vim_free(tofree);
4132}
4133
4134/*
4135 * Return from a function. Possibly makes the return pending. Also called
4136 * for a pending return at the ":endtry" or after returning from an extra
4137 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4138 * when called due to a ":return" command. "rettv" may point to a typval_T
4139 * with the return rettv. Returns TRUE when the return can be carried out,
4140 * FALSE when the return gets pending.
4141 */
4142 int
4143do_return(
4144 exarg_T *eap,
4145 int reanimate,
4146 int is_cmd,
4147 void *rettv)
4148{
4149 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004150 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151
4152 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004153 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 current_funccal->returned = FALSE;
4155
4156 /*
4157 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4158 * not in its finally clause (which then is to be executed next) is found.
4159 * In this case, make the ":return" pending for execution at the ":endtry".
4160 * Otherwise, return normally.
4161 */
4162 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4163 if (idx >= 0)
4164 {
4165 cstack->cs_pending[idx] = CSTP_RETURN;
4166
4167 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004168 // A pending return again gets pending. "rettv" points to an
4169 // allocated variable with the rettv of the original ":return"'s
4170 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 cstack->cs_rettv[idx] = rettv;
4172 else
4173 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004174 // When undoing a return in order to make it pending, get the stored
4175 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 if (reanimate)
4177 rettv = current_funccal->rettv;
4178
4179 if (rettv != NULL)
4180 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004181 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4183 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4184 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004185 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 }
4187 else
4188 cstack->cs_rettv[idx] = NULL;
4189
4190 if (reanimate)
4191 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004192 // The pending return value could be overwritten by a ":return"
4193 // without argument in a finally clause; reset the default
4194 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 current_funccal->rettv->v_type = VAR_NUMBER;
4196 current_funccal->rettv->vval.v_number = 0;
4197 }
4198 }
4199 report_make_pending(CSTP_RETURN, rettv);
4200 }
4201 else
4202 {
4203 current_funccal->returned = TRUE;
4204
Bram Moolenaare38eab22019-12-05 21:50:01 +01004205 // If the return is carried out now, store the return value. For
4206 // a return immediately after reanimation, the value is already
4207 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 if (!reanimate && rettv != NULL)
4209 {
4210 clear_tv(current_funccal->rettv);
4211 *current_funccal->rettv = *(typval_T *)rettv;
4212 if (!is_cmd)
4213 vim_free(rettv);
4214 }
4215 }
4216
4217 return idx < 0;
4218}
4219
4220/*
4221 * Free the variable with a pending return value.
4222 */
4223 void
4224discard_pending_return(void *rettv)
4225{
4226 free_tv((typval_T *)rettv);
4227}
4228
4229/*
4230 * Generate a return command for producing the value of "rettv". The result
4231 * is an allocated string. Used by report_pending() for verbose messages.
4232 */
4233 char_u *
4234get_return_cmd(void *rettv)
4235{
4236 char_u *s = NULL;
4237 char_u *tofree = NULL;
4238 char_u numbuf[NUMBUFLEN];
4239
4240 if (rettv != NULL)
4241 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4242 if (s == NULL)
4243 s = (char_u *)"";
4244
4245 STRCPY(IObuff, ":return ");
4246 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4247 if (STRLEN(s) + 8 >= IOSIZE)
4248 STRCPY(IObuff + IOSIZE - 4, "...");
4249 vim_free(tofree);
4250 return vim_strsave(IObuff);
4251}
4252
4253/*
4254 * Get next function line.
4255 * Called by do_cmdline() to get the next line.
4256 * Returns allocated string, or NULL for end of function.
4257 */
4258 char_u *
4259get_func_line(
4260 int c UNUSED,
4261 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004262 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004263 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264{
4265 funccall_T *fcp = (funccall_T *)cookie;
4266 ufunc_T *fp = fcp->func;
4267 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004268 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004269
Bram Moolenaare38eab22019-12-05 21:50:01 +01004270 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271 if (fcp->dbg_tick != debug_tick)
4272 {
4273 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004274 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 fcp->dbg_tick = debug_tick;
4276 }
4277#ifdef FEAT_PROFILE
4278 if (do_profiling == PROF_YES)
4279 func_line_end(cookie);
4280#endif
4281
4282 gap = &fp->uf_lines;
4283 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4284 || fcp->returned)
4285 retval = NULL;
4286 else
4287 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004288 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 while (fcp->linenr < gap->ga_len
4290 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4291 ++fcp->linenr;
4292 if (fcp->linenr >= gap->ga_len)
4293 retval = NULL;
4294 else
4295 {
4296 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004297 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298#ifdef FEAT_PROFILE
4299 if (do_profiling == PROF_YES)
4300 func_line_start(cookie);
4301#endif
4302 }
4303 }
4304
Bram Moolenaare38eab22019-12-05 21:50:01 +01004305 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004306 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004308 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004309 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004311 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312 fcp->dbg_tick = debug_tick;
4313 }
4314
4315 return retval;
4316}
4317
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318/*
4319 * Return TRUE if the currently active function should be ended, because a
4320 * return was encountered or an error occurred. Used inside a ":while".
4321 */
4322 int
4323func_has_ended(void *cookie)
4324{
4325 funccall_T *fcp = (funccall_T *)cookie;
4326
Bram Moolenaare38eab22019-12-05 21:50:01 +01004327 // Ignore the "abort" flag if the abortion behavior has been changed due to
4328 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4330 || fcp->returned);
4331}
4332
4333/*
4334 * return TRUE if cookie indicates a function which "abort"s on errors.
4335 */
4336 int
4337func_has_abort(
4338 void *cookie)
4339{
4340 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4341}
4342
4343
4344/*
4345 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4346 * Don't do this when "Func" is already a partial that was bound
4347 * explicitly (pt_auto is FALSE).
4348 * Changes "rettv" in-place.
4349 * Returns the updated "selfdict_in".
4350 */
4351 dict_T *
4352make_partial(dict_T *selfdict_in, typval_T *rettv)
4353{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004354 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 char_u *tofree = NULL;
4356 ufunc_T *fp;
4357 char_u fname_buf[FLEN_FIXED + 1];
4358 int error;
4359 dict_T *selfdict = selfdict_in;
4360
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004361 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4362 fp = rettv->vval.v_partial->pt_func;
4363 else
4364 {
4365 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4366 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004367 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004368 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004369 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004370 vim_free(tofree);
4371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372
4373 if (fp != NULL && (fp->uf_flags & FC_DICT))
4374 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004375 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376
4377 if (pt != NULL)
4378 {
4379 pt->pt_refcount = 1;
4380 pt->pt_dict = selfdict;
4381 pt->pt_auto = TRUE;
4382 selfdict = NULL;
4383 if (rettv->v_type == VAR_FUNC)
4384 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004385 // Just a function: Take over the function name and use
4386 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387 pt->pt_name = rettv->vval.v_string;
4388 }
4389 else
4390 {
4391 partial_T *ret_pt = rettv->vval.v_partial;
4392 int i;
4393
Bram Moolenaare38eab22019-12-05 21:50:01 +01004394 // Partial: copy the function name, use selfdict and copy
4395 // args. Can't take over name or args, the partial might
4396 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004397 if (ret_pt->pt_name != NULL)
4398 {
4399 pt->pt_name = vim_strsave(ret_pt->pt_name);
4400 func_ref(pt->pt_name);
4401 }
4402 else
4403 {
4404 pt->pt_func = ret_pt->pt_func;
4405 func_ptr_ref(pt->pt_func);
4406 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 if (ret_pt->pt_argc > 0)
4408 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004409 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004411 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004412 pt->pt_argc = 0;
4413 else
4414 {
4415 pt->pt_argc = ret_pt->pt_argc;
4416 for (i = 0; i < pt->pt_argc; i++)
4417 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4418 }
4419 }
4420 partial_unref(ret_pt);
4421 }
4422 rettv->v_type = VAR_PARTIAL;
4423 rettv->vval.v_partial = pt;
4424 }
4425 }
4426 return selfdict;
4427}
4428
4429/*
4430 * Return the name of the executed function.
4431 */
4432 char_u *
4433func_name(void *cookie)
4434{
4435 return ((funccall_T *)cookie)->func->uf_name;
4436}
4437
4438/*
4439 * Return the address holding the next breakpoint line for a funccall cookie.
4440 */
4441 linenr_T *
4442func_breakpoint(void *cookie)
4443{
4444 return &((funccall_T *)cookie)->breakpoint;
4445}
4446
4447/*
4448 * Return the address holding the debug tick for a funccall cookie.
4449 */
4450 int *
4451func_dbg_tick(void *cookie)
4452{
4453 return &((funccall_T *)cookie)->dbg_tick;
4454}
4455
4456/*
4457 * Return the nesting level for a funccall cookie.
4458 */
4459 int
4460func_level(void *cookie)
4461{
4462 return ((funccall_T *)cookie)->level;
4463}
4464
4465/*
4466 * Return TRUE when a function was ended by a ":return" command.
4467 */
4468 int
4469current_func_returned(void)
4470{
4471 return current_funccal->returned;
4472}
4473
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474 int
4475free_unref_funccal(int copyID, int testing)
4476{
4477 int did_free = FALSE;
4478 int did_free_funccal = FALSE;
4479 funccall_T *fc, **pfc;
4480
4481 for (pfc = &previous_funccal; *pfc != NULL; )
4482 {
4483 if (can_free_funccal(*pfc, copyID))
4484 {
4485 fc = *pfc;
4486 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004487 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 did_free = TRUE;
4489 did_free_funccal = TRUE;
4490 }
4491 else
4492 pfc = &(*pfc)->caller;
4493 }
4494 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004495 // When a funccal was freed some more items might be garbage
4496 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 (void)garbage_collect(testing);
4498
4499 return did_free;
4500}
4501
4502/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004503 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 */
4505 static funccall_T *
4506get_funccal(void)
4507{
4508 int i;
4509 funccall_T *funccal;
4510 funccall_T *temp_funccal;
4511
4512 funccal = current_funccal;
4513 if (debug_backtrace_level > 0)
4514 {
4515 for (i = 0; i < debug_backtrace_level; i++)
4516 {
4517 temp_funccal = funccal->caller;
4518 if (temp_funccal)
4519 funccal = temp_funccal;
4520 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004521 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522 debug_backtrace_level = i;
4523 }
4524 }
4525 return funccal;
4526}
4527
4528/*
4529 * Return the hashtable used for local variables in the current funccal.
4530 * Return NULL if there is no current funccal.
4531 */
4532 hashtab_T *
4533get_funccal_local_ht()
4534{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004535 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 return NULL;
4537 return &get_funccal()->l_vars.dv_hashtab;
4538}
4539
4540/*
4541 * Return the l: scope variable.
4542 * Return NULL if there is no current funccal.
4543 */
4544 dictitem_T *
4545get_funccal_local_var()
4546{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004547 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 return NULL;
4549 return &get_funccal()->l_vars_var;
4550}
4551
4552/*
4553 * Return the hashtable used for argument in the current funccal.
4554 * Return NULL if there is no current funccal.
4555 */
4556 hashtab_T *
4557get_funccal_args_ht()
4558{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004559 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004560 return NULL;
4561 return &get_funccal()->l_avars.dv_hashtab;
4562}
4563
4564/*
4565 * Return the a: scope variable.
4566 * Return NULL if there is no current funccal.
4567 */
4568 dictitem_T *
4569get_funccal_args_var()
4570{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004571 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004573 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574}
4575
4576/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 * List function variables, if there is a function.
4578 */
4579 void
4580list_func_vars(int *first)
4581{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004582 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004584 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585}
4586
4587/*
4588 * If "ht" is the hashtable for local variables in the current funccal, return
4589 * the dict that contains it.
4590 * Otherwise return NULL.
4591 */
4592 dict_T *
4593get_current_funccal_dict(hashtab_T *ht)
4594{
4595 if (current_funccal != NULL
4596 && ht == &current_funccal->l_vars.dv_hashtab)
4597 return &current_funccal->l_vars;
4598 return NULL;
4599}
4600
4601/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004602 * Search hashitem in parent scope.
4603 */
4604 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004605find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004606{
4607 funccall_T *old_current_funccal = current_funccal;
4608 hashtab_T *ht;
4609 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004610 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004611
4612 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4613 return NULL;
4614
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004615 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004616 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004617 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004618 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004619 ht = find_var_ht(name, &varname);
4620 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004621 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004622 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004623 if (!HASHITEM_EMPTY(hi))
4624 {
4625 *pht = ht;
4626 break;
4627 }
4628 }
4629 if (current_funccal == current_funccal->func->uf_scoped)
4630 break;
4631 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004632 }
4633 current_funccal = old_current_funccal;
4634
4635 return hi;
4636}
4637
4638/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004639 * Search variable in parent scope.
4640 */
4641 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004642find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004643{
4644 dictitem_T *v = NULL;
4645 funccall_T *old_current_funccal = current_funccal;
4646 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004647 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004648
4649 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4650 return NULL;
4651
Bram Moolenaare38eab22019-12-05 21:50:01 +01004652 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004653 current_funccal = current_funccal->func->uf_scoped;
4654 while (current_funccal)
4655 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004656 ht = find_var_ht(name, &varname);
4657 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004658 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004659 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004660 if (v != NULL)
4661 break;
4662 }
4663 if (current_funccal == current_funccal->func->uf_scoped)
4664 break;
4665 current_funccal = current_funccal->func->uf_scoped;
4666 }
4667 current_funccal = old_current_funccal;
4668
4669 return v;
4670}
4671
4672/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673 * Set "copyID + 1" in previous_funccal and callers.
4674 */
4675 int
4676set_ref_in_previous_funccal(int copyID)
4677{
4678 int abort = FALSE;
4679 funccall_T *fc;
4680
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004681 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004683 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004684 abort = abort
4685 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4686 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004687 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 }
4689 return abort;
4690}
4691
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004692 static int
4693set_ref_in_funccal(funccall_T *fc, int copyID)
4694{
4695 int abort = FALSE;
4696
4697 if (fc->fc_copyID != copyID)
4698 {
4699 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004700 abort = abort
4701 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4702 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004703 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004704 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004705 }
4706 return abort;
4707}
4708
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709/*
4710 * Set "copyID" in all local vars and arguments in the call stack.
4711 */
4712 int
4713set_ref_in_call_stack(int copyID)
4714{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004715 int abort = FALSE;
4716 funccall_T *fc;
4717 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004719 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004720 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004721
4722 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004723 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4724 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004725 abort = abort || set_ref_in_funccal(fc, copyID);
4726
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004727 return abort;
4728}
4729
4730/*
4731 * Set "copyID" in all functions available by name.
4732 */
4733 int
4734set_ref_in_functions(int copyID)
4735{
4736 int todo;
4737 hashitem_T *hi = NULL;
4738 int abort = FALSE;
4739 ufunc_T *fp;
4740
4741 todo = (int)func_hashtab.ht_used;
4742 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004744 if (!HASHITEM_EMPTY(hi))
4745 {
4746 --todo;
4747 fp = HI2UF(hi);
4748 if (!func_name_refcount(fp->uf_name))
4749 abort = abort || set_ref_in_func(NULL, fp, copyID);
4750 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 }
4752 return abort;
4753}
4754
4755/*
4756 * Set "copyID" in all function arguments.
4757 */
4758 int
4759set_ref_in_func_args(int copyID)
4760{
4761 int i;
4762 int abort = FALSE;
4763
4764 for (i = 0; i < funcargs.ga_len; ++i)
4765 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4766 copyID, NULL, NULL);
4767 return abort;
4768}
4769
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004770/*
4771 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004772 * Returns TRUE if setting references failed somehow.
4773 */
4774 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004775set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004776{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004777 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004778 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004779 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004780 char_u fname_buf[FLEN_FIXED + 1];
4781 char_u *tofree = NULL;
4782 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004783 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004784
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004785 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004786 return FALSE;
4787
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004788 if (fp_in == NULL)
4789 {
4790 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004791 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004792 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004793 if (fp != NULL)
4794 {
4795 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004796 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004797 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004798
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004799 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004800 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004801}
4802
Bram Moolenaare38eab22019-12-05 21:50:01 +01004803#endif // FEAT_EVAL