blob: f3c04b28af3d2f53a2c5ddc60a5e2e03dd32a1d1 [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 int vim9script = in_vim9script();
812 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200813 long sid = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100814
Bram Moolenaar333894b2020-08-01 18:53:07 +0200815 if (vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100816 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200817 // Find script-local function before global one.
818 func = find_func_with_sid(name, current_sctx.sc_sid);
819 if (func != NULL)
820 return func;
821 }
822
Bram Moolenaarefa94442020-08-08 22:16:00 +0200823 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200824 && name[1] == KS_EXTRA
825 && name[2] == KE_SNR)
826 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200827 // Caller changes s: to <SNR>99_name.
828
829 after_script = name + 3;
830 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200831 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200832 ++after_script;
833 else
834 after_script = NULL;
835 }
Bram Moolenaar333894b2020-08-01 18:53:07 +0200836 if (vim9script || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200837 {
838 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200839 if (after_script != NULL && sid != current_sctx.sc_sid)
840 imported = find_imported_in_script(after_script, 0, sid);
841 else
842 imported = find_imported(after_script == NULL
843 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200844 if (imported != NULL && imported->imp_funcname != NULL)
845 {
846 hi = hash_find(&func_hashtab, imported->imp_funcname);
847 if (!HASHITEM_EMPTY(hi))
848 return HI2UF(hi);
849 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100850 }
851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200852
Bram Moolenaara26b9702020-04-18 19:53:28 +0200853 hi = hash_find(&func_hashtab,
854 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200855 if (!HASHITEM_EMPTY(hi))
856 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100857
858 return NULL;
859}
860
861/*
862 * Find a function by name, return pointer to it in ufuncs.
863 * "cctx" is passed in a :def function to find imported functions.
864 * Return NULL for unknown or dead function.
865 */
866 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200867find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100868{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200869 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100870
871 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
872 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200873 return NULL;
874}
875
876/*
877 * Copy the function name of "fp" to buffer "buf".
878 * "buf" must be able to hold the function name plus three bytes.
879 * Takes care of script-local function names.
880 */
881 static void
882cat_func_name(char_u *buf, ufunc_T *fp)
883{
884 if (fp->uf_name[0] == K_SPECIAL)
885 {
886 STRCPY(buf, "<SNR>");
887 STRCAT(buf, fp->uf_name + 3);
888 }
889 else
890 STRCPY(buf, fp->uf_name);
891}
892
893/*
894 * Add a number variable "name" to dict "dp" with value "nr".
895 */
896 static void
897add_nr_var(
898 dict_T *dp,
899 dictitem_T *v,
900 char *name,
901 varnumber_T nr)
902{
903 STRCPY(v->di_key, name);
904 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
905 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
906 v->di_tv.v_type = VAR_NUMBER;
907 v->di_tv.v_lock = VAR_FIXED;
908 v->di_tv.vval.v_number = nr;
909}
910
911/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100912 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200913 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100914 static void
915free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200916{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100917 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200918
919 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
920 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100921 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200922
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100923 // When garbage collecting a funccall_T may be freed before the
924 // function that references it, clear its uf_scoped field.
925 // The function may have been redefined and point to another
926 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200927 if (fp != NULL && fp->uf_scoped == fc)
928 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200929 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200930 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200931
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200932 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200933 vim_free(fc);
934}
935
936/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100937 * Free "fc" and what it contains.
938 * Can be called only when "fc" is kept beyond the period of it called,
939 * i.e. after cleanup_function_call(fc).
940 */
941 static void
942free_funccal_contents(funccall_T *fc)
943{
944 listitem_T *li;
945
946 // Free all l: variables.
947 vars_clear(&fc->l_vars.dv_hashtab);
948
949 // Free all a: variables.
950 vars_clear(&fc->l_avars.dv_hashtab);
951
952 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200953 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100954 clear_tv(&li->li_tv);
955
956 free_funccal(fc);
957}
958
959/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200960 * Handle the last part of returning from a function: free the local hashtable.
961 * Unless it is still in use by a closure.
962 */
963 static void
964cleanup_function_call(funccall_T *fc)
965{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100966 int may_free_fc = fc->fc_refcount <= 0;
967 int free_fc = TRUE;
968
Bram Moolenaar6914c642017-04-01 21:21:30 +0200969 current_funccal = fc->caller;
970
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100971 // Free all l: variables if not referred.
972 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
973 vars_clear(&fc->l_vars.dv_hashtab);
974 else
975 free_fc = FALSE;
976
977 // If the a:000 list and the l: and a: dicts are not referenced and
978 // there is no closure using it, we can free the funccall_T and what's
979 // in it.
980 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
981 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200982 else
983 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100984 int todo;
985 hashitem_T *hi;
986 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200987
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100988 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200989
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100990 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200991 todo = (int)fc->l_avars.dv_hashtab.ht_used;
992 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
993 {
994 if (!HASHITEM_EMPTY(hi))
995 {
996 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100997 di = HI2DI(hi);
998 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200999 }
1000 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001001 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001002
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001003 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1004 fc->l_varlist.lv_first = NULL;
1005 else
1006 {
1007 listitem_T *li;
1008
1009 free_fc = FALSE;
1010
1011 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001012 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001013 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001014 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001015
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001016 if (free_fc)
1017 free_funccal(fc);
1018 else
1019 {
1020 static int made_copy = 0;
1021
1022 // "fc" is still in use. This can happen when returning "a:000",
1023 // assigning "l:" to a global variable or defining a closure.
1024 // Link "fc" in the list for garbage collection later.
1025 fc->caller = previous_funccal;
1026 previous_funccal = fc;
1027
1028 if (want_garbage_collect)
1029 // If garbage collector is ready, clear count.
1030 made_copy = 0;
1031 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001032 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001033 // We have made a lot of copies, worth 4 Mbyte. This can happen
1034 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001035 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001036 // too much memory.
1037 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001038 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001039 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001040 }
1041}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001042/*
1043 * Unreference "fc": decrement the reference count and free it when it
1044 * becomes zero. "fp" is detached from "fc".
1045 * When "force" is TRUE we are exiting.
1046 */
1047 static void
1048funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1049{
1050 funccall_T **pfc;
1051 int i;
1052
1053 if (fc == NULL)
1054 return;
1055
1056 if (--fc->fc_refcount <= 0 && (force || (
1057 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1058 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1059 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1060 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1061 {
1062 if (fc == *pfc)
1063 {
1064 *pfc = fc->caller;
1065 free_funccal_contents(fc);
1066 return;
1067 }
1068 }
1069 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1070 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1071 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1072}
1073
1074/*
1075 * Remove the function from the function hashtable. If the function was
1076 * deleted while it still has references this was already done.
1077 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1078 */
1079 static int
1080func_remove(ufunc_T *fp)
1081{
1082 hashitem_T *hi;
1083
1084 // Return if it was already virtually deleted.
1085 if (fp->uf_flags & FC_DEAD)
1086 return FALSE;
1087
1088 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1089 if (!HASHITEM_EMPTY(hi))
1090 {
1091 // When there is a def-function index do not actually remove the
1092 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001093 // Do remove it when it's a copy.
1094 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001095 fp->uf_flags |= FC_DEAD;
1096 else
1097 hash_remove(&func_hashtab, hi);
1098 return TRUE;
1099 }
1100 return FALSE;
1101}
1102
1103 static void
1104func_clear_items(ufunc_T *fp)
1105{
1106 ga_clear_strings(&(fp->uf_args));
1107 ga_clear_strings(&(fp->uf_def_args));
1108 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001109 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001110 VIM_CLEAR(fp->uf_def_arg_idx);
1111 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001112 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001113
1114#ifdef FEAT_LUA
1115 if (fp->uf_cb_free != NULL)
1116 {
1117 fp->uf_cb_free(fp->uf_cb_state);
1118 fp->uf_cb_free = NULL;
1119 }
1120
1121 fp->uf_cb_state = NULL;
1122 fp->uf_cb = NULL;
1123#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001124#ifdef FEAT_PROFILE
1125 VIM_CLEAR(fp->uf_tml_count);
1126 VIM_CLEAR(fp->uf_tml_total);
1127 VIM_CLEAR(fp->uf_tml_self);
1128#endif
1129}
1130
1131/*
1132 * Free all things that a function contains. Does not free the function
1133 * itself, use func_free() for that.
1134 * When "force" is TRUE we are exiting.
1135 */
1136 static void
1137func_clear(ufunc_T *fp, int force)
1138{
1139 if (fp->uf_cleared)
1140 return;
1141 fp->uf_cleared = TRUE;
1142
1143 // clear this function
1144 func_clear_items(fp);
1145 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001146 if ((fp->uf_flags & FC_COPY) == 0)
1147 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001148}
1149
1150/*
1151 * Free a function and remove it from the list of functions. Does not free
1152 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001153 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001154 */
1155 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001156func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001157{
1158 // Only remove it when not done already, otherwise we would remove a newer
1159 // version of the function with the same name.
1160 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1161 func_remove(fp);
1162
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001163 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001164 {
1165 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001166 vim_free(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001167 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001168}
1169
1170/*
1171 * Free all things that a function contains and free the function itself.
1172 * When "force" is TRUE we are exiting.
1173 */
1174 static void
1175func_clear_free(ufunc_T *fp, int force)
1176{
1177 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001178 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001179 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001180 else
1181 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001182}
1183
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001184/*
1185 * Copy already defined function "lambda" to a new function with name "global".
1186 * This is for when a compiled function defines a global function.
1187 */
1188 void
1189copy_func(char_u *lambda, char_u *global)
1190{
1191 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1192 ufunc_T *fp;
1193
1194 if (ufunc == NULL)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001195 semsg(_(e_lambda_function_not_found_str), lambda);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001196 else
1197 {
1198 // TODO: handle ! to overwrite
1199 fp = find_func(global, TRUE, NULL);
1200 if (fp != NULL)
1201 {
1202 semsg(_(e_funcexts), global);
1203 return;
1204 }
1205
1206 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1207 if (fp == NULL)
1208 return;
1209
1210 fp->uf_varargs = ufunc->uf_varargs;
1211 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1212 fp->uf_def_status = ufunc->uf_def_status;
1213 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001214 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1215 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001216 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001217 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001218 goto failed;
1219
1220 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1221 : vim_strsave(ufunc->uf_name_exp);
1222 if (ufunc->uf_arg_types != NULL)
1223 {
1224 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1225 if (fp->uf_arg_types == NULL)
1226 goto failed;
1227 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1228 sizeof(type_T *) * fp->uf_args.ga_len);
1229 }
1230 if (ufunc->uf_def_arg_idx != NULL)
1231 {
1232 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1233 if (fp->uf_def_arg_idx == NULL)
1234 goto failed;
1235 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1236 sizeof(int) * fp->uf_def_args.ga_len + 1);
1237 }
1238 if (ufunc->uf_va_name != NULL)
1239 {
1240 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1241 if (fp->uf_va_name == NULL)
1242 goto failed;
1243 }
1244
1245 fp->uf_refcount = 1;
1246 STRCPY(fp->uf_name, global);
1247 hash_add(&func_hashtab, UF2HIKEY(fp));
1248 }
1249 return;
1250
1251failed:
1252 func_clear_free(fp, TRUE);
1253}
1254
Bram Moolenaar6914c642017-04-01 21:21:30 +02001255
1256/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001257 * Call a user function.
1258 */
1259 static void
1260call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001261 ufunc_T *fp, // pointer to function
1262 int argcount, // nr of args
1263 typval_T *argvars, // arguments
1264 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001265 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001266 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001268 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001269 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001270 funccall_T *fc;
1271 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001272 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001273 static int depth = 0;
1274 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001275 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001276 int i;
1277 int ai;
1278 int islambda = FALSE;
1279 char_u numbuf[NUMBUFLEN];
1280 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001281#ifdef FEAT_PROFILE
1282 proftime_T wait_start;
1283 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001284 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001286 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287
Bram Moolenaare38eab22019-12-05 21:50:01 +01001288 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001289 if (depth >= p_mfd)
1290 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001291 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292 rettv->v_type = VAR_NUMBER;
1293 rettv->vval.v_number = -1;
1294 return;
1295 }
1296 ++depth;
1297
Bram Moolenaare38eab22019-12-05 21:50:01 +01001298 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001299
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001300 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001301 if (fc == NULL)
1302 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001303 fc->caller = current_funccal;
1304 current_funccal = fc;
1305 fc->func = fp;
1306 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001307 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001308 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1310 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001311 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001312 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001313 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001315 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001316 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001317 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001318 save_current_sctx = current_sctx;
1319 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001320
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001321 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001322 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001323 --depth;
1324 current_funccal = fc->caller;
1325
1326 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001327 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001328 free_funccal(fc);
1329 return;
1330 }
1331
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1333 islambda = TRUE;
1334
1335 /*
1336 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1337 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1338 * each argument variable and saves a lot of time.
1339 */
1340 /*
1341 * Init l: variables.
1342 */
1343 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1344 if (selfdict != NULL)
1345 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001346 // Set l:self to "selfdict". Use "name" to avoid a warning from
1347 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001348 v = &fc->fixvar[fixvar_idx++].var;
1349 name = v->di_key;
1350 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001351 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001352 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1353 v->di_tv.v_type = VAR_DICT;
1354 v->di_tv.v_lock = 0;
1355 v->di_tv.vval.v_dict = selfdict;
1356 ++selfdict->dv_refcount;
1357 }
1358
1359 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001360 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001361 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001362 * Set a:000 to a list with room for the "..." arguments.
1363 */
1364 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001365 if ((fp->uf_flags & FC_NOARGS) == 0)
1366 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001367 (varnumber_T)(argcount >= fp->uf_args.ga_len
1368 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001369 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001370 if ((fp->uf_flags & FC_NOARGS) == 0)
1371 {
1372 // Use "name" to avoid a warning from some compiler that checks the
1373 // destination size.
1374 v = &fc->fixvar[fixvar_idx++].var;
1375 name = v->di_key;
1376 STRCPY(name, "000");
1377 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1378 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1379 v->di_tv.v_type = VAR_LIST;
1380 v->di_tv.v_lock = VAR_FIXED;
1381 v->di_tv.vval.v_list = &fc->l_varlist;
1382 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001383 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001384 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1385 fc->l_varlist.lv_lock = VAR_FIXED;
1386
1387 /*
1388 * Set a:firstline to "firstline" and a:lastline to "lastline".
1389 * Set a:name to named arguments.
1390 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001391 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001393 if ((fp->uf_flags & FC_NOARGS) == 0)
1394 {
1395 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001396 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001397 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001398 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001399 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001400 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001401 {
1402 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001403 typval_T def_rettv;
1404 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001405
1406 ai = i - fp->uf_args.ga_len;
1407 if (ai < 0)
1408 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001409 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001410 name = FUNCARG(fp, i);
1411 if (islambda)
1412 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001413
1414 // evaluate named argument default expression
1415 isdefault = ai + fp->uf_def_args.ga_len >= 0
1416 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1417 && argvars[i].vval.v_number == VVAL_NONE));
1418 if (isdefault)
1419 {
1420 char_u *default_expr = NULL;
1421 def_rettv.v_type = VAR_NUMBER;
1422 def_rettv.vval.v_number = -1;
1423
1424 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1425 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001426 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001427 {
1428 default_arg_err = 1;
1429 break;
1430 }
1431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 }
1433 else
1434 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001435 if ((fp->uf_flags & FC_NOARGS) != 0)
1436 // Bail out if no a: arguments used (in lambda).
1437 break;
1438
Bram Moolenaare38eab22019-12-05 21:50:01 +01001439 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 sprintf((char *)numbuf, "%d", ai + 1);
1441 name = numbuf;
1442 }
1443 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1444 {
1445 v = &fc->fixvar[fixvar_idx++].var;
1446 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001447 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448 }
1449 else
1450 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001451 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452 if (v == NULL)
1453 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001454 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001457 // Note: the values are copied directly to avoid alloc/free.
1458 // "argvars" must have VAR_FIXED for v_lock.
1459 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 v->di_tv.v_lock = VAR_FIXED;
1461
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 if (addlocal)
1463 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001464 // Named arguments should be accessed without the "a:" prefix in
1465 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001466 copy_tv(&v->di_tv, &v->di_tv);
1467 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001468 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001469 else
1470 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001471
1472 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1473 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001474 listitem_T *li = &fc->l_listitems[ai];
1475
1476 li->li_tv = argvars[i];
1477 li->li_tv.v_lock = VAR_FIXED;
1478 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001479 }
1480 }
1481
Bram Moolenaare38eab22019-12-05 21:50:01 +01001482 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001484
1485 if (fp->uf_flags & FC_SANDBOX)
1486 {
1487 using_sandbox = TRUE;
1488 ++sandbox;
1489 }
1490
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001491 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001492 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001493 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001495 ++no_wait_return;
1496 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001497
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001498 smsg(_("calling %s"), SOURCING_NAME);
1499 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001501 char_u buf[MSG_BUF_LEN];
1502 char_u numbuf2[NUMBUFLEN];
1503 char_u *tofree;
1504 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001506 msg_puts("(");
1507 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001509 if (i > 0)
1510 msg_puts(", ");
1511 if (argvars[i].v_type == VAR_NUMBER)
1512 msg_outnum((long)argvars[i].vval.v_number);
1513 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001515 // Do not want errors such as E724 here.
1516 ++emsg_off;
1517 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1518 --emsg_off;
1519 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001521 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001523 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1524 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001526 msg_puts((char *)s);
1527 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 }
1529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001530 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001531 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001533 msg_puts("\n"); // don't overwrite this either
1534
1535 verbose_leave_scroll();
1536 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 }
1538#ifdef FEAT_PROFILE
1539 if (do_profiling == PROF_YES)
1540 {
1541 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001542 {
1543 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001546 if (fp->uf_profiling
1547 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1548 {
1549 ++fp->uf_tm_count;
1550 profile_start(&call_start);
1551 profile_zero(&fp->uf_tm_children);
1552 }
1553 script_prof_save(&wait_start);
1554 }
1555#endif
1556
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001557 save_current_sctx = current_sctx;
1558 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001559 save_did_emsg = did_emsg;
1560 did_emsg = FALSE;
1561
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001562 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1563 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001564 else if (islambda)
1565 {
1566 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1567
1568 // A Lambda always has the command "return {expr}". It is much faster
1569 // to evaluate {expr} directly.
1570 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001571 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001572 --ex_nesting_level;
1573 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001574 else
1575 // call do_cmdline() to execute the lines
1576 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1578
1579 --RedrawingDisabled;
1580
Bram Moolenaare38eab22019-12-05 21:50:01 +01001581 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1583 {
1584 clear_tv(rettv);
1585 rettv->v_type = VAR_NUMBER;
1586 rettv->vval.v_number = -1;
1587 }
1588
1589#ifdef FEAT_PROFILE
1590 if (do_profiling == PROF_YES && (fp->uf_profiling
1591 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1592 {
1593 profile_end(&call_start);
1594 profile_sub_wait(&wait_start, &call_start);
1595 profile_add(&fp->uf_tm_total, &call_start);
1596 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1597 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1598 {
1599 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1600 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1601 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001602 if (started_profiling)
1603 // make a ":profdel func" stop profiling the function
1604 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001605 }
1606#endif
1607
Bram Moolenaare38eab22019-12-05 21:50:01 +01001608 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 if (p_verbose >= 12)
1610 {
1611 ++no_wait_return;
1612 verbose_enter_scroll();
1613
1614 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001615 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001616 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001617 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618 (long)fc->rettv->vval.v_number);
1619 else
1620 {
1621 char_u buf[MSG_BUF_LEN];
1622 char_u numbuf2[NUMBUFLEN];
1623 char_u *tofree;
1624 char_u *s;
1625
Bram Moolenaare38eab22019-12-05 21:50:01 +01001626 // The value may be very long. Skip the middle part, so that we
1627 // have some idea how it starts and ends. smsg() would always
1628 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629 ++emsg_off;
1630 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1631 --emsg_off;
1632 if (s != NULL)
1633 {
1634 if (vim_strsize(s) > MSG_BUF_CLEN)
1635 {
1636 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1637 s = buf;
1638 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001639 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 vim_free(tofree);
1641 }
1642 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001643 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644
1645 verbose_leave_scroll();
1646 --no_wait_return;
1647 }
1648
Bram Moolenaare31ee862020-01-07 20:59:34 +01001649 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001650 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001651 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652#ifdef FEAT_PROFILE
1653 if (do_profiling == PROF_YES)
1654 script_prof_restore(&wait_start);
1655#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001656 if (using_sandbox)
1657 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001659 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 {
1661 ++no_wait_return;
1662 verbose_enter_scroll();
1663
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001664 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001665 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001666
1667 verbose_leave_scroll();
1668 --no_wait_return;
1669 }
1670
1671 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672 --depth;
1673
Bram Moolenaar6914c642017-04-01 21:21:30 +02001674 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675}
1676
1677/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001678 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001679 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001680 int
1681call_user_func_check(
1682 ufunc_T *fp,
1683 int argcount,
1684 typval_T *argvars,
1685 typval_T *rettv,
1686 funcexe_T *funcexe,
1687 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001688{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001689 int error;
1690 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001691
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001692 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1693 *funcexe->doesrange = TRUE;
1694 if (argcount < regular_args - fp->uf_def_args.ga_len)
1695 error = FCERR_TOOFEW;
1696 else if (!has_varargs(fp) && argcount > regular_args)
1697 error = FCERR_TOOMANY;
1698 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1699 error = FCERR_DICT;
1700 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001701 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001702 int did_save_redo = FALSE;
1703 save_redo_T save_redo;
1704
1705 /*
1706 * Call the user function.
1707 * Save and restore search patterns, script variables and
1708 * redo buffer.
1709 */
1710 save_search_patterns();
1711 if (!ins_compl_active())
1712 {
1713 saveRedobuff(&save_redo);
1714 did_save_redo = TRUE;
1715 }
1716 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001717 call_user_func(fp, argcount, argvars, rettv, funcexe,
1718 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001719 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1720 // Function was unreferenced while being used, free it now.
1721 func_clear_free(fp, FALSE);
1722 if (did_save_redo)
1723 restoreRedobuff(&save_redo);
1724 restore_search_patterns();
1725 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001726 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001727 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001728}
1729
1730/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001731 * There are two kinds of function names:
1732 * 1. ordinary names, function defined with :function
1733 * 2. numbered functions and lambdas
1734 * For the first we only count the name stored in func_hashtab as a reference,
1735 * using function() does not count as a reference, because the function is
1736 * looked up by name.
1737 */
1738 static int
1739func_name_refcount(char_u *name)
1740{
1741 return isdigit(*name) || *name == '<';
1742}
1743
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001744static funccal_entry_T *funccal_stack = NULL;
1745
1746/*
1747 * Save the current function call pointer, and set it to NULL.
1748 * Used when executing autocommands and for ":source".
1749 */
1750 void
1751save_funccal(funccal_entry_T *entry)
1752{
1753 entry->top_funccal = current_funccal;
1754 entry->next = funccal_stack;
1755 funccal_stack = entry;
1756 current_funccal = NULL;
1757}
1758
1759 void
1760restore_funccal(void)
1761{
1762 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001763 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001764 else
1765 {
1766 current_funccal = funccal_stack->top_funccal;
1767 funccal_stack = funccal_stack->next;
1768 }
1769}
1770
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001771 funccall_T *
1772get_current_funccal(void)
1773{
1774 return current_funccal;
1775}
1776
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001777/*
1778 * Mark all functions of script "sid" as deleted.
1779 */
1780 void
1781delete_script_functions(int sid)
1782{
1783 hashitem_T *hi;
1784 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001785 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001786 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001787 size_t len;
1788
1789 buf[0] = K_SPECIAL;
1790 buf[1] = KS_EXTRA;
1791 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001792 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001793 len = STRLEN(buf);
1794
Bram Moolenaarce658352020-07-31 23:47:12 +02001795 while (todo > 0)
1796 {
1797 todo = func_hashtab.ht_used;
1798 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1799 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001800 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001801 fp = HI2UF(hi);
1802 if (STRNCMP(fp->uf_name, buf, len) == 0)
1803 {
1804 int changed = func_hashtab.ht_changed;
1805
1806 fp->uf_flags |= FC_DEAD;
1807 func_clear(fp, TRUE);
1808 // When clearing a function another function can be cleared
1809 // as a side effect. When that happens start over.
1810 if (changed != func_hashtab.ht_changed)
1811 break;
1812 }
1813 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001814 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001815 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001816}
1817
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818#if defined(EXITFREE) || defined(PROTO)
1819 void
1820free_all_functions(void)
1821{
1822 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001823 ufunc_T *fp;
1824 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001825 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001826 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827
Bram Moolenaare38eab22019-12-05 21:50:01 +01001828 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001829 while (current_funccal != NULL)
1830 {
1831 clear_tv(current_funccal->rettv);
1832 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001833 if (current_funccal == NULL && funccal_stack != NULL)
1834 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001835 }
1836
Bram Moolenaare38eab22019-12-05 21:50:01 +01001837 // First clear what the functions contain. Since this may lower the
1838 // reference count of a function, it may also free a function and change
1839 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001840 while (todo > 0)
1841 {
1842 todo = func_hashtab.ht_used;
1843 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1844 if (!HASHITEM_EMPTY(hi))
1845 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001846 // clear the def function index now
1847 fp = HI2UF(hi);
1848 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001849 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001850
Bram Moolenaare38eab22019-12-05 21:50:01 +01001851 // Only free functions that are not refcounted, those are
1852 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001853 if (func_name_refcount(fp->uf_name))
1854 ++skipped;
1855 else
1856 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001857 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001858 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001859 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001860 {
1861 skipped = 0;
1862 break;
1863 }
1864 }
1865 --todo;
1866 }
1867 }
1868
Bram Moolenaare38eab22019-12-05 21:50:01 +01001869 // Now actually free the functions. Need to start all over every time,
1870 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001871 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001872 while (func_hashtab.ht_used > skipped)
1873 {
1874 todo = func_hashtab.ht_used;
1875 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001876 if (!HASHITEM_EMPTY(hi))
1877 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001878 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001879 // Only free functions that are not refcounted, those are
1880 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001881 fp = HI2UF(hi);
1882 if (func_name_refcount(fp->uf_name))
1883 ++skipped;
1884 else
1885 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001886 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001887 skipped = 0;
1888 break;
1889 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001891 }
1892 if (skipped == 0)
1893 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001894
1895 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896}
1897#endif
1898
1899/*
1900 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001901 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 * "len" is the length of "name", or -1 for NUL terminated.
1903 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001904 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001905builtin_function(char_u *name, int len)
1906{
1907 char_u *p;
1908
Bram Moolenaara26b9702020-04-18 19:53:28 +02001909 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001910 return FALSE;
1911 p = vim_strchr(name, AUTOLOAD_CHAR);
1912 return p == NULL || (len > 0 && p > name + len);
1913}
1914
1915 int
1916func_call(
1917 char_u *name,
1918 typval_T *args,
1919 partial_T *partial,
1920 dict_T *selfdict,
1921 typval_T *rettv)
1922{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001923 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001924 listitem_T *item;
1925 typval_T argv[MAX_FUNC_ARGS + 1];
1926 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 int r = 0;
1928
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001929 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001930 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001931 {
1932 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1933 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001934 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 break;
1936 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001937 // Make a copy of each argument. This is needed to be able to set
1938 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001939 copy_tv(&item->li_tv, &argv[argc++]);
1940 }
1941
1942 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001943 {
1944 funcexe_T funcexe;
1945
Bram Moolenaara80faa82020-04-12 19:37:17 +02001946 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001947 funcexe.firstline = curwin->w_cursor.lnum;
1948 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001949 funcexe.evaluate = TRUE;
1950 funcexe.partial = partial;
1951 funcexe.selfdict = selfdict;
1952 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1953 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001954
Bram Moolenaare38eab22019-12-05 21:50:01 +01001955 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956 while (argc > 0)
1957 clear_tv(&argv[--argc]);
1958
1959 return r;
1960}
1961
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001962static int callback_depth = 0;
1963
1964 int
1965get_callback_depth(void)
1966{
1967 return callback_depth;
1968}
1969
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001970/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001971 * Invoke call_func() with a callback.
1972 */
1973 int
1974call_callback(
1975 callback_T *callback,
1976 int len, // length of "name" or -1 to use strlen()
1977 typval_T *rettv, // return value goes here
1978 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001979 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001980 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001981{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001982 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001983 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001984
Bram Moolenaara80faa82020-04-12 19:37:17 +02001985 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001986 funcexe.evaluate = TRUE;
1987 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001988 ++callback_depth;
1989 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1990 --callback_depth;
1991 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001992}
1993
1994/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001995 * Give an error message for the result of a function.
1996 * Nothing if "error" is FCERR_NONE.
1997 */
1998 void
1999user_func_error(int error, char_u *name)
2000{
2001 switch (error)
2002 {
2003 case FCERR_UNKNOWN:
2004 emsg_funcname(e_unknownfunc, name);
2005 break;
2006 case FCERR_NOTMETHOD:
2007 emsg_funcname(
2008 N_("E276: Cannot use function as a method: %s"), name);
2009 break;
2010 case FCERR_DELETED:
2011 emsg_funcname(N_(e_func_deleted), name);
2012 break;
2013 case FCERR_TOOMANY:
2014 emsg_funcname((char *)e_toomanyarg, name);
2015 break;
2016 case FCERR_TOOFEW:
2017 emsg_funcname((char *)e_toofewarg, name);
2018 break;
2019 case FCERR_SCRIPT:
2020 emsg_funcname(
2021 N_("E120: Using <SID> not in a script context: %s"), name);
2022 break;
2023 case FCERR_DICT:
2024 emsg_funcname(
2025 N_("E725: Calling dict function without Dictionary: %s"),
2026 name);
2027 break;
2028 }
2029}
2030
2031/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002032 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002033 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002034 * Return FAIL when the function can't be called, OK otherwise.
2035 * Also returns OK when an error was encountered while executing the function.
2036 */
2037 int
2038call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002039 char_u *funcname, // name of the function
2040 int len, // length of "name" or -1 to use strlen()
2041 typval_T *rettv, // return value goes here
2042 int argcount_in, // number of "argvars"
2043 typval_T *argvars_in, // vars for arguments, must have "argcount"
2044 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002045 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002046{
2047 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002048 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002049 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002050 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002051 char_u fname_buf[FLEN_FIXED + 1];
2052 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002053 char_u *fname = NULL;
2054 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002055 int argcount = argcount_in;
2056 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002057 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002058 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2059 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002060 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002061 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002062 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002063
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002064 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2065 // even when call_func() returns FAIL.
2066 rettv->v_type = VAR_UNKNOWN;
2067
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002068 if (partial != NULL)
2069 fp = partial->pt_func;
2070 if (fp == NULL)
2071 {
2072 // Make a copy of the name, if it comes from a funcref variable it
2073 // could be changed or deleted in the called function.
2074 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2075 if (name == NULL)
2076 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002077
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002078 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2079 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002080
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002081 if (funcexe->doesrange != NULL)
2082 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002083
2084 if (partial != NULL)
2085 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002086 // When the function has a partial with a dict and there is a dict
2087 // argument, use the dict argument. That is backwards compatible.
2088 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002089 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002090 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002091 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002092 {
2093 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002094 {
2095 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2096 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002097 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002098 goto theend;
2099 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002100 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002101 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 for (i = 0; i < argcount_in; ++i)
2103 argv[i + argv_clear] = argvars_in[i];
2104 argvars = argv;
2105 argcount = partial->pt_argc + argcount_in;
2106 }
2107 }
2108
Bram Moolenaaref140542019-12-31 21:27:13 +01002109 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 {
2111 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002112 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002113
Bram Moolenaar333894b2020-08-01 18:53:07 +02002114 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002115 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002116 {
2117 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002118 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002119 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120
Bram Moolenaare38eab22019-12-05 21:50:01 +01002121 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002122 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002123 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002124
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002125 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002126 {
2127 /*
2128 * User defined function.
2129 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002130 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002131 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002132
Bram Moolenaare38eab22019-12-05 21:50:01 +01002133 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002134 if (fp == NULL
2135 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002136 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002137 && !aborting())
2138 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002139 // executed an autocommand, 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 Moolenaare38eab22019-12-05 21:50:01 +01002142 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002143 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2144 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002146 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002147 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002148 if (fp == NULL)
2149 {
2150 char_u *p = untrans_function_name(rfname);
2151
2152 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002153 // Don't do this if the name starts with "s:".
2154 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002155 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002156 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002157
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002158 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002159 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002160#ifdef FEAT_LUA
2161 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2162 {
2163 cfunc_T cb = fp->uf_cb;
2164
2165 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2166 }
2167#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002168 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002169 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002170 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002171 // postponed filling in the arguments, do it now
2172 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002173 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002174
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002175 if (funcexe->basetv != NULL)
2176 {
2177 // Method call: base->Method()
2178 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2179 argv[0] = *funcexe->basetv;
2180 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002181 argvars = argv;
2182 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002183 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002184
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002185 error = call_user_func_check(fp, argcount, argvars, rettv,
2186 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002187 }
2188 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002189 else if (funcexe->basetv != NULL)
2190 {
2191 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002192 * expr->method(): Find the method name in the table, call its
2193 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002194 */
2195 error = call_internal_method(fname, argcount, argvars, rettv,
2196 funcexe->basetv);
2197 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198 else
2199 {
2200 /*
2201 * Find the function name in the table, call its implementation.
2202 */
2203 error = call_internal_func(fname, argcount, argvars, rettv);
2204 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002205
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206 /*
2207 * The function call (or "FuncUndefined" autocommand sequence) might
2208 * have been aborted by an error, an interrupt, or an explicitly thrown
2209 * exception that has not been caught so far. This situation can be
2210 * tested for by calling aborting(). For an error in an internal
2211 * function or for the "E132" error in call_user_func(), however, the
2212 * throw point at which the "force_abort" flag (temporarily reset by
2213 * emsg()) is normally updated has not been reached yet. We need to
2214 * update that flag first to make aborting() reliable.
2215 */
2216 update_force_abort();
2217 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002218 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 ret = OK;
2220
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002221theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002222 /*
2223 * Report an error unless the argument evaluation or function call has been
2224 * cancelled due to an aborting error, an interrupt, or an exception.
2225 */
2226 if (!aborting())
2227 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002228 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229 }
2230
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002231 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002233 clear_tv(&argv[--argv_clear + argv_base]);
2234
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002235 vim_free(tofree);
2236 vim_free(name);
2237
2238 return ret;
2239}
2240
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002241 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002242printable_func_name(ufunc_T *fp)
2243{
2244 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2245}
2246
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002248 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002249 */
2250 static void
2251list_func_head(ufunc_T *fp, int indent)
2252{
2253 int j;
2254
2255 msg_start();
2256 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002257 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002258 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002259 msg_puts("def ");
2260 else
2261 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002262 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002263 msg_putchar('(');
2264 for (j = 0; j < fp->uf_args.ga_len; ++j)
2265 {
2266 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002267 msg_puts(", ");
2268 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002269 if (fp->uf_arg_types != NULL)
2270 {
2271 char *tofree;
2272
2273 msg_puts(": ");
2274 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2275 vim_free(tofree);
2276 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002277 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2278 {
2279 msg_puts(" = ");
2280 msg_puts(((char **)(fp->uf_def_args.ga_data))
2281 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283 }
2284 if (fp->uf_varargs)
2285 {
2286 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002287 msg_puts(", ");
2288 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002290 if (fp->uf_va_name != NULL)
2291 {
2292 if (j)
2293 msg_puts(", ");
2294 msg_puts("...");
2295 msg_puts((char *)fp->uf_va_name);
2296 if (fp->uf_va_type)
2297 {
2298 char *tofree;
2299
2300 msg_puts(": ");
2301 msg_puts(type_name(fp->uf_va_type, &tofree));
2302 vim_free(tofree);
2303 }
2304 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002306
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002307 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002308 {
2309 if (fp->uf_ret_type != &t_void)
2310 {
2311 char *tofree;
2312
2313 msg_puts(": ");
2314 msg_puts(type_name(fp->uf_ret_type, &tofree));
2315 vim_free(tofree);
2316 }
2317 }
2318 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002319 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002321 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002322 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002323 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002324 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002325 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326 msg_clr_eos();
2327 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002328 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002329}
2330
2331/*
2332 * Get a function name, translating "<SID>" and "<SNR>".
2333 * Also handles a Funcref in a List or Dictionary.
2334 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002335 * Set "*is_global" to TRUE when the function must be global, unless
2336 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002337 * flags:
2338 * TFN_INT: internal function name OK
2339 * TFN_QUIET: be quiet
2340 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002341 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002342 * Advances "pp" to just after the function name (if no error).
2343 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002344 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345trans_function_name(
2346 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002347 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002348 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002350 funcdict_T *fdp, // return: info about dictionary used
2351 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352{
2353 char_u *name = NULL;
2354 char_u *start;
2355 char_u *end;
2356 int lead;
2357 char_u sid_buf[20];
2358 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002359 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002360 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002361 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362
2363 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002364 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002365 start = *pp;
2366
Bram Moolenaare38eab22019-12-05 21:50:01 +01002367 // Check for hard coded <SNR>: already translated function ID (from a user
2368 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2370 && (*pp)[2] == (int)KE_SNR)
2371 {
2372 *pp += 3;
2373 len = get_id_len(pp) + 3;
2374 return vim_strnsave(start, len);
2375 }
2376
Bram Moolenaare38eab22019-12-05 21:50:01 +01002377 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2378 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 lead = eval_fname_script(start);
2380 if (lead > 2)
2381 start += lead;
2382
Bram Moolenaare38eab22019-12-05 21:50:01 +01002383 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002384 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 lead > 2 ? 0 : FNE_CHECK_START);
2386 if (end == start)
2387 {
2388 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002389 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390 goto theend;
2391 }
2392 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2393 {
2394 /*
2395 * Report an invalid expression in braces, unless the expression
2396 * evaluation has been cancelled due to an aborting error, an
2397 * interrupt, or an exception.
2398 */
2399 if (!aborting())
2400 {
2401 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002402 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002403 }
2404 else
2405 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2406 goto theend;
2407 }
2408
2409 if (lv.ll_tv != NULL)
2410 {
2411 if (fdp != NULL)
2412 {
2413 fdp->fd_dict = lv.ll_dict;
2414 fdp->fd_newkey = lv.ll_newkey;
2415 lv.ll_newkey = NULL;
2416 fdp->fd_di = lv.ll_di;
2417 }
2418 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2419 {
2420 name = vim_strsave(lv.ll_tv->vval.v_string);
2421 *pp = end;
2422 }
2423 else if (lv.ll_tv->v_type == VAR_PARTIAL
2424 && lv.ll_tv->vval.v_partial != NULL)
2425 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002426 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002427 *pp = end;
2428 if (partial != NULL)
2429 *partial = lv.ll_tv->vval.v_partial;
2430 }
2431 else
2432 {
2433 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2434 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002435 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436 else
2437 *pp = end;
2438 name = NULL;
2439 }
2440 goto theend;
2441 }
2442
2443 if (lv.ll_name == NULL)
2444 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002445 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 *pp = end;
2447 goto theend;
2448 }
2449
Bram Moolenaare38eab22019-12-05 21:50:01 +01002450 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451 if (lv.ll_exp_name != NULL)
2452 {
2453 len = (int)STRLEN(lv.ll_exp_name);
2454 name = deref_func_name(lv.ll_exp_name, &len, partial,
2455 flags & TFN_NO_AUTOLOAD);
2456 if (name == lv.ll_exp_name)
2457 name = NULL;
2458 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002459 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460 {
2461 len = (int)(end - *pp);
2462 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2463 if (name == *pp)
2464 name = NULL;
2465 }
2466 if (name != NULL)
2467 {
2468 name = vim_strsave(name);
2469 *pp = end;
2470 if (STRNCMP(name, "<SNR>", 5) == 0)
2471 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002472 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473 name[0] = K_SPECIAL;
2474 name[1] = KS_EXTRA;
2475 name[2] = (int)KE_SNR;
2476 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2477 }
2478 goto theend;
2479 }
2480
2481 if (lv.ll_exp_name != NULL)
2482 {
2483 len = (int)STRLEN(lv.ll_exp_name);
2484 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2485 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2486 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002487 // When there was "s:" already or the name expanded to get a
2488 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 lv.ll_name += 2;
2490 len -= 2;
2491 lead = 2;
2492 }
2493 }
2494 else
2495 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002496 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002498 {
2499 if (is_global != NULL && lv.ll_name[0] == 'g')
2500 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002502 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503 len = (int)(end - lv.ll_name);
2504 }
2505
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002506 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002507 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 /*
2510 * Copy the function name to allocated memory.
2511 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2512 * Accept <SNR>123_name() outside a script.
2513 */
2514 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002515 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002516 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002517 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002518 if (!vim9script)
2519 lead = 3;
2520 if (vim9script || (lv.ll_exp_name != NULL
2521 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 || eval_fname_sid(*pp))
2523 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002524 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002525 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002527 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 goto theend;
2529 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002530 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002531 if (vim9script)
2532 extra = 3 + (int)STRLEN(sid_buf);
2533 else
2534 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 }
2536 }
2537 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2538 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002539 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 start);
2541 goto theend;
2542 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002543 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 {
2545 char_u *cp = vim_strchr(lv.ll_name, ':');
2546
2547 if (cp != NULL && cp < end)
2548 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002549 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002550 goto theend;
2551 }
2552 }
2553
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002554 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555 if (name != NULL)
2556 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002557 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 {
2559 name[0] = K_SPECIAL;
2560 name[1] = KS_EXTRA;
2561 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002562 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002563 STRCPY(name + 3, sid_buf);
2564 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002565 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2566 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002567 }
2568 *pp = end;
2569
2570theend:
2571 clear_lval(&lv);
2572 return name;
2573}
2574
2575/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002576 * Assuming "name" is the result of trans_function_name() and it was prefixed
2577 * to use the script-local name, return the unmodified name (points into
2578 * "name"). Otherwise return NULL.
2579 * This can be used to first search for a script-local function and fall back
2580 * to the global function if not found.
2581 */
2582 char_u *
2583untrans_function_name(char_u *name)
2584{
2585 char_u *p;
2586
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002587 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002588 {
2589 p = vim_strchr(name, '_');
2590 if (p != NULL)
2591 return p + 1;
2592 }
2593 return NULL;
2594}
2595
2596/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002597 * List functions. When "regmatch" is NULL all of then.
2598 * Otherwise functions matching "regmatch".
2599 */
2600 static void
2601list_functions(regmatch_T *regmatch)
2602{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002603 int changed = func_hashtab.ht_changed;
2604 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002605 hashitem_T *hi;
2606
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002607 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002608 {
2609 if (!HASHITEM_EMPTY(hi))
2610 {
2611 ufunc_T *fp = HI2UF(hi);
2612
2613 --todo;
2614 if ((fp->uf_flags & FC_DEAD) == 0
2615 && (regmatch == NULL
2616 ? !message_filtered(fp->uf_name)
2617 && !func_name_refcount(fp->uf_name)
2618 : !isdigit(*fp->uf_name)
2619 && vim_regexec(regmatch, fp->uf_name, 0)))
2620 {
2621 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002622 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002623 {
2624 emsg(_("E454: function list was modified"));
2625 return;
2626 }
2627 }
2628 }
2629 }
2630}
2631
2632/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002633 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002634 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2635 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002636 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002638 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002639def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640{
2641 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002642 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 int j;
2644 int c;
2645 int saved_did_emsg;
2646 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002647 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002648 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 char_u *p;
2650 char_u *arg;
2651 char_u *line_arg = NULL;
2652 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002653 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002654 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 garray_T newlines;
2656 int varargs = FALSE;
2657 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002658 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002659 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002660 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 int indent;
2662 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002663#define MAX_FUNC_NESTING 50
2664 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 dictitem_T *v;
2666 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002667 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669 hashitem_T *hi;
Bram Moolenaar66250c92020-08-20 15:02:42 +02002670 getline_opt_T getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002671 linenr_T sourcing_lnum_off;
2672 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002673 int is_heredoc = FALSE;
2674 char_u *skip_until = NULL;
2675 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002676 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002677 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678
2679 /*
2680 * ":function" without argument: list functions.
2681 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002682 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683 {
2684 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002685 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002687 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688 }
2689
2690 /*
2691 * ":function /pat": list functions matching pattern.
2692 */
2693 if (*eap->arg == '/')
2694 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002695 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 if (!eap->skip)
2697 {
2698 regmatch_T regmatch;
2699
2700 c = *p;
2701 *p = NUL;
2702 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2703 *p = c;
2704 if (regmatch.regprog != NULL)
2705 {
2706 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002707 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 vim_regfree(regmatch.regprog);
2709 }
2710 }
2711 if (*p == '/')
2712 ++p;
2713 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002714 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 }
2716
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002717 ga_init(&newargs);
2718 ga_init(&argtypes);
2719 ga_init(&default_args);
2720
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 /*
2722 * Get the function name. There are these situations:
2723 * func normal function name
2724 * "name" == func, "fudi.fd_dict" == NULL
2725 * dict.func new dictionary entry
2726 * "name" == NULL, "fudi.fd_dict" set,
2727 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2728 * dict.func existing dict entry with a Funcref
2729 * "name" == func, "fudi.fd_dict" set,
2730 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2731 * dict.func existing dict entry that's not a Funcref
2732 * "name" == NULL, "fudi.fd_dict" set,
2733 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2734 * s:func script-local function name
2735 * g:func global function name, same as "func"
2736 */
2737 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002738 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002740 // nested function, argument is (args).
2741 paren = TRUE;
2742 CLEAR_FIELD(fudi);
2743 }
2744 else
2745 {
2746 name = trans_function_name(&p, &is_global, eap->skip,
2747 TFN_NO_AUTOLOAD, &fudi, NULL);
2748 paren = (vim_strchr(p, '(') != NULL);
2749 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002751 /*
2752 * Return on an invalid expression in braces, unless the expression
2753 * evaluation has been cancelled due to an aborting error, an
2754 * interrupt, or an exception.
2755 */
2756 if (!aborting())
2757 {
2758 if (!eap->skip && fudi.fd_newkey != NULL)
2759 semsg(_(e_dictkey), fudi.fd_newkey);
2760 vim_free(fudi.fd_newkey);
2761 return NULL;
2762 }
2763 else
2764 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 }
2767
Bram Moolenaare38eab22019-12-05 21:50:01 +01002768 // An error in a function call during evaluation of an expression in magic
2769 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 saved_did_emsg = did_emsg;
2771 did_emsg = FALSE;
2772
2773 /*
2774 * ":function func" with only function name: list function.
2775 */
2776 if (!paren)
2777 {
2778 if (!ends_excmd(*skipwhite(p)))
2779 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002780 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 goto ret_free;
2782 }
2783 eap->nextcmd = check_nextcmd(p);
2784 if (eap->nextcmd != NULL)
2785 *p = NUL;
2786 if (!eap->skip && !got_int)
2787 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002788 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002789 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2790 {
2791 char_u *up = untrans_function_name(name);
2792
2793 // With Vim9 script the name was made script-local, if not
2794 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002795 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002796 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002797 }
2798
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 if (fp != NULL)
2800 {
2801 list_func_head(fp, TRUE);
2802 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2803 {
2804 if (FUNCLINE(fp, j) == NULL)
2805 continue;
2806 msg_putchar('\n');
2807 msg_outnum((long)(j + 1));
2808 if (j < 9)
2809 msg_putchar(' ');
2810 if (j < 99)
2811 msg_putchar(' ');
2812 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002813 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 ui_breakcheck();
2815 }
2816 if (!got_int)
2817 {
2818 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002819 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002820 msg_puts(" enddef");
2821 else
2822 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002823 }
2824 }
2825 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002826 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 }
2828 goto ret_free;
2829 }
2830
2831 /*
2832 * ":function name(arg1, arg2)" Define function.
2833 */
2834 p = skipwhite(p);
2835 if (*p != '(')
2836 {
2837 if (!eap->skip)
2838 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002839 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840 goto ret_free;
2841 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002842 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 if (vim_strchr(p, '(') != NULL)
2844 p = vim_strchr(p, '(');
2845 }
2846 p = skipwhite(p + 1);
2847
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002848 // In Vim9 script only global functions can be redefined.
2849 if (vim9script && eap->forceit && !is_global)
2850 {
2851 emsg(_(e_nobang));
2852 goto ret_free;
2853 }
2854
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2856
Bram Moolenaar04b12692020-05-04 23:24:44 +02002857 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002859 // Check the name of the function. Unless it's a dictionary function
2860 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 if (name != NULL)
2862 arg = name;
2863 else
2864 arg = fudi.fd_newkey;
2865 if (arg != NULL && (fudi.fd_di == NULL
2866 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2867 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2868 {
2869 if (*arg == K_SPECIAL)
2870 j = 3;
2871 else
2872 j = 0;
2873 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2874 : eval_isnamec(arg[j])))
2875 ++j;
2876 if (arg[j] != NUL)
2877 emsg_funcname((char *)e_invarg2, arg);
2878 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002879 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002881 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002882 }
2883
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002884 // This may get more lines and make the pointers into the first line
2885 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002886 if (get_function_args(&p, ')', &newargs,
2887 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002888 &varargs, &default_args, eap->skip,
2889 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 goto errret_2;
2891
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002892 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002894 // find the return type: :def Func(): type
2895 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002897 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002898 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002899 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002900 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002901 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002903 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002904 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002905 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002906 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002907 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002908 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002909 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002910 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002912 else
2913 // find extra arguments "range", "dict", "abort" and "closure"
2914 for (;;)
2915 {
2916 p = skipwhite(p);
2917 if (STRNCMP(p, "range", 5) == 0)
2918 {
2919 flags |= FC_RANGE;
2920 p += 5;
2921 }
2922 else if (STRNCMP(p, "dict", 4) == 0)
2923 {
2924 flags |= FC_DICT;
2925 p += 4;
2926 }
2927 else if (STRNCMP(p, "abort", 5) == 0)
2928 {
2929 flags |= FC_ABORT;
2930 p += 5;
2931 }
2932 else if (STRNCMP(p, "closure", 7) == 0)
2933 {
2934 flags |= FC_CLOSURE;
2935 p += 7;
2936 if (current_funccal == NULL)
2937 {
2938 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2939 name == NULL ? (char_u *)"" : name);
2940 goto erret;
2941 }
2942 }
2943 else
2944 break;
2945 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946
Bram Moolenaare38eab22019-12-05 21:50:01 +01002947 // When there is a line break use what follows for the function body.
2948 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949 if (*p == '\n')
2950 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002951 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002952 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2953 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002954 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2955 && !eap->skip
2956 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002957 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958
2959 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002960 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2961 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002962 */
2963 if (KeyTyped)
2964 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002965 // Check if the function already exists, don't let the user type the
2966 // whole function before telling him it doesn't work! For a script we
2967 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 if (!eap->skip && !eap->forceit)
2969 {
2970 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002971 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002972 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002973 emsg_funcname(e_funcexts, name);
2974 }
2975
2976 if (!eap->skip && did_emsg)
2977 goto erret;
2978
Bram Moolenaare38eab22019-12-05 21:50:01 +01002979 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980 cmdline_row = msg_row;
2981 }
2982
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002983 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002984 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002985
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002986 // Detect having skipped over comment lines to find the return
2987 // type. Add NULL lines to keep the line count correct.
2988 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2989 if (SOURCING_LNUM < sourcing_lnum_off)
2990 {
2991 sourcing_lnum_off -= SOURCING_LNUM;
2992 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
2993 goto erret;
2994 while (sourcing_lnum_off-- > 0)
2995 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2996 }
2997
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 indent = 2;
2999 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003000 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 for (;;)
3002 {
3003 if (KeyTyped)
3004 {
3005 msg_scroll = TRUE;
3006 saved_wait_return = FALSE;
3007 }
3008 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009
3010 if (line_arg != NULL)
3011 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003012 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013 theline = line_arg;
3014 p = vim_strchr(theline, '\n');
3015 if (p == NULL)
3016 line_arg += STRLEN(line_arg);
3017 else
3018 {
3019 *p = NUL;
3020 line_arg = p + 1;
3021 }
3022 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003024 {
3025 vim_free(line_to_free);
3026 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003027 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003028 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003029 theline = eap->getline(':', eap->cookie, indent,
3030 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003031 line_to_free = theline;
3032 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 if (KeyTyped)
3034 lines_left = Rows - 1;
3035 if (theline == NULL)
3036 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003037 if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003038 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003039 else
3040 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 goto erret;
3042 }
3043
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003044 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003045 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003046 if (SOURCING_LNUM < sourcing_lnum_off)
3047 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048 else
3049 sourcing_lnum_off = 0;
3050
3051 if (skip_until != NULL)
3052 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003053 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003054 // * ":append" and "."
3055 // * ":python <<EOF" and "EOF"
3056 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3057 if (heredoc_trimmed == NULL
3058 || (is_heredoc && skipwhite(theline) == theline)
3059 || STRNCMP(theline, heredoc_trimmed,
3060 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003061 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003062 if (heredoc_trimmed == NULL)
3063 p = theline;
3064 else if (is_heredoc)
3065 p = skipwhite(theline) == theline
3066 ? theline : theline + STRLEN(heredoc_trimmed);
3067 else
3068 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003069 if (STRCMP(p, skip_until) == 0)
3070 {
3071 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003072 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003073 getline_options = GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003074 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003075 }
3076 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077 }
3078 else
3079 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003080 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003081 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082 ;
3083
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003084 // Check for "endfunction" or "enddef".
3085 if (checkforcmd(&p, nesting_def[nesting]
3086 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003088 char_u *nextcmd = NULL;
3089
Bram Moolenaar663bb232017-06-22 19:12:10 +02003090 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003091 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003092 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003093 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003094 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003095 give_warning2(eap->cmdidx == CMD_def
3096 ? (char_u *)_("W1001: Text found after :enddef: %s")
3097 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003098 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003099 if (nextcmd != NULL)
3100 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003101 // Another command follows. If the line came from "eap" we
3102 // can simply point into it, otherwise we need to change
3103 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003104 eap->nextcmd = nextcmd;
3105 if (line_to_free != NULL)
3106 {
3107 vim_free(*eap->cmdlinep);
3108 *eap->cmdlinep = line_to_free;
3109 line_to_free = NULL;
3110 }
3111 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 break;
3113 }
3114
Bram Moolenaare38eab22019-12-05 21:50:01 +01003115 // Increase indent inside "if", "while", "for" and "try", decrease
3116 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003117 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118 indent -= 2;
3119 else if (STRNCMP(p, "if", 2) == 0
3120 || STRNCMP(p, "wh", 2) == 0
3121 || STRNCMP(p, "for", 3) == 0
3122 || STRNCMP(p, "try", 3) == 0)
3123 indent += 2;
3124
Bram Moolenaare38eab22019-12-05 21:50:01 +01003125 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003126 // Only recognize "def" inside "def", not inside "function",
3127 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003128 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003129 if (checkforcmd(&p, "function", 2)
3130 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 {
3132 if (*p == '!')
3133 p = skipwhite(p + 1);
3134 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003135 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136 if (*skipwhite(p) == '(')
3137 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003138 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003139 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003140 else
3141 {
3142 ++nesting;
3143 nesting_def[nesting] = (c == 'd');
3144 indent += 2;
3145 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146 }
3147 }
3148
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003149 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003150 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003151 if (eap->cmdidx != CMD_def
3152 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003153 || (p[0] == 'c'
3154 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3155 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3156 && (STRNCMP(&p[3], "nge", 3) != 0
3157 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003158 || (p[0] == 'i'
3159 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003160 && (!ASCII_ISALPHA(p[2])
3161 || (p[2] == 's'
3162 && (!ASCII_ISALPHA(p[3])
3163 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 skip_until = vim_strsave((char_u *)".");
3165
Bram Moolenaare38eab22019-12-05 21:50:01 +01003166 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 arg = skipwhite(skiptowhite(p));
3168 if (arg[0] == '<' && arg[1] =='<'
3169 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003170 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3171 || ((p[2] == '3' || p[2] == 'x')
3172 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173 || (p[0] == 'p' && p[1] == 'e'
3174 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3175 || (p[0] == 't' && p[1] == 'c'
3176 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3177 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3178 && !ASCII_ISALPHA(p[3]))
3179 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3180 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3181 || (p[0] == 'm' && p[1] == 'z'
3182 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3183 ))
3184 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003185 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003187 if (STRNCMP(p, "trim", 4) == 0)
3188 {
3189 // Ignore leading white space.
3190 p = skipwhite(p + 4);
3191 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003192 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003193 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 if (*p == NUL)
3195 skip_until = vim_strsave((char_u *)".");
3196 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003197 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003198 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003199 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003201
3202 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003203 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003204 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003205 if (*arg == '[')
3206 arg = vim_strchr(arg, ']');
3207 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003208 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003209 arg = skipwhite(skiptowhite(arg));
3210 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3211 && ((p[0] == 'l'
3212 && p[1] == 'e'
3213 && (!ASCII_ISALNUM(p[2])
3214 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003215 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003216 p = skipwhite(arg + 3);
3217 if (STRNCMP(p, "trim", 4) == 0)
3218 {
3219 // Ignore leading white space.
3220 p = skipwhite(p + 4);
3221 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003222 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003223 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003224 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003225 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003226 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003227 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003228 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 }
3230
Bram Moolenaare38eab22019-12-05 21:50:01 +01003231 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234
Bram Moolenaare38eab22019-12-05 21:50:01 +01003235 // Copy the line to newly allocated memory. get_one_sourceline()
3236 // allocates 250 bytes per line, this saves 80% on average. The cost
3237 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003238 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003239 if (p == NULL)
3240 goto erret;
3241 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242
Bram Moolenaare38eab22019-12-05 21:50:01 +01003243 // Add NULL lines for continuation lines, so that the line count is
3244 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 while (sourcing_lnum_off-- > 0)
3246 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3247
Bram Moolenaare38eab22019-12-05 21:50:01 +01003248 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 if (line_arg != NULL && *line_arg == NUL)
3250 line_arg = NULL;
3251 }
3252
Bram Moolenaare38eab22019-12-05 21:50:01 +01003253 // Don't define the function when skipping commands or when an error was
3254 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255 if (eap->skip || did_emsg)
3256 goto erret;
3257
3258 /*
3259 * If there are no errors, add the function
3260 */
3261 if (fudi.fd_dict == NULL)
3262 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003263 hashtab_T *ht;
3264
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 v = find_var(name, &ht, FALSE);
3266 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3267 {
3268 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3269 name);
3270 goto erret;
3271 }
3272
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003273 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003274 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003276 char_u *uname = untrans_function_name(name);
3277
3278 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3279 }
3280
3281 if (fp != NULL || import != NULL)
3282 {
3283 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003285 // Function can be replaced with "function!" and when sourcing the
3286 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003287 // A name that is used by an import can not be overruled.
3288 if (import != NULL
3289 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003290 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003291 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003293 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003294 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003295 else
3296 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 goto erret;
3298 }
3299 if (fp->uf_calls > 0)
3300 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003301 emsg_funcname(
3302 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 name);
3304 goto erret;
3305 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003306 if (fp->uf_refcount > 1)
3307 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003308 // This function is referenced somewhere, don't redefine it but
3309 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003310 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003311 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003312 fp = NULL;
3313 overwrite = TRUE;
3314 }
3315 else
3316 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003317 char_u *exp_name = fp->uf_name_exp;
3318
3319 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003320 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003321 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003322 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003323 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003324 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003325#ifdef FEAT_PROFILE
3326 fp->uf_profiling = FALSE;
3327 fp->uf_prof_initialized = FALSE;
3328#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003329 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003330 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 }
3332 }
3333 else
3334 {
3335 char numbuf[20];
3336
3337 fp = NULL;
3338 if (fudi.fd_newkey == NULL && !eap->forceit)
3339 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003340 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 goto erret;
3342 }
3343 if (fudi.fd_di == NULL)
3344 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003345 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003346 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 goto erret;
3348 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003349 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003350 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 goto erret;
3352
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 // Give the function a sequential number. Can only be used with a
3354 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355 vim_free(name);
3356 sprintf(numbuf, "%d", ++func_nr);
3357 name = vim_strsave((char_u *)numbuf);
3358 if (name == NULL)
3359 goto erret;
3360 }
3361
3362 if (fp == NULL)
3363 {
3364 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3365 {
3366 int slen, plen;
3367 char_u *scriptname;
3368
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003371 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 {
3373 scriptname = autoload_name(name);
3374 if (scriptname != NULL)
3375 {
3376 p = vim_strchr(scriptname, '/');
3377 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003378 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003380 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 j = OK;
3382 vim_free(scriptname);
3383 }
3384 }
3385 if (j == FAIL)
3386 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003387 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 goto erret;
3389 }
3390 }
3391
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003392 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 if (fp == NULL)
3394 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003395 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003396 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397
3398 if (fudi.fd_dict != NULL)
3399 {
3400 if (fudi.fd_di == NULL)
3401 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003402 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3404 if (fudi.fd_di == NULL)
3405 {
3406 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003407 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 goto erret;
3409 }
3410 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3411 {
3412 vim_free(fudi.fd_di);
3413 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003414 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003415 goto erret;
3416 }
3417 }
3418 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003419 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 clear_tv(&fudi.fd_di->di_tv);
3421 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423
Bram Moolenaare38eab22019-12-05 21:50:01 +01003424 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 flags |= FC_DICT;
3426 }
3427
Bram Moolenaare38eab22019-12-05 21:50:01 +01003428 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003429 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003430 if (overwrite)
3431 {
3432 hi = hash_find(&func_hashtab, name);
3433 hi->hi_key = UF2HIKEY(fp);
3434 }
3435 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 {
3437 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003438 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 goto erret;
3440 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003441 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 }
3443 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003444 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003445 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003446 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003447
3448 if (eap->cmdidx == CMD_def)
3449 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003450 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003451
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003452 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003453
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003454 // error messages are for the first function line
3455 SOURCING_LNUM = sourcing_lnum_top;
3456
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003457 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003458 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459
3460 if (argtypes.ga_len > 0)
3461 {
3462 // When "varargs" is set the last name/type goes into uf_va_name
3463 // and uf_va_type.
3464 int len = argtypes.ga_len - (varargs ? 1 : 0);
3465
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003466 if (len > 0)
3467 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003468 if (fp->uf_arg_types != NULL)
3469 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003470 int i;
3471 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003472
3473 for (i = 0; i < len; ++ i)
3474 {
3475 p = ((char_u **)argtypes.ga_data)[i];
3476 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003477 // will get the type from the default value
3478 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003479 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003480 type = parse_type(&p, &fp->uf_type_list);
3481 if (type == NULL)
3482 {
3483 SOURCING_LNUM = lnum_save;
3484 goto errret_2;
3485 }
3486 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003487 }
3488 }
3489 if (varargs)
3490 {
3491 // Move the last argument "...name: type" to uf_va_name and
3492 // uf_va_type.
3493 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3494 [fp->uf_args.ga_len - 1];
3495 --fp->uf_args.ga_len;
3496 p = ((char_u **)argtypes.ga_data)[len];
3497 if (p == NULL)
3498 // todo: get type from default value
3499 fp->uf_va_type = &t_any;
3500 else
3501 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003502 if (fp->uf_va_type == NULL)
3503 {
3504 SOURCING_LNUM = lnum_save;
3505 goto errret_2;
3506 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003507 }
3508 varargs = FALSE;
3509 }
3510
3511 // parse the return type, if any
3512 if (ret_type == NULL)
3513 fp->uf_ret_type = &t_void;
3514 else
3515 {
3516 p = ret_type;
3517 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3518 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003519 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003520 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003521 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003522 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003523
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003524 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003525 if ((flags & FC_CLOSURE) != 0)
3526 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003527 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003528 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003529 }
3530 else
3531 fp->uf_scoped = NULL;
3532
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534 if (prof_def_func())
3535 func_do_profile(fp);
3536#endif
3537 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003538 if (sandbox)
3539 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003540 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003541 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 fp->uf_flags = flags;
3543 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003544 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003545 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003546 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003547 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003548 if (is_export)
3549 {
3550 fp->uf_flags |= FC_EXPORT;
3551 // let ex_export() know the export worked.
3552 is_export = FALSE;
3553 }
3554
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003555 if (eap->cmdidx == CMD_def)
3556 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003557 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3558 // :func does not use Vim9 script syntax, even in a Vim9 script file
3559 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003560
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 goto ret_free;
3562
3563erret:
3564 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003565 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566errret_2:
3567 ga_clear_strings(&newlines);
3568ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003569 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003571 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003573 if (name != name_arg)
3574 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003575 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 did_emsg |= saved_did_emsg;
3577 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003578
3579 return fp;
3580}
3581
3582/*
3583 * ":function"
3584 */
3585 void
3586ex_function(exarg_T *eap)
3587{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003588 (void)def_function(eap, NULL);
3589}
3590
3591/*
3592 * :defcompile - compile all :def functions in the current script.
3593 */
3594 void
3595ex_defcompile(exarg_T *eap UNUSED)
3596{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003597 long todo = (long)func_hashtab.ht_used;
3598 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003599 hashitem_T *hi;
3600 ufunc_T *ufunc;
3601
3602 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3603 {
3604 if (!HASHITEM_EMPTY(hi))
3605 {
3606 --todo;
3607 ufunc = HI2UF(hi);
3608 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003609 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003610 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003611 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003612
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003613 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003614 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003615 // a function has been added or removed, need to start over
3616 todo = (long)func_hashtab.ht_used;
3617 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003618 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003619 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003620 }
3621 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003622 }
3623 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624}
3625
3626/*
3627 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3628 * Return 2 if "p" starts with "s:".
3629 * Return 0 otherwise.
3630 */
3631 int
3632eval_fname_script(char_u *p)
3633{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003634 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3635 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3637 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3638 return 5;
3639 if (p[0] == 's' && p[1] == ':')
3640 return 2;
3641 return 0;
3642}
3643
3644 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003645translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646{
3647 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003648 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003649 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003650}
3651
3652/*
3653 * Return TRUE when "ufunc" has old-style "..." varargs
3654 * or named varargs "...name: type".
3655 */
3656 int
3657has_varargs(ufunc_T *ufunc)
3658{
3659 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660}
3661
3662/*
3663 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003664 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 */
3666 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003667function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668{
3669 char_u *nm = name;
3670 char_u *p;
3671 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003672 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003673 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003675 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3676 if (no_deref)
3677 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003678 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 nm = skipwhite(nm);
3680
Bram Moolenaare38eab22019-12-05 21:50:01 +01003681 // Only accept "funcname", "funcname ", "funcname (..." and
3682 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003684 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 vim_free(p);
3686 return n;
3687}
3688
Bram Moolenaar113e1072019-01-20 15:30:40 +01003689#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690 char_u *
3691get_expanded_name(char_u *name, int check)
3692{
3693 char_u *nm = name;
3694 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003695 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003697 p = trans_function_name(&nm, &is_global, FALSE,
3698 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003700 if (p != NULL && *nm == NUL
3701 && (!check || translated_function_exists(p, is_global)))
3702 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703
3704 vim_free(p);
3705 return NULL;
3706}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003707#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709/*
3710 * Function given to ExpandGeneric() to obtain the list of user defined
3711 * function names.
3712 */
3713 char_u *
3714get_user_func_name(expand_T *xp, int idx)
3715{
3716 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003717 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718 static hashitem_T *hi;
3719 ufunc_T *fp;
3720
3721 if (idx == 0)
3722 {
3723 done = 0;
3724 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003725 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003727 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003728 {
3729 if (done++ > 0)
3730 ++hi;
3731 while (HASHITEM_EMPTY(hi))
3732 ++hi;
3733 fp = HI2UF(hi);
3734
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735 // don't show dead, dict and lambda functions
3736 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003737 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003738 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739
3740 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003741 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742
3743 cat_func_name(IObuff, fp);
3744 if (xp->xp_context != EXPAND_USER_FUNC)
3745 {
3746 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003747 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003748 STRCAT(IObuff, ")");
3749 }
3750 return IObuff;
3751 }
3752 return NULL;
3753}
3754
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755/*
3756 * ":delfunction {name}"
3757 */
3758 void
3759ex_delfunction(exarg_T *eap)
3760{
3761 ufunc_T *fp = NULL;
3762 char_u *p;
3763 char_u *name;
3764 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003765 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766
3767 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003768 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 vim_free(fudi.fd_newkey);
3770 if (name == NULL)
3771 {
3772 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003773 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 return;
3775 }
3776 if (!ends_excmd(*skipwhite(p)))
3777 {
3778 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003779 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 return;
3781 }
3782 eap->nextcmd = check_nextcmd(p);
3783 if (eap->nextcmd != NULL)
3784 *p = NUL;
3785
3786 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003787 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 vim_free(name);
3789
3790 if (!eap->skip)
3791 {
3792 if (fp == NULL)
3793 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003794 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003795 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 return;
3797 }
3798 if (fp->uf_calls > 0)
3799 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003800 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 return;
3802 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003803 if (fp->uf_flags & FC_VIM9)
3804 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003805 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003806 return;
3807 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808
3809 if (fudi.fd_dict != NULL)
3810 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003811 // Delete the dict item that refers to the function, it will
3812 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3814 }
3815 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003816 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003817 // A normal function (not a numbered function or lambda) has a
3818 // refcount of 1 for the entry in the hashtable. When deleting
3819 // it and the refcount is more than one, it should be kept.
3820 // A numbered function and lambda should be kept if the refcount is
3821 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003822 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003823 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003824 // Function is still referenced somewhere. Don't free it but
3825 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003826 if (func_remove(fp))
3827 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003828 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003829 }
3830 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003831 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003832 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 }
3834}
3835
3836/*
3837 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003838 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003839 */
3840 void
3841func_unref(char_u *name)
3842{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003843 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003845 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003847 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003848 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003851 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003853 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003855 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003856 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003857 // Only delete it when it's not being used. Otherwise it's done
3858 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003859 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003860 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003861 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003862}
3863
3864/*
3865 * Unreference a Function: decrement the reference count and free it when it
3866 * becomes zero.
3867 */
3868 void
3869func_ptr_unref(ufunc_T *fp)
3870{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003871 if (fp != NULL && --fp->uf_refcount <= 0)
3872 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003873 // Only delete it when it's not being used. Otherwise it's done
3874 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003875 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003876 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 }
3878}
3879
3880/*
3881 * Count a reference to a Function.
3882 */
3883 void
3884func_ref(char_u *name)
3885{
3886 ufunc_T *fp;
3887
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003888 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003889 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003890 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003891 if (fp != NULL)
3892 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003893 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003894 // Only give an error for a numbered function.
3895 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003896 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003897}
3898
3899/*
3900 * Count a reference to a Function.
3901 */
3902 void
3903func_ptr_ref(ufunc_T *fp)
3904{
3905 if (fp != NULL)
3906 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907}
3908
3909/*
3910 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3911 * referenced from anywhere that is in use.
3912 */
3913 static int
3914can_free_funccal(funccall_T *fc, int copyID)
3915{
3916 return (fc->l_varlist.lv_copyID != copyID
3917 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003918 && fc->l_avars.dv_copyID != copyID
3919 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920}
3921
3922/*
3923 * ":return [expr]"
3924 */
3925 void
3926ex_return(exarg_T *eap)
3927{
3928 char_u *arg = eap->arg;
3929 typval_T rettv;
3930 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003931 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932
3933 if (current_funccal == NULL)
3934 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003935 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 return;
3937 }
3938
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003939 CLEAR_FIELD(evalarg);
3940 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3941
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003942 if (eap->skip)
3943 ++emsg_skip;
3944
3945 eap->nextcmd = NULL;
3946 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003947 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 {
3949 if (!eap->skip)
3950 returning = do_return(eap, FALSE, TRUE, &rettv);
3951 else
3952 clear_tv(&rettv);
3953 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003954 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 else if (!eap->skip)
3956 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003957 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003958 update_force_abort();
3959
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 /*
3961 * Return unless the expression evaluation has been cancelled due to an
3962 * aborting error, an interrupt, or an exception.
3963 */
3964 if (!aborting())
3965 returning = do_return(eap, FALSE, TRUE, NULL);
3966 }
3967
Bram Moolenaare38eab22019-12-05 21:50:01 +01003968 // When skipping or the return gets pending, advance to the next command
3969 // in this line (!returning). Otherwise, ignore the rest of the line.
3970 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 if (returning)
3972 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003973 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003974 eap->nextcmd = check_nextcmd(arg);
3975
3976 if (eap->skip)
3977 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003978 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979}
3980
3981/*
3982 * ":1,25call func(arg1, arg2)" function call.
3983 */
3984 void
3985ex_call(exarg_T *eap)
3986{
3987 char_u *arg = eap->arg;
3988 char_u *startarg;
3989 char_u *name;
3990 char_u *tofree;
3991 int len;
3992 typval_T rettv;
3993 linenr_T lnum;
3994 int doesrange;
3995 int failed = FALSE;
3996 funcdict_T fudi;
3997 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003998 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999
Bram Moolenaare6b53242020-07-01 17:28:33 +02004000 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004001 if (eap->skip)
4002 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004003 // trans_function_name() doesn't work well when skipping, use eval0()
4004 // instead to skip to any following command, e.g. for:
4005 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004007 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 clear_tv(&rettv);
4009 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004010 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 return;
4012 }
4013
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004014 tofree = trans_function_name(&arg, NULL, eap->skip,
4015 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004016 if (fudi.fd_newkey != NULL)
4017 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004018 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004019 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 vim_free(fudi.fd_newkey);
4021 }
4022 if (tofree == NULL)
4023 return;
4024
Bram Moolenaare38eab22019-12-05 21:50:01 +01004025 // Increase refcount on dictionary, it could get deleted when evaluating
4026 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 if (fudi.fd_dict != NULL)
4028 ++fudi.fd_dict->dv_refcount;
4029
Bram Moolenaare38eab22019-12-05 21:50:01 +01004030 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4031 // contents. For VAR_PARTIAL get its partial, unless we already have one
4032 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 len = (int)STRLEN(tofree);
4034 name = deref_func_name(tofree, &len,
4035 partial != NULL ? NULL : &partial, FALSE);
4036
Bram Moolenaare38eab22019-12-05 21:50:01 +01004037 // Skip white space to allow ":call func ()". Not good, but required for
4038 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004040 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041
4042 if (*startarg != '(')
4043 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004044 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 goto end;
4046 }
4047
4048 /*
4049 * When skipping, evaluate the function once, to find the end of the
4050 * arguments.
4051 * When the function takes a range, this is discovered after the first
4052 * call, and the loop is broken.
4053 */
4054 if (eap->skip)
4055 {
4056 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004057 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 }
4059 else
4060 lnum = eap->line1;
4061 for ( ; lnum <= eap->line2; ++lnum)
4062 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004063 funcexe_T funcexe;
4064
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 if (!eap->skip && eap->addr_count > 0)
4066 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004067 if (lnum > curbuf->b_ml.ml_line_count)
4068 {
4069 // If the function deleted lines or switched to another buffer
4070 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004071 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004072 break;
4073 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 curwin->w_cursor.lnum = lnum;
4075 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 }
4078 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004079
Bram Moolenaara80faa82020-04-12 19:37:17 +02004080 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004081 funcexe.firstline = eap->line1;
4082 funcexe.lastline = eap->line2;
4083 funcexe.doesrange = &doesrange;
4084 funcexe.evaluate = !eap->skip;
4085 funcexe.partial = partial;
4086 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004087 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088 {
4089 failed = TRUE;
4090 break;
4091 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004092 if (has_watchexpr())
4093 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004095 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004096 if (handle_subscript(&arg, &rettv,
4097 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098 {
4099 failed = TRUE;
4100 break;
4101 }
4102
4103 clear_tv(&rettv);
4104 if (doesrange || eap->skip)
4105 break;
4106
Bram Moolenaare38eab22019-12-05 21:50:01 +01004107 // Stop when immediately aborting on error, or when an interrupt
4108 // occurred or an exception was thrown but not caught.
4109 // get_func_tv() returned OK, so that the check for trailing
4110 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 if (aborting())
4112 break;
4113 }
4114 if (eap->skip)
4115 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004116 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117
Bram Moolenaare51bb172020-02-16 19:42:23 +01004118 // When inside :try we need to check for following "| catch".
4119 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004121 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004122 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004123 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004125 if (!failed)
4126 {
4127 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004128 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004129 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 }
4131 else
4132 eap->nextcmd = check_nextcmd(arg);
4133 }
4134
4135end:
4136 dict_unref(fudi.fd_dict);
4137 vim_free(tofree);
4138}
4139
4140/*
4141 * Return from a function. Possibly makes the return pending. Also called
4142 * for a pending return at the ":endtry" or after returning from an extra
4143 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4144 * when called due to a ":return" command. "rettv" may point to a typval_T
4145 * with the return rettv. Returns TRUE when the return can be carried out,
4146 * FALSE when the return gets pending.
4147 */
4148 int
4149do_return(
4150 exarg_T *eap,
4151 int reanimate,
4152 int is_cmd,
4153 void *rettv)
4154{
4155 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004156 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004157
4158 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004159 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160 current_funccal->returned = FALSE;
4161
4162 /*
4163 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4164 * not in its finally clause (which then is to be executed next) is found.
4165 * In this case, make the ":return" pending for execution at the ":endtry".
4166 * Otherwise, return normally.
4167 */
4168 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4169 if (idx >= 0)
4170 {
4171 cstack->cs_pending[idx] = CSTP_RETURN;
4172
4173 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004174 // A pending return again gets pending. "rettv" points to an
4175 // allocated variable with the rettv of the original ":return"'s
4176 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 cstack->cs_rettv[idx] = rettv;
4178 else
4179 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004180 // When undoing a return in order to make it pending, get the stored
4181 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 if (reanimate)
4183 rettv = current_funccal->rettv;
4184
4185 if (rettv != NULL)
4186 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004187 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4189 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4190 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004191 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 }
4193 else
4194 cstack->cs_rettv[idx] = NULL;
4195
4196 if (reanimate)
4197 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004198 // The pending return value could be overwritten by a ":return"
4199 // without argument in a finally clause; reset the default
4200 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 current_funccal->rettv->v_type = VAR_NUMBER;
4202 current_funccal->rettv->vval.v_number = 0;
4203 }
4204 }
4205 report_make_pending(CSTP_RETURN, rettv);
4206 }
4207 else
4208 {
4209 current_funccal->returned = TRUE;
4210
Bram Moolenaare38eab22019-12-05 21:50:01 +01004211 // If the return is carried out now, store the return value. For
4212 // a return immediately after reanimation, the value is already
4213 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 if (!reanimate && rettv != NULL)
4215 {
4216 clear_tv(current_funccal->rettv);
4217 *current_funccal->rettv = *(typval_T *)rettv;
4218 if (!is_cmd)
4219 vim_free(rettv);
4220 }
4221 }
4222
4223 return idx < 0;
4224}
4225
4226/*
4227 * Free the variable with a pending return value.
4228 */
4229 void
4230discard_pending_return(void *rettv)
4231{
4232 free_tv((typval_T *)rettv);
4233}
4234
4235/*
4236 * Generate a return command for producing the value of "rettv". The result
4237 * is an allocated string. Used by report_pending() for verbose messages.
4238 */
4239 char_u *
4240get_return_cmd(void *rettv)
4241{
4242 char_u *s = NULL;
4243 char_u *tofree = NULL;
4244 char_u numbuf[NUMBUFLEN];
4245
4246 if (rettv != NULL)
4247 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4248 if (s == NULL)
4249 s = (char_u *)"";
4250
4251 STRCPY(IObuff, ":return ");
4252 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4253 if (STRLEN(s) + 8 >= IOSIZE)
4254 STRCPY(IObuff + IOSIZE - 4, "...");
4255 vim_free(tofree);
4256 return vim_strsave(IObuff);
4257}
4258
4259/*
4260 * Get next function line.
4261 * Called by do_cmdline() to get the next line.
4262 * Returns allocated string, or NULL for end of function.
4263 */
4264 char_u *
4265get_func_line(
4266 int c UNUSED,
4267 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004268 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004269 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270{
4271 funccall_T *fcp = (funccall_T *)cookie;
4272 ufunc_T *fp = fcp->func;
4273 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004274 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275
Bram Moolenaare38eab22019-12-05 21:50:01 +01004276 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 if (fcp->dbg_tick != debug_tick)
4278 {
4279 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004280 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281 fcp->dbg_tick = debug_tick;
4282 }
4283#ifdef FEAT_PROFILE
4284 if (do_profiling == PROF_YES)
4285 func_line_end(cookie);
4286#endif
4287
4288 gap = &fp->uf_lines;
4289 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4290 || fcp->returned)
4291 retval = NULL;
4292 else
4293 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004294 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295 while (fcp->linenr < gap->ga_len
4296 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4297 ++fcp->linenr;
4298 if (fcp->linenr >= gap->ga_len)
4299 retval = NULL;
4300 else
4301 {
4302 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004303 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304#ifdef FEAT_PROFILE
4305 if (do_profiling == PROF_YES)
4306 func_line_start(cookie);
4307#endif
4308 }
4309 }
4310
Bram Moolenaare38eab22019-12-05 21:50:01 +01004311 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004312 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004314 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004315 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004317 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 fcp->dbg_tick = debug_tick;
4319 }
4320
4321 return retval;
4322}
4323
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004324/*
4325 * Return TRUE if the currently active function should be ended, because a
4326 * return was encountered or an error occurred. Used inside a ":while".
4327 */
4328 int
4329func_has_ended(void *cookie)
4330{
4331 funccall_T *fcp = (funccall_T *)cookie;
4332
Bram Moolenaare38eab22019-12-05 21:50:01 +01004333 // Ignore the "abort" flag if the abortion behavior has been changed due to
4334 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4336 || fcp->returned);
4337}
4338
4339/*
4340 * return TRUE if cookie indicates a function which "abort"s on errors.
4341 */
4342 int
4343func_has_abort(
4344 void *cookie)
4345{
4346 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4347}
4348
4349
4350/*
4351 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4352 * Don't do this when "Func" is already a partial that was bound
4353 * explicitly (pt_auto is FALSE).
4354 * Changes "rettv" in-place.
4355 * Returns the updated "selfdict_in".
4356 */
4357 dict_T *
4358make_partial(dict_T *selfdict_in, typval_T *rettv)
4359{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004360 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 char_u *tofree = NULL;
4362 ufunc_T *fp;
4363 char_u fname_buf[FLEN_FIXED + 1];
4364 int error;
4365 dict_T *selfdict = selfdict_in;
4366
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004367 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4368 fp = rettv->vval.v_partial->pt_func;
4369 else
4370 {
4371 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4372 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004373 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004374 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004375 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004376 vim_free(tofree);
4377 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378
4379 if (fp != NULL && (fp->uf_flags & FC_DICT))
4380 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004381 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382
4383 if (pt != NULL)
4384 {
4385 pt->pt_refcount = 1;
4386 pt->pt_dict = selfdict;
4387 pt->pt_auto = TRUE;
4388 selfdict = NULL;
4389 if (rettv->v_type == VAR_FUNC)
4390 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004391 // Just a function: Take over the function name and use
4392 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 pt->pt_name = rettv->vval.v_string;
4394 }
4395 else
4396 {
4397 partial_T *ret_pt = rettv->vval.v_partial;
4398 int i;
4399
Bram Moolenaare38eab22019-12-05 21:50:01 +01004400 // Partial: copy the function name, use selfdict and copy
4401 // args. Can't take over name or args, the partial might
4402 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004403 if (ret_pt->pt_name != NULL)
4404 {
4405 pt->pt_name = vim_strsave(ret_pt->pt_name);
4406 func_ref(pt->pt_name);
4407 }
4408 else
4409 {
4410 pt->pt_func = ret_pt->pt_func;
4411 func_ptr_ref(pt->pt_func);
4412 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 if (ret_pt->pt_argc > 0)
4414 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004415 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004417 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 pt->pt_argc = 0;
4419 else
4420 {
4421 pt->pt_argc = ret_pt->pt_argc;
4422 for (i = 0; i < pt->pt_argc; i++)
4423 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4424 }
4425 }
4426 partial_unref(ret_pt);
4427 }
4428 rettv->v_type = VAR_PARTIAL;
4429 rettv->vval.v_partial = pt;
4430 }
4431 }
4432 return selfdict;
4433}
4434
4435/*
4436 * Return the name of the executed function.
4437 */
4438 char_u *
4439func_name(void *cookie)
4440{
4441 return ((funccall_T *)cookie)->func->uf_name;
4442}
4443
4444/*
4445 * Return the address holding the next breakpoint line for a funccall cookie.
4446 */
4447 linenr_T *
4448func_breakpoint(void *cookie)
4449{
4450 return &((funccall_T *)cookie)->breakpoint;
4451}
4452
4453/*
4454 * Return the address holding the debug tick for a funccall cookie.
4455 */
4456 int *
4457func_dbg_tick(void *cookie)
4458{
4459 return &((funccall_T *)cookie)->dbg_tick;
4460}
4461
4462/*
4463 * Return the nesting level for a funccall cookie.
4464 */
4465 int
4466func_level(void *cookie)
4467{
4468 return ((funccall_T *)cookie)->level;
4469}
4470
4471/*
4472 * Return TRUE when a function was ended by a ":return" command.
4473 */
4474 int
4475current_func_returned(void)
4476{
4477 return current_funccal->returned;
4478}
4479
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480 int
4481free_unref_funccal(int copyID, int testing)
4482{
4483 int did_free = FALSE;
4484 int did_free_funccal = FALSE;
4485 funccall_T *fc, **pfc;
4486
4487 for (pfc = &previous_funccal; *pfc != NULL; )
4488 {
4489 if (can_free_funccal(*pfc, copyID))
4490 {
4491 fc = *pfc;
4492 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004493 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 did_free = TRUE;
4495 did_free_funccal = TRUE;
4496 }
4497 else
4498 pfc = &(*pfc)->caller;
4499 }
4500 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004501 // When a funccal was freed some more items might be garbage
4502 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004503 (void)garbage_collect(testing);
4504
4505 return did_free;
4506}
4507
4508/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004509 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 */
4511 static funccall_T *
4512get_funccal(void)
4513{
4514 int i;
4515 funccall_T *funccal;
4516 funccall_T *temp_funccal;
4517
4518 funccal = current_funccal;
4519 if (debug_backtrace_level > 0)
4520 {
4521 for (i = 0; i < debug_backtrace_level; i++)
4522 {
4523 temp_funccal = funccal->caller;
4524 if (temp_funccal)
4525 funccal = temp_funccal;
4526 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004527 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528 debug_backtrace_level = i;
4529 }
4530 }
4531 return funccal;
4532}
4533
4534/*
4535 * Return the hashtable used for local variables in the current funccal.
4536 * Return NULL if there is no current funccal.
4537 */
4538 hashtab_T *
4539get_funccal_local_ht()
4540{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004541 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004542 return NULL;
4543 return &get_funccal()->l_vars.dv_hashtab;
4544}
4545
4546/*
4547 * Return the l: scope variable.
4548 * Return NULL if there is no current funccal.
4549 */
4550 dictitem_T *
4551get_funccal_local_var()
4552{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004553 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 return NULL;
4555 return &get_funccal()->l_vars_var;
4556}
4557
4558/*
4559 * Return the hashtable used for argument in the current funccal.
4560 * Return NULL if there is no current funccal.
4561 */
4562 hashtab_T *
4563get_funccal_args_ht()
4564{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004565 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004566 return NULL;
4567 return &get_funccal()->l_avars.dv_hashtab;
4568}
4569
4570/*
4571 * Return the a: scope variable.
4572 * Return NULL if there is no current funccal.
4573 */
4574 dictitem_T *
4575get_funccal_args_var()
4576{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004577 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004579 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580}
4581
4582/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 * List function variables, if there is a function.
4584 */
4585 void
4586list_func_vars(int *first)
4587{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004588 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004590 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591}
4592
4593/*
4594 * If "ht" is the hashtable for local variables in the current funccal, return
4595 * the dict that contains it.
4596 * Otherwise return NULL.
4597 */
4598 dict_T *
4599get_current_funccal_dict(hashtab_T *ht)
4600{
4601 if (current_funccal != NULL
4602 && ht == &current_funccal->l_vars.dv_hashtab)
4603 return &current_funccal->l_vars;
4604 return NULL;
4605}
4606
4607/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004608 * Search hashitem in parent scope.
4609 */
4610 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004611find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004612{
4613 funccall_T *old_current_funccal = current_funccal;
4614 hashtab_T *ht;
4615 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004616 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004617
4618 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4619 return NULL;
4620
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004621 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004622 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004623 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004624 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004625 ht = find_var_ht(name, &varname);
4626 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004627 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004628 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004629 if (!HASHITEM_EMPTY(hi))
4630 {
4631 *pht = ht;
4632 break;
4633 }
4634 }
4635 if (current_funccal == current_funccal->func->uf_scoped)
4636 break;
4637 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004638 }
4639 current_funccal = old_current_funccal;
4640
4641 return hi;
4642}
4643
4644/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004645 * Search variable in parent scope.
4646 */
4647 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004648find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004649{
4650 dictitem_T *v = NULL;
4651 funccall_T *old_current_funccal = current_funccal;
4652 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004653 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004654
4655 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4656 return NULL;
4657
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004659 current_funccal = current_funccal->func->uf_scoped;
4660 while (current_funccal)
4661 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004662 ht = find_var_ht(name, &varname);
4663 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004664 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004665 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004666 if (v != NULL)
4667 break;
4668 }
4669 if (current_funccal == current_funccal->func->uf_scoped)
4670 break;
4671 current_funccal = current_funccal->func->uf_scoped;
4672 }
4673 current_funccal = old_current_funccal;
4674
4675 return v;
4676}
4677
4678/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 * Set "copyID + 1" in previous_funccal and callers.
4680 */
4681 int
4682set_ref_in_previous_funccal(int copyID)
4683{
4684 int abort = FALSE;
4685 funccall_T *fc;
4686
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004687 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004689 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004690 abort = abort
4691 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4692 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004693 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 }
4695 return abort;
4696}
4697
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004698 static int
4699set_ref_in_funccal(funccall_T *fc, int copyID)
4700{
4701 int abort = FALSE;
4702
4703 if (fc->fc_copyID != copyID)
4704 {
4705 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004706 abort = abort
4707 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4708 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004709 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004710 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004711 }
4712 return abort;
4713}
4714
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715/*
4716 * Set "copyID" in all local vars and arguments in the call stack.
4717 */
4718 int
4719set_ref_in_call_stack(int copyID)
4720{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004721 int abort = FALSE;
4722 funccall_T *fc;
4723 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004725 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004726 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004727
4728 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004729 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4730 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004731 abort = abort || set_ref_in_funccal(fc, copyID);
4732
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004733 return abort;
4734}
4735
4736/*
4737 * Set "copyID" in all functions available by name.
4738 */
4739 int
4740set_ref_in_functions(int copyID)
4741{
4742 int todo;
4743 hashitem_T *hi = NULL;
4744 int abort = FALSE;
4745 ufunc_T *fp;
4746
4747 todo = (int)func_hashtab.ht_used;
4748 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004750 if (!HASHITEM_EMPTY(hi))
4751 {
4752 --todo;
4753 fp = HI2UF(hi);
4754 if (!func_name_refcount(fp->uf_name))
4755 abort = abort || set_ref_in_func(NULL, fp, copyID);
4756 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 }
4758 return abort;
4759}
4760
4761/*
4762 * Set "copyID" in all function arguments.
4763 */
4764 int
4765set_ref_in_func_args(int copyID)
4766{
4767 int i;
4768 int abort = FALSE;
4769
4770 for (i = 0; i < funcargs.ga_len; ++i)
4771 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4772 copyID, NULL, NULL);
4773 return abort;
4774}
4775
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004776/*
4777 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004778 * Returns TRUE if setting references failed somehow.
4779 */
4780 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004781set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004782{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004783 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004784 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004785 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004786 char_u fname_buf[FLEN_FIXED + 1];
4787 char_u *tofree = NULL;
4788 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004789 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004790
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004791 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004792 return FALSE;
4793
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004794 if (fp_in == NULL)
4795 {
4796 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004797 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004798 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004799 if (fp != NULL)
4800 {
4801 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004802 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004803 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004804
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004805 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004806 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004807}
4808
Bram Moolenaare38eab22019-12-05 21:50:01 +01004809#endif // FEAT_EVAL