blob: 6aee37795391eec8b8d552725a52bbb2621f74a0 [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 {
113 semsg(_("E1059: No white space allowed before colon: %s"),
114 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 {
122 semsg(_(e_white_after), ":");
123 return arg;
124 }
125 type = skipwhite(p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100126 p = skip_type(type);
127 type = vim_strnsave(type, p - type);
128 }
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 else if (*skipwhite(p) != '=')
130 {
131 semsg(_("E1077: Missing argument type for %s"),
132 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 {
215 emsg(_("E1055: Missing name after ..."));
216 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;
242 if (eval1(&p, &rettv, FALSE) != FAIL)
243 {
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"));
269 mustend = TRUE;
270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 if (*p == ',')
272 ++p;
273 else
274 mustend = TRUE;
275 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200276 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200277 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200278 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200279
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200280 if (*p != endchar)
281 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100282 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200283
284 *argp = p;
285 return OK;
286
287err_ret:
288 if (newargs != NULL)
289 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200290 if (default_args != NULL)
291 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200292 return FAIL;
293}
294
295/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200296 * Register function "fp" as using "current_funccal" as its scope.
297 */
298 static int
299register_closure(ufunc_T *fp)
300{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200301 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100302 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200303 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200304 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200305 fp->uf_scoped = current_funccal;
306 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200307
Bram Moolenaar58016442016-07-31 18:30:22 +0200308 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
309 return FAIL;
310 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
311 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200312 return OK;
313}
314
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100315 static void
316set_ufunc_name(ufunc_T *fp, char_u *name)
317{
318 STRCPY(fp->uf_name, name);
319
320 if (name[0] == K_SPECIAL)
321 {
322 fp->uf_name_exp = alloc(STRLEN(name) + 3);
323 if (fp->uf_name_exp != NULL)
324 {
325 STRCPY(fp->uf_name_exp, "<SNR>");
326 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
327 }
328 }
329}
330
Bram Moolenaar58016442016-07-31 18:30:22 +0200331/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200332 * Parse a lambda expression and get a Funcref from "*arg".
333 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
334 */
335 int
336get_lambda_tv(char_u **arg, typval_T *rettv, int evaluate)
337{
338 garray_T newargs;
339 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200340 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200341 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100342 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200343 int varargs;
344 int ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200345 char_u *start = skipwhite(*arg + 1);
346 char_u *s, *e;
347 static int lambda_no = 0;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200348 int *old_eval_lavars = eval_lavars_used;
349 int eval_lavars = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200350
351 ga_init(&newargs);
352 ga_init(&newlines);
353
Bram Moolenaare38eab22019-12-05 21:50:01 +0100354 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200355 ret = get_function_args(&start, '-', NULL, NULL, NULL, NULL, TRUE,
356 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357 if (ret == FAIL || *start != '>')
358 return NOTDONE;
359
Bram Moolenaare38eab22019-12-05 21:50:01 +0100360 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200361 if (evaluate)
362 pnewargs = &newargs;
363 else
364 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200365 *arg = skipwhite(*arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100366 // TODO: argument types
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200367 ret = get_function_args(arg, '-', pnewargs, NULL, &varargs, NULL, FALSE,
368 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200369 if (ret == FAIL || **arg != '>')
370 goto errret;
371
Bram Moolenaare38eab22019-12-05 21:50:01 +0100372 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200373 if (evaluate)
374 eval_lavars_used = &eval_lavars;
375
Bram Moolenaare38eab22019-12-05 21:50:01 +0100376 // Get the start and the end of the expression.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 *arg = skipwhite(*arg + 1);
378 s = *arg;
379 ret = skip_expr(arg);
380 if (ret == FAIL)
381 goto errret;
382 e = *arg;
383 *arg = skipwhite(*arg);
384 if (**arg != '}')
Bram Moolenaaree619e52020-03-28 21:38:06 +0100385 {
386 semsg(_("E451: Expected }: %s"), *arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200387 goto errret;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100388 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200389 ++*arg;
390
391 if (evaluate)
392 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200393 int len, flags = 0;
394 char_u *p;
395 char_u name[20];
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200396
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200397 sprintf((char*)name, "<lambda>%d", ++lambda_no);
398
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200399 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200400 if (fp == NULL)
401 goto errret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100402 fp->uf_dfunc_idx = -1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200403 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200404 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200405 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200406
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200407 ga_init2(&newlines, (int)sizeof(char_u *), 1);
408 if (ga_grow(&newlines, 1) == FAIL)
409 goto errret;
410
Bram Moolenaare38eab22019-12-05 21:50:01 +0100411 // Add "return " before the expression.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200412 len = 7 + e - s + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200413 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200414 if (p == NULL)
415 goto errret;
416 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
417 STRCPY(p, "return ");
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200418 vim_strncpy(p + 7, s, e - s);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200419 if (strstr((char *)p + 7, "a:") == NULL)
420 // No a: variables are used for sure.
421 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200422
423 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100424 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200425 hash_add(&func_hashtab, UF2HIKEY(fp));
426 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200427 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200428 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200429 if (current_funccal != NULL && eval_lavars)
430 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200431 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200432 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200433 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200434 }
435 else
436 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200437
438#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200439 if (prof_def_func())
440 func_do_profile(fp);
441#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200442 if (sandbox)
443 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100444 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200445 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200446 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200447 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200448 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100449 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200450
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200451 pt->pt_func = fp;
452 pt->pt_refcount = 1;
453 rettv->vval.v_partial = pt;
454 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200455 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200456
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200457 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200458 return OK;
459
460errret:
461 ga_clear_strings(&newargs);
462 ga_clear_strings(&newlines);
463 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100464 vim_free(pt);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200465 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200466 return FAIL;
467}
468
469/*
470 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
471 * name it contains, otherwise return "name".
472 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
473 * "partialp".
474 */
475 char_u *
476deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
477{
478 dictitem_T *v;
479 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200480 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200481
482 if (partialp != NULL)
483 *partialp = NULL;
484
485 cc = name[*lenp];
486 name[*lenp] = NUL;
487 v = find_var(name, NULL, no_autoload);
488 name[*lenp] = cc;
489 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
490 {
491 if (v->di_tv.vval.v_string == NULL)
492 {
493 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100494 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200495 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200496 s = v->di_tv.vval.v_string;
497 *lenp = (int)STRLEN(s);
498 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200499 }
500
501 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
502 {
503 partial_T *pt = v->di_tv.vval.v_partial;
504
505 if (pt == NULL)
506 {
507 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100508 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200509 }
510 if (partialp != NULL)
511 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200512 s = partial_name(pt);
513 *lenp = (int)STRLEN(s);
514 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200515 }
516
517 return name;
518}
519
520/*
521 * Give an error message with a function name. Handle <SNR> things.
522 * "ermsg" is to be passed without translation, use N_() instead of _().
523 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100524 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200525emsg_funcname(char *ermsg, char_u *name)
526{
527 char_u *p;
528
529 if (*name == K_SPECIAL)
530 p = concat_str((char_u *)"<SNR>", name + 3);
531 else
532 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100533 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200534 if (p != name)
535 vim_free(p);
536}
537
538/*
539 * Allocate a variable for the result of a function.
540 * Return OK or FAIL.
541 */
542 int
543get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200544 char_u *name, // name of the function
545 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200546 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200547 char_u **arg, // argument, pointing to the '('
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200548 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200549{
550 char_u *argp;
551 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100552 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
553 int argcount = 0; // number of arguments found
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200554
555 /*
556 * Get the arguments.
557 */
558 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200559 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
560 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200561 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100562 argp = skipwhite(argp + 1); // skip the '(' or ','
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200563 if (*argp == ')' || *argp == ',' || *argp == NUL)
564 break;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200565 if (eval1(&argp, &argvars[argcount], funcexe->evaluate) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200566 {
567 ret = FAIL;
568 break;
569 }
570 ++argcount;
571 if (*argp != ',')
572 break;
573 }
574 if (*argp == ')')
575 ++argp;
576 else
577 ret = FAIL;
578
579 if (ret == OK)
580 {
581 int i = 0;
582
583 if (get_vim_var_nr(VV_TESTING))
584 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100585 // Prepare for calling test_garbagecollect_now(), need to know
586 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200587 if (funcargs.ga_itemsize == 0)
588 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
589 for (i = 0; i < argcount; ++i)
590 if (ga_grow(&funcargs, 1) == OK)
591 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
592 &argvars[i];
593 }
594
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200595 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200596
597 funcargs.ga_len -= i;
598 }
599 else if (!aborting())
600 {
601 if (argcount == MAX_FUNC_ARGS)
602 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
603 else
604 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
605 }
606
607 while (--argcount >= 0)
608 clear_tv(&argvars[argcount]);
609
610 *arg = skipwhite(argp);
611 return ret;
612}
613
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200614/*
615 * Return TRUE if "p" starts with "<SID>" or "s:".
616 * Only works if eval_fname_script() returned non-zero for "p"!
617 */
618 static int
619eval_fname_sid(char_u *p)
620{
621 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
622}
623
624/*
625 * In a script change <SID>name() and s:name() to K_SNR 123_name().
626 * Change <SNR>123_name() to K_SNR 123_name().
627 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
628 * (slow).
629 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100630 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200631fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
632{
633 int llen;
634 char_u *fname;
635 int i;
636
637 llen = eval_fname_script(name);
638 if (llen > 0)
639 {
640 fname_buf[0] = K_SPECIAL;
641 fname_buf[1] = KS_EXTRA;
642 fname_buf[2] = (int)KE_SNR;
643 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100644 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200646 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100647 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200648 else
649 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200650 sprintf((char *)fname_buf + 3, "%ld_",
651 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200652 i = (int)STRLEN(fname_buf);
653 }
654 }
655 if (i + STRLEN(name + llen) < FLEN_FIXED)
656 {
657 STRCPY(fname_buf + i, name + llen);
658 fname = fname_buf;
659 }
660 else
661 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200662 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200663 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100664 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200665 else
666 {
667 *tofree = fname;
668 mch_memmove(fname, fname_buf, (size_t)i);
669 STRCPY(fname + i, name + llen);
670 }
671 }
672 }
673 else
674 fname = name;
675 return fname;
676}
677
678/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100679 * Find a function "name" in script "sid".
680 */
681 static ufunc_T *
682find_func_with_sid(char_u *name, int sid)
683{
684 hashitem_T *hi;
685 char_u buffer[200];
686
687 buffer[0] = K_SPECIAL;
688 buffer[1] = KS_EXTRA;
689 buffer[2] = (int)KE_SNR;
690 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
691 (long)sid, name);
692 hi = hash_find(&func_hashtab, buffer);
693 if (!HASHITEM_EMPTY(hi))
694 return HI2UF(hi);
695
696 return NULL;
697}
698
699/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200700 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200701 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200702 * Return NULL for unknown function.
703 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100704 static ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200705find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200706{
707 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100708 ufunc_T *func;
709 imported_T *imported;
710
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200711 if (in_vim9script() && !is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100712 {
713 // Find script-local function before global one.
714 func = find_func_with_sid(name, current_sctx.sc_sid);
715 if (func != NULL)
716 return func;
717
718 // Find imported funcion before global one.
Bram Moolenaar4e12a5d2020-02-03 20:50:59 +0100719 imported = find_imported(name, 0, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100720 if (imported != NULL && imported->imp_funcname != NULL)
721 {
722 hi = hash_find(&func_hashtab, imported->imp_funcname);
723 if (!HASHITEM_EMPTY(hi))
724 return HI2UF(hi);
725 }
726 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200727
Bram Moolenaara26b9702020-04-18 19:53:28 +0200728 hi = hash_find(&func_hashtab,
729 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730 if (!HASHITEM_EMPTY(hi))
731 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100732
733 return NULL;
734}
735
736/*
737 * Find a function by name, return pointer to it in ufuncs.
738 * "cctx" is passed in a :def function to find imported functions.
739 * Return NULL for unknown or dead function.
740 */
741 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200742find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100743{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200744 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100745
746 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
747 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200748 return NULL;
749}
750
751/*
752 * Copy the function name of "fp" to buffer "buf".
753 * "buf" must be able to hold the function name plus three bytes.
754 * Takes care of script-local function names.
755 */
756 static void
757cat_func_name(char_u *buf, ufunc_T *fp)
758{
759 if (fp->uf_name[0] == K_SPECIAL)
760 {
761 STRCPY(buf, "<SNR>");
762 STRCAT(buf, fp->uf_name + 3);
763 }
764 else
765 STRCPY(buf, fp->uf_name);
766}
767
768/*
769 * Add a number variable "name" to dict "dp" with value "nr".
770 */
771 static void
772add_nr_var(
773 dict_T *dp,
774 dictitem_T *v,
775 char *name,
776 varnumber_T nr)
777{
778 STRCPY(v->di_key, name);
779 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
780 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
781 v->di_tv.v_type = VAR_NUMBER;
782 v->di_tv.v_lock = VAR_FIXED;
783 v->di_tv.vval.v_number = nr;
784}
785
786/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100787 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200788 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100789 static void
790free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200791{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100792 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200793
794 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
795 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100796 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200797
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100798 // When garbage collecting a funccall_T may be freed before the
799 // function that references it, clear its uf_scoped field.
800 // The function may have been redefined and point to another
801 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200802 if (fp != NULL && fp->uf_scoped == fc)
803 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200804 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200805 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200806
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200807 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200808 vim_free(fc);
809}
810
811/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100812 * Free "fc" and what it contains.
813 * Can be called only when "fc" is kept beyond the period of it called,
814 * i.e. after cleanup_function_call(fc).
815 */
816 static void
817free_funccal_contents(funccall_T *fc)
818{
819 listitem_T *li;
820
821 // Free all l: variables.
822 vars_clear(&fc->l_vars.dv_hashtab);
823
824 // Free all a: variables.
825 vars_clear(&fc->l_avars.dv_hashtab);
826
827 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200828 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100829 clear_tv(&li->li_tv);
830
831 free_funccal(fc);
832}
833
834/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200835 * Handle the last part of returning from a function: free the local hashtable.
836 * Unless it is still in use by a closure.
837 */
838 static void
839cleanup_function_call(funccall_T *fc)
840{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100841 int may_free_fc = fc->fc_refcount <= 0;
842 int free_fc = TRUE;
843
Bram Moolenaar6914c642017-04-01 21:21:30 +0200844 current_funccal = fc->caller;
845
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100846 // Free all l: variables if not referred.
847 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
848 vars_clear(&fc->l_vars.dv_hashtab);
849 else
850 free_fc = FALSE;
851
852 // If the a:000 list and the l: and a: dicts are not referenced and
853 // there is no closure using it, we can free the funccall_T and what's
854 // in it.
855 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
856 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200857 else
858 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100859 int todo;
860 hashitem_T *hi;
861 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200862
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100863 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200864
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100865 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200866 todo = (int)fc->l_avars.dv_hashtab.ht_used;
867 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
868 {
869 if (!HASHITEM_EMPTY(hi))
870 {
871 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100872 di = HI2DI(hi);
873 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200874 }
875 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100876 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200877
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100878 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
879 fc->l_varlist.lv_first = NULL;
880 else
881 {
882 listitem_T *li;
883
884 free_fc = FALSE;
885
886 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200887 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200888 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100889 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100890
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100891 if (free_fc)
892 free_funccal(fc);
893 else
894 {
895 static int made_copy = 0;
896
897 // "fc" is still in use. This can happen when returning "a:000",
898 // assigning "l:" to a global variable or defining a closure.
899 // Link "fc" in the list for garbage collection later.
900 fc->caller = previous_funccal;
901 previous_funccal = fc;
902
903 if (want_garbage_collect)
904 // If garbage collector is ready, clear count.
905 made_copy = 0;
906 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100907 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100908 // We have made a lot of copies, worth 4 Mbyte. This can happen
909 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100910 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100911 // too much memory.
912 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100913 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100914 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200915 }
916}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100917/*
918 * Unreference "fc": decrement the reference count and free it when it
919 * becomes zero. "fp" is detached from "fc".
920 * When "force" is TRUE we are exiting.
921 */
922 static void
923funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
924{
925 funccall_T **pfc;
926 int i;
927
928 if (fc == NULL)
929 return;
930
931 if (--fc->fc_refcount <= 0 && (force || (
932 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
933 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
934 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
935 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
936 {
937 if (fc == *pfc)
938 {
939 *pfc = fc->caller;
940 free_funccal_contents(fc);
941 return;
942 }
943 }
944 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
945 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
946 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
947}
948
949/*
950 * Remove the function from the function hashtable. If the function was
951 * deleted while it still has references this was already done.
952 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
953 */
954 static int
955func_remove(ufunc_T *fp)
956{
957 hashitem_T *hi;
958
959 // Return if it was already virtually deleted.
960 if (fp->uf_flags & FC_DEAD)
961 return FALSE;
962
963 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
964 if (!HASHITEM_EMPTY(hi))
965 {
966 // When there is a def-function index do not actually remove the
967 // function, so we can find the index when defining the function again.
968 if (fp->uf_dfunc_idx >= 0)
969 fp->uf_flags |= FC_DEAD;
970 else
971 hash_remove(&func_hashtab, hi);
972 return TRUE;
973 }
974 return FALSE;
975}
976
977 static void
978func_clear_items(ufunc_T *fp)
979{
980 ga_clear_strings(&(fp->uf_args));
981 ga_clear_strings(&(fp->uf_def_args));
982 ga_clear_strings(&(fp->uf_lines));
983 VIM_CLEAR(fp->uf_name_exp);
984 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +0100985 VIM_CLEAR(fp->uf_def_arg_idx);
986 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +0200987 while (fp->uf_type_list.ga_len > 0)
988 vim_free(((type_T **)fp->uf_type_list.ga_data)
989 [--fp->uf_type_list.ga_len]);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100990 ga_clear(&fp->uf_type_list);
991#ifdef FEAT_PROFILE
992 VIM_CLEAR(fp->uf_tml_count);
993 VIM_CLEAR(fp->uf_tml_total);
994 VIM_CLEAR(fp->uf_tml_self);
995#endif
996}
997
998/*
999 * Free all things that a function contains. Does not free the function
1000 * itself, use func_free() for that.
1001 * When "force" is TRUE we are exiting.
1002 */
1003 static void
1004func_clear(ufunc_T *fp, int force)
1005{
1006 if (fp->uf_cleared)
1007 return;
1008 fp->uf_cleared = TRUE;
1009
1010 // clear this function
1011 func_clear_items(fp);
1012 funccal_unref(fp->uf_scoped, fp, force);
1013 delete_def_function(fp);
1014}
1015
1016/*
1017 * Free a function and remove it from the list of functions. Does not free
1018 * what a function contains, call func_clear() first.
1019 */
1020 static void
1021func_free(ufunc_T *fp)
1022{
1023 // Only remove it when not done already, otherwise we would remove a newer
1024 // version of the function with the same name.
1025 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1026 func_remove(fp);
1027
1028 if ((fp->uf_flags & FC_DEAD) == 0)
1029 vim_free(fp);
1030}
1031
1032/*
1033 * Free all things that a function contains and free the function itself.
1034 * When "force" is TRUE we are exiting.
1035 */
1036 static void
1037func_clear_free(ufunc_T *fp, int force)
1038{
1039 func_clear(fp, force);
1040 func_free(fp);
1041}
1042
Bram Moolenaar6914c642017-04-01 21:21:30 +02001043
1044/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001045 * Call a user function.
1046 */
1047 static void
1048call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001049 ufunc_T *fp, // pointer to function
1050 int argcount, // nr of args
1051 typval_T *argvars, // arguments
1052 typval_T *rettv, // return value
1053 linenr_T firstline, // first line of range
1054 linenr_T lastline, // last line of range
1055 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001056{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001057 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001058 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001059 funccall_T *fc;
1060 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001061 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001062 static int depth = 0;
1063 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001064 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001065 int i;
1066 int ai;
1067 int islambda = FALSE;
1068 char_u numbuf[NUMBUFLEN];
1069 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001070#ifdef FEAT_PROFILE
1071 proftime_T wait_start;
1072 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001073 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001074#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001075 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001076
Bram Moolenaare38eab22019-12-05 21:50:01 +01001077 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001078 if (depth >= p_mfd)
1079 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001080 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001081 rettv->v_type = VAR_NUMBER;
1082 rettv->vval.v_number = -1;
1083 return;
1084 }
1085 ++depth;
1086
Bram Moolenaare38eab22019-12-05 21:50:01 +01001087 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001088
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001089 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001090 if (fc == NULL)
1091 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001092 fc->caller = current_funccal;
1093 current_funccal = fc;
1094 fc->func = fp;
1095 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001096 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001097 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001098 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1099 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001100 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001101 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001102 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001103
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001104 if (fp->uf_dfunc_idx >= 0)
1105 {
1106 estack_push_ufunc(ETYPE_UFUNC, fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001107 save_current_sctx = current_sctx;
1108 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001109
1110 // Execute the compiled function.
1111 call_def_function(fp, argcount, argvars, rettv);
1112 --depth;
1113 current_funccal = fc->caller;
1114
1115 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001116 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001117 free_funccal(fc);
1118 return;
1119 }
1120
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001121 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1122 islambda = TRUE;
1123
1124 /*
1125 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1126 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1127 * each argument variable and saves a lot of time.
1128 */
1129 /*
1130 * Init l: variables.
1131 */
1132 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1133 if (selfdict != NULL)
1134 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001135 // Set l:self to "selfdict". Use "name" to avoid a warning from
1136 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001137 v = &fc->fixvar[fixvar_idx++].var;
1138 name = v->di_key;
1139 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001140 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001141 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1142 v->di_tv.v_type = VAR_DICT;
1143 v->di_tv.v_lock = 0;
1144 v->di_tv.vval.v_dict = selfdict;
1145 ++selfdict->dv_refcount;
1146 }
1147
1148 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001149 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001150 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001151 * Set a:000 to a list with room for the "..." arguments.
1152 */
1153 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001154 if ((fp->uf_flags & FC_NOARGS) == 0)
1155 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001156 (varnumber_T)(argcount >= fp->uf_args.ga_len
1157 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001158 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001159 if ((fp->uf_flags & FC_NOARGS) == 0)
1160 {
1161 // Use "name" to avoid a warning from some compiler that checks the
1162 // destination size.
1163 v = &fc->fixvar[fixvar_idx++].var;
1164 name = v->di_key;
1165 STRCPY(name, "000");
1166 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1167 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1168 v->di_tv.v_type = VAR_LIST;
1169 v->di_tv.v_lock = VAR_FIXED;
1170 v->di_tv.vval.v_list = &fc->l_varlist;
1171 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001172 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001173 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1174 fc->l_varlist.lv_lock = VAR_FIXED;
1175
1176 /*
1177 * Set a:firstline to "firstline" and a:lastline to "lastline".
1178 * Set a:name to named arguments.
1179 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001180 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001181 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001182 if ((fp->uf_flags & FC_NOARGS) == 0)
1183 {
1184 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001185 (varnumber_T)firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001186 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001187 (varnumber_T)lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001188 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001189 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001190 {
1191 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001192 typval_T def_rettv;
1193 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001194
1195 ai = i - fp->uf_args.ga_len;
1196 if (ai < 0)
1197 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001198 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001199 name = FUNCARG(fp, i);
1200 if (islambda)
1201 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001202
1203 // evaluate named argument default expression
1204 isdefault = ai + fp->uf_def_args.ga_len >= 0
1205 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1206 && argvars[i].vval.v_number == VVAL_NONE));
1207 if (isdefault)
1208 {
1209 char_u *default_expr = NULL;
1210 def_rettv.v_type = VAR_NUMBER;
1211 def_rettv.vval.v_number = -1;
1212
1213 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1214 [ai + fp->uf_def_args.ga_len];
1215 if (eval1(&default_expr, &def_rettv, TRUE) == FAIL)
1216 {
1217 default_arg_err = 1;
1218 break;
1219 }
1220 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001221 }
1222 else
1223 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001224 if ((fp->uf_flags & FC_NOARGS) != 0)
1225 // Bail out if no a: arguments used (in lambda).
1226 break;
1227
Bram Moolenaare38eab22019-12-05 21:50:01 +01001228 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001229 sprintf((char *)numbuf, "%d", ai + 1);
1230 name = numbuf;
1231 }
1232 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1233 {
1234 v = &fc->fixvar[fixvar_idx++].var;
1235 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001236 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001237 }
1238 else
1239 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001240 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001241 if (v == NULL)
1242 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001243 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001245
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001246 // Note: the values are copied directly to avoid alloc/free.
1247 // "argvars" must have VAR_FIXED for v_lock.
1248 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001249 v->di_tv.v_lock = VAR_FIXED;
1250
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001251 if (addlocal)
1252 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001253 // Named arguments should be accessed without the "a:" prefix in
1254 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001255 copy_tv(&v->di_tv, &v->di_tv);
1256 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001257 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001258 else
1259 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001260
1261 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1262 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001263 listitem_T *li = &fc->l_listitems[ai];
1264
1265 li->li_tv = argvars[i];
1266 li->li_tv.v_lock = VAR_FIXED;
1267 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001268 }
1269 }
1270
Bram Moolenaare38eab22019-12-05 21:50:01 +01001271 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001272 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001273
1274 if (fp->uf_flags & FC_SANDBOX)
1275 {
1276 using_sandbox = TRUE;
1277 ++sandbox;
1278 }
1279
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001280 estack_push_ufunc(ETYPE_UFUNC, fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001281 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001282 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001284 ++no_wait_return;
1285 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001287 smsg(_("calling %s"), SOURCING_NAME);
1288 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001289 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001290 char_u buf[MSG_BUF_LEN];
1291 char_u numbuf2[NUMBUFLEN];
1292 char_u *tofree;
1293 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001294
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001295 msg_puts("(");
1296 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001297 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001298 if (i > 0)
1299 msg_puts(", ");
1300 if (argvars[i].v_type == VAR_NUMBER)
1301 msg_outnum((long)argvars[i].vval.v_number);
1302 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001303 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001304 // Do not want errors such as E724 here.
1305 ++emsg_off;
1306 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1307 --emsg_off;
1308 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001310 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001311 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001312 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1313 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001315 msg_puts((char *)s);
1316 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 }
1318 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001319 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001320 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001321 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001322 msg_puts("\n"); // don't overwrite this either
1323
1324 verbose_leave_scroll();
1325 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 }
1327#ifdef FEAT_PROFILE
1328 if (do_profiling == PROF_YES)
1329 {
1330 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001331 {
1332 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001333 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001334 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001335 if (fp->uf_profiling
1336 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1337 {
1338 ++fp->uf_tm_count;
1339 profile_start(&call_start);
1340 profile_zero(&fp->uf_tm_children);
1341 }
1342 script_prof_save(&wait_start);
1343 }
1344#endif
1345
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001346 save_current_sctx = current_sctx;
1347 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001348 save_did_emsg = did_emsg;
1349 did_emsg = FALSE;
1350
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001351 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1352 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001353 else if (islambda)
1354 {
1355 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1356
1357 // A Lambda always has the command "return {expr}". It is much faster
1358 // to evaluate {expr} directly.
1359 ++ex_nesting_level;
Bram Moolenaard1e9dc22020-04-03 18:13:57 +02001360 (void)eval1(&p, rettv, TRUE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001361 --ex_nesting_level;
1362 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001363 else
1364 // call do_cmdline() to execute the lines
1365 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001366 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1367
1368 --RedrawingDisabled;
1369
Bram Moolenaare38eab22019-12-05 21:50:01 +01001370 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001371 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1372 {
1373 clear_tv(rettv);
1374 rettv->v_type = VAR_NUMBER;
1375 rettv->vval.v_number = -1;
1376 }
1377
1378#ifdef FEAT_PROFILE
1379 if (do_profiling == PROF_YES && (fp->uf_profiling
1380 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1381 {
1382 profile_end(&call_start);
1383 profile_sub_wait(&wait_start, &call_start);
1384 profile_add(&fp->uf_tm_total, &call_start);
1385 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1386 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1387 {
1388 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1389 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1390 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001391 if (started_profiling)
1392 // make a ":profdel func" stop profiling the function
1393 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001394 }
1395#endif
1396
Bram Moolenaare38eab22019-12-05 21:50:01 +01001397 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001398 if (p_verbose >= 12)
1399 {
1400 ++no_wait_return;
1401 verbose_enter_scroll();
1402
1403 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001404 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001405 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001406 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001407 (long)fc->rettv->vval.v_number);
1408 else
1409 {
1410 char_u buf[MSG_BUF_LEN];
1411 char_u numbuf2[NUMBUFLEN];
1412 char_u *tofree;
1413 char_u *s;
1414
Bram Moolenaare38eab22019-12-05 21:50:01 +01001415 // The value may be very long. Skip the middle part, so that we
1416 // have some idea how it starts and ends. smsg() would always
1417 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418 ++emsg_off;
1419 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1420 --emsg_off;
1421 if (s != NULL)
1422 {
1423 if (vim_strsize(s) > MSG_BUF_CLEN)
1424 {
1425 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1426 s = buf;
1427 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001428 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001429 vim_free(tofree);
1430 }
1431 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001432 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433
1434 verbose_leave_scroll();
1435 --no_wait_return;
1436 }
1437
Bram Moolenaare31ee862020-01-07 20:59:34 +01001438 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001439 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001440 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441#ifdef FEAT_PROFILE
1442 if (do_profiling == PROF_YES)
1443 script_prof_restore(&wait_start);
1444#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001445 if (using_sandbox)
1446 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001448 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449 {
1450 ++no_wait_return;
1451 verbose_enter_scroll();
1452
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001453 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001454 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455
1456 verbose_leave_scroll();
1457 --no_wait_return;
1458 }
1459
1460 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001461 --depth;
1462
Bram Moolenaar6914c642017-04-01 21:21:30 +02001463 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001464}
1465
1466/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001467 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001468 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001469 int
1470call_user_func_check(
1471 ufunc_T *fp,
1472 int argcount,
1473 typval_T *argvars,
1474 typval_T *rettv,
1475 funcexe_T *funcexe,
1476 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001477{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001478 int error;
1479 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001480
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001481 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1482 *funcexe->doesrange = TRUE;
1483 if (argcount < regular_args - fp->uf_def_args.ga_len)
1484 error = FCERR_TOOFEW;
1485 else if (!has_varargs(fp) && argcount > regular_args)
1486 error = FCERR_TOOMANY;
1487 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1488 error = FCERR_DICT;
1489 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001490 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001491 int did_save_redo = FALSE;
1492 save_redo_T save_redo;
1493
1494 /*
1495 * Call the user function.
1496 * Save and restore search patterns, script variables and
1497 * redo buffer.
1498 */
1499 save_search_patterns();
1500 if (!ins_compl_active())
1501 {
1502 saveRedobuff(&save_redo);
1503 did_save_redo = TRUE;
1504 }
1505 ++fp->uf_calls;
1506 call_user_func(fp, argcount, argvars, rettv,
1507 funcexe->firstline, funcexe->lastline,
1508 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
1509 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1510 // Function was unreferenced while being used, free it now.
1511 func_clear_free(fp, FALSE);
1512 if (did_save_redo)
1513 restoreRedobuff(&save_redo);
1514 restore_search_patterns();
1515 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001516 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001517 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001518}
1519
1520/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001521 * There are two kinds of function names:
1522 * 1. ordinary names, function defined with :function
1523 * 2. numbered functions and lambdas
1524 * For the first we only count the name stored in func_hashtab as a reference,
1525 * using function() does not count as a reference, because the function is
1526 * looked up by name.
1527 */
1528 static int
1529func_name_refcount(char_u *name)
1530{
1531 return isdigit(*name) || *name == '<';
1532}
1533
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001534static funccal_entry_T *funccal_stack = NULL;
1535
1536/*
1537 * Save the current function call pointer, and set it to NULL.
1538 * Used when executing autocommands and for ":source".
1539 */
1540 void
1541save_funccal(funccal_entry_T *entry)
1542{
1543 entry->top_funccal = current_funccal;
1544 entry->next = funccal_stack;
1545 funccal_stack = entry;
1546 current_funccal = NULL;
1547}
1548
1549 void
1550restore_funccal(void)
1551{
1552 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001553 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001554 else
1555 {
1556 current_funccal = funccal_stack->top_funccal;
1557 funccal_stack = funccal_stack->next;
1558 }
1559}
1560
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001561 funccall_T *
1562get_current_funccal(void)
1563{
1564 return current_funccal;
1565}
1566
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001567/*
1568 * Mark all functions of script "sid" as deleted.
1569 */
1570 void
1571delete_script_functions(int sid)
1572{
1573 hashitem_T *hi;
1574 ufunc_T *fp;
1575 long_u todo;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001576 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001577 size_t len;
1578
1579 buf[0] = K_SPECIAL;
1580 buf[1] = KS_EXTRA;
1581 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001582 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001583 len = STRLEN(buf);
1584
1585 todo = func_hashtab.ht_used;
1586 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1587 if (!HASHITEM_EMPTY(hi))
1588 {
Bram Moolenaar03afdcf2020-04-27 23:39:30 +02001589 fp = HI2UF(hi);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001590 if (STRNCMP(fp->uf_name, buf, len) == 0)
1591 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001592 fp->uf_flags |= FC_DEAD;
1593 func_clear(fp, TRUE);
1594 }
1595 --todo;
1596 }
1597}
1598
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599#if defined(EXITFREE) || defined(PROTO)
1600 void
1601free_all_functions(void)
1602{
1603 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001604 ufunc_T *fp;
1605 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001606 long_u todo = 1;
1607 long_u used;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608
Bram Moolenaare38eab22019-12-05 21:50:01 +01001609 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001610 while (current_funccal != NULL)
1611 {
1612 clear_tv(current_funccal->rettv);
1613 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001614 if (current_funccal == NULL && funccal_stack != NULL)
1615 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001616 }
1617
Bram Moolenaare38eab22019-12-05 21:50:01 +01001618 // First clear what the functions contain. Since this may lower the
1619 // reference count of a function, it may also free a function and change
1620 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001621 while (todo > 0)
1622 {
1623 todo = func_hashtab.ht_used;
1624 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1625 if (!HASHITEM_EMPTY(hi))
1626 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001627 // clear the def function index now
1628 fp = HI2UF(hi);
1629 fp->uf_flags &= ~FC_DEAD;
1630 fp->uf_dfunc_idx = -1;
1631
Bram Moolenaare38eab22019-12-05 21:50:01 +01001632 // Only free functions that are not refcounted, those are
1633 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001634 if (func_name_refcount(fp->uf_name))
1635 ++skipped;
1636 else
1637 {
1638 used = func_hashtab.ht_used;
1639 func_clear(fp, TRUE);
1640 if (used != func_hashtab.ht_used)
1641 {
1642 skipped = 0;
1643 break;
1644 }
1645 }
1646 --todo;
1647 }
1648 }
1649
Bram Moolenaare38eab22019-12-05 21:50:01 +01001650 // Now actually free the functions. Need to start all over every time,
1651 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001652 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001653 while (func_hashtab.ht_used > skipped)
1654 {
1655 todo = func_hashtab.ht_used;
1656 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 if (!HASHITEM_EMPTY(hi))
1658 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001659 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001660 // Only free functions that are not refcounted, those are
1661 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001662 fp = HI2UF(hi);
1663 if (func_name_refcount(fp->uf_name))
1664 ++skipped;
1665 else
1666 {
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001667 func_free(fp);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001668 skipped = 0;
1669 break;
1670 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001671 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001672 }
1673 if (skipped == 0)
1674 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001675
1676 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001677}
1678#endif
1679
1680/*
1681 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001682 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 * "len" is the length of "name", or -1 for NUL terminated.
1684 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001685 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001686builtin_function(char_u *name, int len)
1687{
1688 char_u *p;
1689
Bram Moolenaara26b9702020-04-18 19:53:28 +02001690 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 return FALSE;
1692 p = vim_strchr(name, AUTOLOAD_CHAR);
1693 return p == NULL || (len > 0 && p > name + len);
1694}
1695
1696 int
1697func_call(
1698 char_u *name,
1699 typval_T *args,
1700 partial_T *partial,
1701 dict_T *selfdict,
1702 typval_T *rettv)
1703{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001704 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 listitem_T *item;
1706 typval_T argv[MAX_FUNC_ARGS + 1];
1707 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 int r = 0;
1709
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001710 range_list_materialize(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001711 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001712 {
1713 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1714 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001715 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001716 break;
1717 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001718 // Make a copy of each argument. This is needed to be able to set
1719 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720 copy_tv(&item->li_tv, &argv[argc++]);
1721 }
1722
1723 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001724 {
1725 funcexe_T funcexe;
1726
Bram Moolenaara80faa82020-04-12 19:37:17 +02001727 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001728 funcexe.firstline = curwin->w_cursor.lnum;
1729 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001730 funcexe.evaluate = TRUE;
1731 funcexe.partial = partial;
1732 funcexe.selfdict = selfdict;
1733 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1734 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735
Bram Moolenaare38eab22019-12-05 21:50:01 +01001736 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001737 while (argc > 0)
1738 clear_tv(&argv[--argc]);
1739
1740 return r;
1741}
1742
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001743static int callback_depth = 0;
1744
1745 int
1746get_callback_depth(void)
1747{
1748 return callback_depth;
1749}
1750
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001752 * Invoke call_func() with a callback.
1753 */
1754 int
1755call_callback(
1756 callback_T *callback,
1757 int len, // length of "name" or -1 to use strlen()
1758 typval_T *rettv, // return value goes here
1759 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001760 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001761 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001762{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001763 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001764 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001765
Bram Moolenaara80faa82020-04-12 19:37:17 +02001766 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001767 funcexe.evaluate = TRUE;
1768 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001769 ++callback_depth;
1770 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1771 --callback_depth;
1772 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001773}
1774
1775/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001776 * Give an error message for the result of a function.
1777 * Nothing if "error" is FCERR_NONE.
1778 */
1779 void
1780user_func_error(int error, char_u *name)
1781{
1782 switch (error)
1783 {
1784 case FCERR_UNKNOWN:
1785 emsg_funcname(e_unknownfunc, name);
1786 break;
1787 case FCERR_NOTMETHOD:
1788 emsg_funcname(
1789 N_("E276: Cannot use function as a method: %s"), name);
1790 break;
1791 case FCERR_DELETED:
1792 emsg_funcname(N_(e_func_deleted), name);
1793 break;
1794 case FCERR_TOOMANY:
1795 emsg_funcname((char *)e_toomanyarg, name);
1796 break;
1797 case FCERR_TOOFEW:
1798 emsg_funcname((char *)e_toofewarg, name);
1799 break;
1800 case FCERR_SCRIPT:
1801 emsg_funcname(
1802 N_("E120: Using <SID> not in a script context: %s"), name);
1803 break;
1804 case FCERR_DICT:
1805 emsg_funcname(
1806 N_("E725: Calling dict function without Dictionary: %s"),
1807 name);
1808 break;
1809 }
1810}
1811
1812/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001814 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001815 * Return FAIL when the function can't be called, OK otherwise.
1816 * Also returns OK when an error was encountered while executing the function.
1817 */
1818 int
1819call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001820 char_u *funcname, // name of the function
1821 int len, // length of "name" or -1 to use strlen()
1822 typval_T *rettv, // return value goes here
1823 int argcount_in, // number of "argvars"
1824 typval_T *argvars_in, // vars for arguments, must have "argcount"
1825 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001826 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827{
1828 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01001829 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001831 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001832 char_u fname_buf[FLEN_FIXED + 1];
1833 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001834 char_u *fname = NULL;
1835 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836 int argcount = argcount_in;
1837 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001838 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001839 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
1840 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001842 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001843 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001844
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02001845 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
1846 // even when call_func() returns FAIL.
1847 rettv->v_type = VAR_UNKNOWN;
1848
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001849 if (partial != NULL)
1850 fp = partial->pt_func;
1851 if (fp == NULL)
1852 {
1853 // Make a copy of the name, if it comes from a funcref variable it
1854 // could be changed or deleted in the called function.
1855 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
1856 if (name == NULL)
1857 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001859 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1860 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001861
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001862 if (funcexe->doesrange != NULL)
1863 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001864
1865 if (partial != NULL)
1866 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001867 // When the function has a partial with a dict and there is a dict
1868 // argument, use the dict argument. That is backwards compatible.
1869 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001870 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001871 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01001872 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 {
1874 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001875 {
1876 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
1877 {
Bram Moolenaaref140542019-12-31 21:27:13 +01001878 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001879 goto theend;
1880 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001881 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001882 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001883 for (i = 0; i < argcount_in; ++i)
1884 argv[i + argv_clear] = argvars_in[i];
1885 argvars = argv;
1886 argcount = partial->pt_argc + argcount_in;
1887 }
1888 }
1889
Bram Moolenaaref140542019-12-31 21:27:13 +01001890 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001891 {
1892 char_u *rfname = fname;
1893
Bram Moolenaare38eab22019-12-05 21:50:01 +01001894 // Ignore "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001895 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 rfname = fname + 2;
1897
Bram Moolenaare38eab22019-12-05 21:50:01 +01001898 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001899 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01001900 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001901
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001902 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001903 {
1904 /*
1905 * User defined function.
1906 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001907 if (fp == NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001908 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909
Bram Moolenaare38eab22019-12-05 21:50:01 +01001910 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001911 if (fp == NULL
1912 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001913 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001914 && !aborting())
1915 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001916 // executed an autocommand, search for the function again
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001917 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001919 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001920 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
1921 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001922 // loaded a package, search for the function again
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001923 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001924 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02001925 if (fp == NULL)
1926 {
1927 char_u *p = untrans_function_name(rfname);
1928
1929 // If using Vim9 script try not local to the script.
1930 // TODO: should not do this if the name started with "s:".
1931 if (p != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001932 fp = find_func(p, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02001933 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001935 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01001936 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001937 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001939 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01001940 // postponed filling in the arguments, do it now
1941 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001942 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001943
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001944 if (funcexe->basetv != NULL)
1945 {
1946 // Method call: base->Method()
1947 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
1948 argv[0] = *funcexe->basetv;
1949 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001950 argvars = argv;
1951 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001952 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001953
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954 error = call_user_func_check(fp, argcount, argvars, rettv,
1955 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956 }
1957 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02001958 else if (funcexe->basetv != NULL)
1959 {
1960 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001961 * expr->method(): Find the method name in the table, call its
1962 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02001963 */
1964 error = call_internal_method(fname, argcount, argvars, rettv,
1965 funcexe->basetv);
1966 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967 else
1968 {
1969 /*
1970 * Find the function name in the table, call its implementation.
1971 */
1972 error = call_internal_func(fname, argcount, argvars, rettv);
1973 }
1974 /*
1975 * The function call (or "FuncUndefined" autocommand sequence) might
1976 * have been aborted by an error, an interrupt, or an explicitly thrown
1977 * exception that has not been caught so far. This situation can be
1978 * tested for by calling aborting(). For an error in an internal
1979 * function or for the "E132" error in call_user_func(), however, the
1980 * throw point at which the "force_abort" flag (temporarily reset by
1981 * emsg()) is normally updated has not been reached yet. We need to
1982 * update that flag first to make aborting() reliable.
1983 */
1984 update_force_abort();
1985 }
Bram Moolenaaref140542019-12-31 21:27:13 +01001986 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001987 ret = OK;
1988
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001989theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001990 /*
1991 * Report an error unless the argument evaluation or function call has been
1992 * cancelled due to an aborting error, an interrupt, or an exception.
1993 */
1994 if (!aborting())
1995 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001996 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997 }
1998
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001999 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002000 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002001 clear_tv(&argv[--argv_clear + argv_base]);
2002
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002003 vim_free(tofree);
2004 vim_free(name);
2005
2006 return ret;
2007}
2008
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009 static char_u *
2010printable_func_name(ufunc_T *fp)
2011{
2012 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2013}
2014
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002015/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002016 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002017 */
2018 static void
2019list_func_head(ufunc_T *fp, int indent)
2020{
2021 int j;
2022
2023 msg_start();
2024 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002025 msg_puts(" ");
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002026 if (fp->uf_dfunc_idx >= 0)
2027 msg_puts("def ");
2028 else
2029 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002030 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002031 msg_putchar('(');
2032 for (j = 0; j < fp->uf_args.ga_len; ++j)
2033 {
2034 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002035 msg_puts(", ");
2036 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002037 if (fp->uf_arg_types != NULL)
2038 {
2039 char *tofree;
2040
2041 msg_puts(": ");
2042 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2043 vim_free(tofree);
2044 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002045 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2046 {
2047 msg_puts(" = ");
2048 msg_puts(((char **)(fp->uf_def_args.ga_data))
2049 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2050 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002051 }
2052 if (fp->uf_varargs)
2053 {
2054 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002055 msg_puts(", ");
2056 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002057 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002058 if (fp->uf_va_name != NULL)
2059 {
2060 if (j)
2061 msg_puts(", ");
2062 msg_puts("...");
2063 msg_puts((char *)fp->uf_va_name);
2064 if (fp->uf_va_type)
2065 {
2066 char *tofree;
2067
2068 msg_puts(": ");
2069 msg_puts(type_name(fp->uf_va_type, &tofree));
2070 vim_free(tofree);
2071 }
2072 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002073 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002074
2075 if (fp->uf_dfunc_idx >= 0)
2076 {
2077 if (fp->uf_ret_type != &t_void)
2078 {
2079 char *tofree;
2080
2081 msg_puts(": ");
2082 msg_puts(type_name(fp->uf_ret_type, &tofree));
2083 vim_free(tofree);
2084 }
2085 }
2086 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002087 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002088 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002089 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002090 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002091 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002092 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002093 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002094 msg_clr_eos();
2095 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002096 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002097}
2098
2099/*
2100 * Get a function name, translating "<SID>" and "<SNR>".
2101 * Also handles a Funcref in a List or Dictionary.
2102 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002103 * Set "*is_global" to TRUE when the function must be global, unless
2104 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002105 * flags:
2106 * TFN_INT: internal function name OK
2107 * TFN_QUIET: be quiet
2108 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002109 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 * Advances "pp" to just after the function name (if no error).
2111 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002112 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002113trans_function_name(
2114 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002115 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002116 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002117 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002118 funcdict_T *fdp, // return: info about dictionary used
2119 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120{
2121 char_u *name = NULL;
2122 char_u *start;
2123 char_u *end;
2124 int lead;
2125 char_u sid_buf[20];
2126 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002127 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002128 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002129 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002130
2131 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002132 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002133 start = *pp;
2134
Bram Moolenaare38eab22019-12-05 21:50:01 +01002135 // Check for hard coded <SNR>: already translated function ID (from a user
2136 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002137 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2138 && (*pp)[2] == (int)KE_SNR)
2139 {
2140 *pp += 3;
2141 len = get_id_len(pp) + 3;
2142 return vim_strnsave(start, len);
2143 }
2144
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2146 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002147 lead = eval_fname_script(start);
2148 if (lead > 2)
2149 start += lead;
2150
Bram Moolenaare38eab22019-12-05 21:50:01 +01002151 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002152 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153 lead > 2 ? 0 : FNE_CHECK_START);
2154 if (end == start)
2155 {
2156 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002157 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002158 goto theend;
2159 }
2160 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2161 {
2162 /*
2163 * Report an invalid expression in braces, unless the expression
2164 * evaluation has been cancelled due to an aborting error, an
2165 * interrupt, or an exception.
2166 */
2167 if (!aborting())
2168 {
2169 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002170 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002171 }
2172 else
2173 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2174 goto theend;
2175 }
2176
2177 if (lv.ll_tv != NULL)
2178 {
2179 if (fdp != NULL)
2180 {
2181 fdp->fd_dict = lv.ll_dict;
2182 fdp->fd_newkey = lv.ll_newkey;
2183 lv.ll_newkey = NULL;
2184 fdp->fd_di = lv.ll_di;
2185 }
2186 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2187 {
2188 name = vim_strsave(lv.ll_tv->vval.v_string);
2189 *pp = end;
2190 }
2191 else if (lv.ll_tv->v_type == VAR_PARTIAL
2192 && lv.ll_tv->vval.v_partial != NULL)
2193 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002194 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195 *pp = end;
2196 if (partial != NULL)
2197 *partial = lv.ll_tv->vval.v_partial;
2198 }
2199 else
2200 {
2201 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2202 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002203 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 else
2205 *pp = end;
2206 name = NULL;
2207 }
2208 goto theend;
2209 }
2210
2211 if (lv.ll_name == NULL)
2212 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002213 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 *pp = end;
2215 goto theend;
2216 }
2217
Bram Moolenaare38eab22019-12-05 21:50:01 +01002218 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 if (lv.ll_exp_name != NULL)
2220 {
2221 len = (int)STRLEN(lv.ll_exp_name);
2222 name = deref_func_name(lv.ll_exp_name, &len, partial,
2223 flags & TFN_NO_AUTOLOAD);
2224 if (name == lv.ll_exp_name)
2225 name = NULL;
2226 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002227 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228 {
2229 len = (int)(end - *pp);
2230 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2231 if (name == *pp)
2232 name = NULL;
2233 }
2234 if (name != NULL)
2235 {
2236 name = vim_strsave(name);
2237 *pp = end;
2238 if (STRNCMP(name, "<SNR>", 5) == 0)
2239 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002240 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 name[0] = K_SPECIAL;
2242 name[1] = KS_EXTRA;
2243 name[2] = (int)KE_SNR;
2244 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2245 }
2246 goto theend;
2247 }
2248
2249 if (lv.ll_exp_name != NULL)
2250 {
2251 len = (int)STRLEN(lv.ll_exp_name);
2252 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2253 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2254 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002255 // When there was "s:" already or the name expanded to get a
2256 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002257 lv.ll_name += 2;
2258 len -= 2;
2259 lead = 2;
2260 }
2261 }
2262 else
2263 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002264 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002266 {
2267 if (is_global != NULL && lv.ll_name[0] == 'g')
2268 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002271 len = (int)(end - lv.ll_name);
2272 }
2273
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274 // In Vim9 script a user function is script-local by default.
2275 vim9script = ASCII_ISUPPER(*start)
2276 && current_sctx.sc_version == SCRIPT_VERSION_VIM9;
2277
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002278 /*
2279 * Copy the function name to allocated memory.
2280 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2281 * Accept <SNR>123_name() outside a script.
2282 */
2283 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002284 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002285 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002287 if (!vim9script)
2288 lead = 3;
2289 if (vim9script || (lv.ll_exp_name != NULL
2290 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002291 || eval_fname_sid(*pp))
2292 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002294 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002296 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002297 goto theend;
2298 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002299 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002300 if (vim9script)
2301 extra = 3 + (int)STRLEN(sid_buf);
2302 else
2303 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002304 }
2305 }
2306 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2307 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002308 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002309 start);
2310 goto theend;
2311 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002312 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002313 {
2314 char_u *cp = vim_strchr(lv.ll_name, ':');
2315
2316 if (cp != NULL && cp < end)
2317 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002318 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002319 goto theend;
2320 }
2321 }
2322
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002324 if (name != NULL)
2325 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002326 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 {
2328 name[0] = K_SPECIAL;
2329 name[1] = KS_EXTRA;
2330 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002331 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 STRCPY(name + 3, sid_buf);
2333 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2335 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 }
2337 *pp = end;
2338
2339theend:
2340 clear_lval(&lv);
2341 return name;
2342}
2343
2344/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002345 * Assuming "name" is the result of trans_function_name() and it was prefixed
2346 * to use the script-local name, return the unmodified name (points into
2347 * "name"). Otherwise return NULL.
2348 * This can be used to first search for a script-local function and fall back
2349 * to the global function if not found.
2350 */
2351 char_u *
2352untrans_function_name(char_u *name)
2353{
2354 char_u *p;
2355
2356 if (*name == K_SPECIAL && current_sctx.sc_version == SCRIPT_VERSION_VIM9)
2357 {
2358 p = vim_strchr(name, '_');
2359 if (p != NULL)
2360 return p + 1;
2361 }
2362 return NULL;
2363}
2364
2365/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366 * ":function"
2367 */
2368 void
2369ex_function(exarg_T *eap)
2370{
2371 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002372 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 int j;
2374 int c;
2375 int saved_did_emsg;
2376 int saved_wait_return = need_wait_return;
2377 char_u *name = NULL;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002378 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 char_u *p;
2380 char_u *arg;
2381 char_u *line_arg = NULL;
2382 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002383 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002384 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 garray_T newlines;
2386 int varargs = FALSE;
2387 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002388 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002389 ufunc_T *fp;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002390 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002391 int indent;
2392 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002393#define MAX_FUNC_NESTING 50
2394 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002395 dictitem_T *v;
2396 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002397 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399 int todo;
2400 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002401 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002402 linenr_T sourcing_lnum_off;
2403 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002404 int is_heredoc = FALSE;
2405 char_u *skip_until = NULL;
2406 char_u *heredoc_trimmed = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407
2408 /*
2409 * ":function" without argument: list functions.
2410 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002411 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 {
2413 if (!eap->skip)
2414 {
2415 todo = (int)func_hashtab.ht_used;
2416 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
2417 {
2418 if (!HASHITEM_EMPTY(hi))
2419 {
2420 --todo;
2421 fp = HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002422 if ((fp->uf_flags & FC_DEAD)
2423 || message_filtered(fp->uf_name))
Bram Moolenaarf86db782018-10-25 13:31:37 +02002424 continue;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002425 if (!func_name_refcount(fp->uf_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 list_func_head(fp, FALSE);
2427 }
2428 }
2429 }
2430 eap->nextcmd = check_nextcmd(eap->arg);
2431 return;
2432 }
2433
2434 /*
2435 * ":function /pat": list functions matching pattern.
2436 */
2437 if (*eap->arg == '/')
2438 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002439 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 if (!eap->skip)
2441 {
2442 regmatch_T regmatch;
2443
2444 c = *p;
2445 *p = NUL;
2446 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2447 *p = c;
2448 if (regmatch.regprog != NULL)
2449 {
2450 regmatch.rm_ic = p_ic;
2451
2452 todo = (int)func_hashtab.ht_used;
2453 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
2454 {
2455 if (!HASHITEM_EMPTY(hi))
2456 {
2457 --todo;
2458 fp = HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002459 if ((fp->uf_flags & FC_DEAD) == 0
2460 && !isdigit(*fp->uf_name)
2461 && vim_regexec(&regmatch, fp->uf_name, 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002462 list_func_head(fp, FALSE);
2463 }
2464 }
2465 vim_regfree(regmatch.regprog);
2466 }
2467 }
2468 if (*p == '/')
2469 ++p;
2470 eap->nextcmd = check_nextcmd(p);
2471 return;
2472 }
2473
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002474 ga_init(&newargs);
2475 ga_init(&argtypes);
2476 ga_init(&default_args);
2477
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002478 /*
2479 * Get the function name. There are these situations:
2480 * func normal function name
2481 * "name" == func, "fudi.fd_dict" == NULL
2482 * dict.func new dictionary entry
2483 * "name" == NULL, "fudi.fd_dict" set,
2484 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2485 * dict.func existing dict entry with a Funcref
2486 * "name" == func, "fudi.fd_dict" set,
2487 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2488 * dict.func existing dict entry that's not a Funcref
2489 * "name" == NULL, "fudi.fd_dict" set,
2490 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2491 * s:func script-local function name
2492 * g:func global function name, same as "func"
2493 */
2494 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002495 name = trans_function_name(&p, &is_global, eap->skip,
2496 TFN_NO_AUTOLOAD, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 paren = (vim_strchr(p, '(') != NULL);
2498 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
2499 {
2500 /*
2501 * Return on an invalid expression in braces, unless the expression
2502 * evaluation has been cancelled due to an aborting error, an
2503 * interrupt, or an exception.
2504 */
2505 if (!aborting())
2506 {
2507 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002508 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 vim_free(fudi.fd_newkey);
2510 return;
2511 }
2512 else
2513 eap->skip = TRUE;
2514 }
2515
Bram Moolenaare38eab22019-12-05 21:50:01 +01002516 // An error in a function call during evaluation of an expression in magic
2517 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 saved_did_emsg = did_emsg;
2519 did_emsg = FALSE;
2520
2521 /*
2522 * ":function func" with only function name: list function.
2523 */
2524 if (!paren)
2525 {
2526 if (!ends_excmd(*skipwhite(p)))
2527 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002528 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 goto ret_free;
2530 }
2531 eap->nextcmd = check_nextcmd(p);
2532 if (eap->nextcmd != NULL)
2533 *p = NUL;
2534 if (!eap->skip && !got_int)
2535 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002536 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002537 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2538 {
2539 char_u *up = untrans_function_name(name);
2540
2541 // With Vim9 script the name was made script-local, if not
2542 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002543 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002544 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002545 }
2546
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 if (fp != NULL)
2548 {
2549 list_func_head(fp, TRUE);
2550 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2551 {
2552 if (FUNCLINE(fp, j) == NULL)
2553 continue;
2554 msg_putchar('\n');
2555 msg_outnum((long)(j + 1));
2556 if (j < 9)
2557 msg_putchar(' ');
2558 if (j < 99)
2559 msg_putchar(' ');
2560 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002561 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002562 ui_breakcheck();
2563 }
2564 if (!got_int)
2565 {
2566 msg_putchar('\n');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002567 if (fp->uf_dfunc_idx >= 0)
2568 msg_puts(" enddef");
2569 else
2570 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571 }
2572 }
2573 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002574 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 }
2576 goto ret_free;
2577 }
2578
2579 /*
2580 * ":function name(arg1, arg2)" Define function.
2581 */
2582 p = skipwhite(p);
2583 if (*p != '(')
2584 {
2585 if (!eap->skip)
2586 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002587 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588 goto ret_free;
2589 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002590 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002591 if (vim_strchr(p, '(') != NULL)
2592 p = vim_strchr(p, '(');
2593 }
2594 p = skipwhite(p + 1);
2595
2596 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2597
2598 if (!eap->skip)
2599 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002600 // Check the name of the function. Unless it's a dictionary function
2601 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602 if (name != NULL)
2603 arg = name;
2604 else
2605 arg = fudi.fd_newkey;
2606 if (arg != NULL && (fudi.fd_di == NULL
2607 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2608 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2609 {
2610 if (*arg == K_SPECIAL)
2611 j = 3;
2612 else
2613 j = 0;
2614 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2615 : eval_isnamec(arg[j])))
2616 ++j;
2617 if (arg[j] != NUL)
2618 emsg_funcname((char *)e_invarg2, arg);
2619 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002620 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002622 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 }
2624
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002625 // This may get more lines and make the pointers into the first line
2626 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002627 if (get_function_args(&p, ')', &newargs,
2628 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002629 &varargs, &default_args, eap->skip,
2630 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631 goto errret_2;
2632
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002633 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002635 // find the return type: :def Func(): type
2636 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002638 ret_type = skipwhite(p + 1);
2639 p = skip_type(ret_type);
2640 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002641 {
2642 ret_type = vim_strnsave(ret_type, (int)(p - ret_type));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002643 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002644 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002645 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002646 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002647 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002648 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002649 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002652 else
2653 // find extra arguments "range", "dict", "abort" and "closure"
2654 for (;;)
2655 {
2656 p = skipwhite(p);
2657 if (STRNCMP(p, "range", 5) == 0)
2658 {
2659 flags |= FC_RANGE;
2660 p += 5;
2661 }
2662 else if (STRNCMP(p, "dict", 4) == 0)
2663 {
2664 flags |= FC_DICT;
2665 p += 4;
2666 }
2667 else if (STRNCMP(p, "abort", 5) == 0)
2668 {
2669 flags |= FC_ABORT;
2670 p += 5;
2671 }
2672 else if (STRNCMP(p, "closure", 7) == 0)
2673 {
2674 flags |= FC_CLOSURE;
2675 p += 7;
2676 if (current_funccal == NULL)
2677 {
2678 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2679 name == NULL ? (char_u *)"" : name);
2680 goto erret;
2681 }
2682 }
2683 else
2684 break;
2685 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686
Bram Moolenaare38eab22019-12-05 21:50:01 +01002687 // When there is a line break use what follows for the function body.
2688 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 if (*p == '\n')
2690 line_arg = p + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +02002691 else if (*p != NUL && *p != '"' && !(eap->cmdidx == CMD_def && *p == '#')
2692 && !eap->skip && !did_emsg)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002693 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694
2695 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002696 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2697 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 */
2699 if (KeyTyped)
2700 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002701 // Check if the function already exists, don't let the user type the
2702 // whole function before telling him it doesn't work! For a script we
2703 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 if (!eap->skip && !eap->forceit)
2705 {
2706 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002707 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002708 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 emsg_funcname(e_funcexts, name);
2710 }
2711
2712 if (!eap->skip && did_emsg)
2713 goto erret;
2714
Bram Moolenaare38eab22019-12-05 21:50:01 +01002715 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 cmdline_row = msg_row;
2717 }
2718
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002719 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002720 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 indent = 2;
2723 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002724 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 for (;;)
2726 {
2727 if (KeyTyped)
2728 {
2729 msg_scroll = TRUE;
2730 saved_wait_return = FALSE;
2731 }
2732 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733
2734 if (line_arg != NULL)
2735 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002736 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002737 theline = line_arg;
2738 p = vim_strchr(theline, '\n');
2739 if (p == NULL)
2740 line_arg += STRLEN(line_arg);
2741 else
2742 {
2743 *p = NUL;
2744 line_arg = p + 1;
2745 }
2746 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02002748 {
2749 vim_free(line_to_free);
2750 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02002751 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002752 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02002753 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002754 line_to_free = theline;
2755 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 if (KeyTyped)
2757 lines_left = Rows - 1;
2758 if (theline == NULL)
2759 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002760 if (eap->cmdidx == CMD_def)
2761 emsg(_("E1057: Missing :enddef"));
2762 else
2763 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764 goto erret;
2765 }
2766
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002767 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002768 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002769 if (SOURCING_LNUM < sourcing_lnum_off)
2770 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 else
2772 sourcing_lnum_off = 0;
2773
2774 if (skip_until != NULL)
2775 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002776 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002777 // * ":append" and "."
2778 // * ":python <<EOF" and "EOF"
2779 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
2780 if (heredoc_trimmed == NULL
2781 || (is_heredoc && skipwhite(theline) == theline)
2782 || STRNCMP(theline, heredoc_trimmed,
2783 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002784 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002785 if (heredoc_trimmed == NULL)
2786 p = theline;
2787 else if (is_heredoc)
2788 p = skipwhite(theline) == theline
2789 ? theline : theline + STRLEN(heredoc_trimmed);
2790 else
2791 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02002792 if (STRCMP(p, skip_until) == 0)
2793 {
2794 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002795 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02002796 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002797 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002798 }
2799 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 }
2801 else
2802 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002803 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01002804 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 ;
2806
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002807 // Check for "endfunction" or "enddef".
2808 if (checkforcmd(&p, nesting_def[nesting]
2809 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02002811 char_u *nextcmd = NULL;
2812
Bram Moolenaar663bb232017-06-22 19:12:10 +02002813 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02002814 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002815 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02002816 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002817 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002818 give_warning2(eap->cmdidx == CMD_def
2819 ? (char_u *)_("W1001: Text found after :enddef: %s")
2820 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02002821 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002822 if (nextcmd != NULL)
2823 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002824 // Another command follows. If the line came from "eap" we
2825 // can simply point into it, otherwise we need to change
2826 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02002827 eap->nextcmd = nextcmd;
2828 if (line_to_free != NULL)
2829 {
2830 vim_free(*eap->cmdlinep);
2831 *eap->cmdlinep = line_to_free;
2832 line_to_free = NULL;
2833 }
2834 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 break;
2836 }
2837
Bram Moolenaare38eab22019-12-05 21:50:01 +01002838 // Increase indent inside "if", "while", "for" and "try", decrease
2839 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002840 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 indent -= 2;
2842 else if (STRNCMP(p, "if", 2) == 0
2843 || STRNCMP(p, "wh", 2) == 0
2844 || STRNCMP(p, "for", 3) == 0
2845 || STRNCMP(p, "try", 3) == 0)
2846 indent += 2;
2847
Bram Moolenaare38eab22019-12-05 21:50:01 +01002848 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01002849 // Only recognize "def" inside "def", not inside "function",
2850 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002851 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01002852 if (checkforcmd(&p, "function", 2)
2853 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002854 {
2855 if (*p == '!')
2856 p = skipwhite(p + 1);
2857 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002858 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 if (*skipwhite(p) == '(')
2860 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002861 if (nesting == MAX_FUNC_NESTING - 1)
2862 emsg(_("E1058: function nesting too deep"));
2863 else
2864 {
2865 ++nesting;
2866 nesting_def[nesting] = (c == 'd');
2867 indent += 2;
2868 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 }
2870 }
2871
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002872 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002874 if (eap->cmdidx != CMD_def
2875 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01002876 || (p[0] == 'c'
2877 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
2878 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
2879 && (STRNCMP(&p[3], "nge", 3) != 0
2880 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881 || (p[0] == 'i'
2882 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002883 && (!ASCII_ISALPHA(p[2])
2884 || (p[2] == 's'
2885 && (!ASCII_ISALPHA(p[3])
2886 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 skip_until = vim_strsave((char_u *)".");
2888
Bram Moolenaare38eab22019-12-05 21:50:01 +01002889 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 arg = skipwhite(skiptowhite(p));
2891 if (arg[0] == '<' && arg[1] =='<'
2892 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01002893 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
2894 || ((p[2] == '3' || p[2] == 'x')
2895 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 || (p[0] == 'p' && p[1] == 'e'
2897 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
2898 || (p[0] == 't' && p[1] == 'c'
2899 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
2900 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
2901 && !ASCII_ISALPHA(p[3]))
2902 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
2903 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
2904 || (p[0] == 'm' && p[1] == 'z'
2905 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
2906 ))
2907 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002908 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002909 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02002910 if (STRNCMP(p, "trim", 4) == 0)
2911 {
2912 // Ignore leading white space.
2913 p = skipwhite(p + 4);
2914 heredoc_trimmed = vim_strnsave(theline,
2915 (int)(skipwhite(theline) - theline));
2916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 if (*p == NUL)
2918 skip_until = vim_strsave((char_u *)".");
2919 else
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02002920 skip_until = vim_strnsave(p, (int)(skiptowhite(p) - p));
2921 do_concat = FALSE;
2922 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02002924
2925 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002926 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02002927 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002928 if (*arg == '[')
2929 arg = vim_strchr(arg, ']');
2930 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002931 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002932 arg = skipwhite(skiptowhite(arg));
2933 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
2934 && ((p[0] == 'l'
2935 && p[1] == 'e'
2936 && (!ASCII_ISALNUM(p[2])
2937 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02002938 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002939 p = skipwhite(arg + 3);
2940 if (STRNCMP(p, "trim", 4) == 0)
2941 {
2942 // Ignore leading white space.
2943 p = skipwhite(p + 4);
2944 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar8471e572019-05-19 21:37:18 +02002945 (int)(skipwhite(theline) - theline));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002946 }
2947 skip_until = vim_strnsave(p, (int)(skiptowhite(p) - p));
2948 do_concat = FALSE;
2949 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002950 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02002951 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 }
2953
Bram Moolenaare38eab22019-12-05 21:50:01 +01002954 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002957
Bram Moolenaare38eab22019-12-05 21:50:01 +01002958 // Copy the line to newly allocated memory. get_one_sourceline()
2959 // allocates 250 bytes per line, this saves 80% on average. The cost
2960 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002962 if (p == NULL)
2963 goto erret;
2964 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965
Bram Moolenaare38eab22019-12-05 21:50:01 +01002966 // Add NULL lines for continuation lines, so that the line count is
2967 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 while (sourcing_lnum_off-- > 0)
2969 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2970
Bram Moolenaare38eab22019-12-05 21:50:01 +01002971 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 if (line_arg != NULL && *line_arg == NUL)
2973 line_arg = NULL;
2974 }
2975
Bram Moolenaare38eab22019-12-05 21:50:01 +01002976 // Don't define the function when skipping commands or when an error was
2977 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 if (eap->skip || did_emsg)
2979 goto erret;
2980
2981 /*
2982 * If there are no errors, add the function
2983 */
2984 if (fudi.fd_dict == NULL)
2985 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002986 hashtab_T *ht;
2987
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988 v = find_var(name, &ht, FALSE);
2989 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
2990 {
2991 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
2992 name);
2993 goto erret;
2994 }
2995
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002996 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002997 if (fp != NULL)
2998 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002999 int dead = fp->uf_flags & FC_DEAD;
3000
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003001 // Function can be replaced with "function!" and when sourcing the
3002 // same script again, but only once.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003003 if (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003004 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
3005 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 {
3007 emsg_funcname(e_funcexts, name);
3008 goto erret;
3009 }
3010 if (fp->uf_calls > 0)
3011 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003012 emsg_funcname(
3013 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014 name);
3015 goto erret;
3016 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003017 if (fp->uf_refcount > 1)
3018 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003019 // This function is referenced somewhere, don't redefine it but
3020 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003021 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003022 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003023 fp = NULL;
3024 overwrite = TRUE;
3025 }
3026 else
3027 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003028 char_u *exp_name = fp->uf_name_exp;
3029
3030 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003031 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003032 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003033 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003034 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003035 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003036#ifdef FEAT_PROFILE
3037 fp->uf_profiling = FALSE;
3038 fp->uf_prof_initialized = FALSE;
3039#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003040 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 }
3042 }
3043 else
3044 {
3045 char numbuf[20];
3046
3047 fp = NULL;
3048 if (fudi.fd_newkey == NULL && !eap->forceit)
3049 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003050 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 goto erret;
3052 }
3053 if (fudi.fd_di == NULL)
3054 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003055 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003056 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057 goto erret;
3058 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003059 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003060 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 goto erret;
3062
Bram Moolenaare38eab22019-12-05 21:50:01 +01003063 // Give the function a sequential number. Can only be used with a
3064 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003065 vim_free(name);
3066 sprintf(numbuf, "%d", ++func_nr);
3067 name = vim_strsave((char_u *)numbuf);
3068 if (name == NULL)
3069 goto erret;
3070 }
3071
3072 if (fp == NULL)
3073 {
3074 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3075 {
3076 int slen, plen;
3077 char_u *scriptname;
3078
Bram Moolenaare38eab22019-12-05 21:50:01 +01003079 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003080 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003081 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082 {
3083 scriptname = autoload_name(name);
3084 if (scriptname != NULL)
3085 {
3086 p = vim_strchr(scriptname, '/');
3087 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003088 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003089 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003090 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 j = OK;
3092 vim_free(scriptname);
3093 }
3094 }
3095 if (j == FAIL)
3096 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003097 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003098 goto erret;
3099 }
3100 }
3101
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003102 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 if (fp == NULL)
3104 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003105 fp->uf_dfunc_idx = -1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106
3107 if (fudi.fd_dict != NULL)
3108 {
3109 if (fudi.fd_di == NULL)
3110 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003111 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3113 if (fudi.fd_di == NULL)
3114 {
3115 vim_free(fp);
3116 goto erret;
3117 }
3118 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3119 {
3120 vim_free(fudi.fd_di);
3121 vim_free(fp);
3122 goto erret;
3123 }
3124 }
3125 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003126 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 clear_tv(&fudi.fd_di->di_tv);
3128 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130
Bram Moolenaare38eab22019-12-05 21:50:01 +01003131 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132 flags |= FC_DICT;
3133 }
3134
Bram Moolenaare38eab22019-12-05 21:50:01 +01003135 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003136 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003137 if (overwrite)
3138 {
3139 hi = hash_find(&func_hashtab, name);
3140 hi->hi_key = UF2HIKEY(fp);
3141 }
3142 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 {
3144 vim_free(fp);
3145 goto erret;
3146 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003147 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 }
3149 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003150 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003151 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003152 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003153
3154 if (eap->cmdidx == CMD_def)
3155 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003156 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003157
3158 // error messages are for the first function line
3159 SOURCING_LNUM = sourcing_lnum_top;
3160
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003161 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003162 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003163
3164 if (argtypes.ga_len > 0)
3165 {
3166 // When "varargs" is set the last name/type goes into uf_va_name
3167 // and uf_va_type.
3168 int len = argtypes.ga_len - (varargs ? 1 : 0);
3169
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003170 if (len > 0)
3171 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003172 if (fp->uf_arg_types != NULL)
3173 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003174 int i;
3175 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003176
3177 for (i = 0; i < len; ++ i)
3178 {
3179 p = ((char_u **)argtypes.ga_data)[i];
3180 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003181 // will get the type from the default value
3182 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003183 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003184 type = parse_type(&p, &fp->uf_type_list);
3185 if (type == NULL)
3186 {
3187 SOURCING_LNUM = lnum_save;
3188 goto errret_2;
3189 }
3190 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003191 }
3192 }
3193 if (varargs)
3194 {
3195 // Move the last argument "...name: type" to uf_va_name and
3196 // uf_va_type.
3197 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3198 [fp->uf_args.ga_len - 1];
3199 --fp->uf_args.ga_len;
3200 p = ((char_u **)argtypes.ga_data)[len];
3201 if (p == NULL)
3202 // todo: get type from default value
3203 fp->uf_va_type = &t_any;
3204 else
3205 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003206 if (fp->uf_va_type == NULL)
3207 {
3208 SOURCING_LNUM = lnum_save;
3209 goto errret_2;
3210 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003211 }
3212 varargs = FALSE;
3213 }
3214
3215 // parse the return type, if any
3216 if (ret_type == NULL)
3217 fp->uf_ret_type = &t_void;
3218 else
3219 {
3220 p = ret_type;
3221 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3222 }
3223 }
3224
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003225 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003226 if ((flags & FC_CLOSURE) != 0)
3227 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003228 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003229 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003230 }
3231 else
3232 fp->uf_scoped = NULL;
3233
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 if (prof_def_func())
3236 func_do_profile(fp);
3237#endif
3238 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003239 if (sandbox)
3240 flags |= FC_SANDBOX;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003241 if (in_vim9script() && !ASCII_ISUPPER(*fp->uf_name))
3242 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 fp->uf_flags = flags;
3244 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003245 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003246 fp->uf_script_ctx = current_sctx;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003247 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 if (is_export)
3249 {
3250 fp->uf_flags |= FC_EXPORT;
3251 // let ex_export() know the export worked.
3252 is_export = FALSE;
3253 }
3254
3255 // ":def Func()" needs to be compiled
3256 if (eap->cmdidx == CMD_def)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02003257 compile_def_function(fp, FALSE, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 goto ret_free;
3260
3261erret:
3262 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003263 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264errret_2:
3265 ga_clear_strings(&newlines);
3266ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003267 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003269 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 vim_free(fudi.fd_newkey);
3271 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003272 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 did_emsg |= saved_did_emsg;
3274 need_wait_return |= saved_wait_return;
3275}
3276
3277/*
3278 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3279 * Return 2 if "p" starts with "s:".
3280 * Return 0 otherwise.
3281 */
3282 int
3283eval_fname_script(char_u *p)
3284{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003285 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3286 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3288 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3289 return 5;
3290 if (p[0] == 's' && p[1] == ':')
3291 return 2;
3292 return 0;
3293}
3294
3295 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003296translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297{
3298 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003299 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003300 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003301}
3302
3303/*
3304 * Return TRUE when "ufunc" has old-style "..." varargs
3305 * or named varargs "...name: type".
3306 */
3307 int
3308has_varargs(ufunc_T *ufunc)
3309{
3310 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311}
3312
3313/*
3314 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003315 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 */
3317 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003318function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319{
3320 char_u *nm = name;
3321 char_u *p;
3322 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003323 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003324 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003326 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3327 if (no_deref)
3328 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003329 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 nm = skipwhite(nm);
3331
Bram Moolenaare38eab22019-12-05 21:50:01 +01003332 // Only accept "funcname", "funcname ", "funcname (..." and
3333 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003335 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 vim_free(p);
3337 return n;
3338}
3339
Bram Moolenaar113e1072019-01-20 15:30:40 +01003340#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 char_u *
3342get_expanded_name(char_u *name, int check)
3343{
3344 char_u *nm = name;
3345 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003346 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003348 p = trans_function_name(&nm, &is_global, FALSE,
3349 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003351 if (p != NULL && *nm == NUL
3352 && (!check || translated_function_exists(p, is_global)))
3353 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
3355 vim_free(p);
3356 return NULL;
3357}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003358#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360/*
3361 * Function given to ExpandGeneric() to obtain the list of user defined
3362 * function names.
3363 */
3364 char_u *
3365get_user_func_name(expand_T *xp, int idx)
3366{
3367 static long_u done;
3368 static hashitem_T *hi;
3369 ufunc_T *fp;
3370
3371 if (idx == 0)
3372 {
3373 done = 0;
3374 hi = func_hashtab.ht_array;
3375 }
3376 if (done < func_hashtab.ht_used)
3377 {
3378 if (done++ > 0)
3379 ++hi;
3380 while (HASHITEM_EMPTY(hi))
3381 ++hi;
3382 fp = HI2UF(hi);
3383
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003384 // don't show dead, dict and lambda functions
3385 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003386 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003387 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388
3389 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003390 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391
3392 cat_func_name(IObuff, fp);
3393 if (xp->xp_context != EXPAND_USER_FUNC)
3394 {
3395 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 STRCAT(IObuff, ")");
3398 }
3399 return IObuff;
3400 }
3401 return NULL;
3402}
3403
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404/*
3405 * ":delfunction {name}"
3406 */
3407 void
3408ex_delfunction(exarg_T *eap)
3409{
3410 ufunc_T *fp = NULL;
3411 char_u *p;
3412 char_u *name;
3413 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003414 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003415
3416 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003417 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 vim_free(fudi.fd_newkey);
3419 if (name == NULL)
3420 {
3421 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003422 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 return;
3424 }
3425 if (!ends_excmd(*skipwhite(p)))
3426 {
3427 vim_free(name);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003428 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 return;
3430 }
3431 eap->nextcmd = check_nextcmd(p);
3432 if (eap->nextcmd != NULL)
3433 *p = NUL;
3434
3435 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003436 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003437 vim_free(name);
3438
3439 if (!eap->skip)
3440 {
3441 if (fp == NULL)
3442 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003443 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003444 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 return;
3446 }
3447 if (fp->uf_calls > 0)
3448 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003449 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 return;
3451 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003452 if (fp->uf_flags & FC_VIM9)
3453 {
3454 semsg(_("E1084: Cannot delete Vim9 script function %s"), eap->arg);
3455 return;
3456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457
3458 if (fudi.fd_dict != NULL)
3459 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003460 // Delete the dict item that refers to the function, it will
3461 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3463 }
3464 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003465 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003466 // A normal function (not a numbered function or lambda) has a
3467 // refcount of 1 for the entry in the hashtable. When deleting
3468 // it and the refcount is more than one, it should be kept.
3469 // A numbered function and lambda should be kept if the refcount is
3470 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003471 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003472 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003473 // Function is still referenced somewhere. Don't free it but
3474 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003475 if (func_remove(fp))
3476 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003477 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003478 }
3479 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003480 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003481 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 }
3483}
3484
3485/*
3486 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003487 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003488 */
3489 void
3490func_unref(char_u *name)
3491{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003492 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003494 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003496 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003497 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003500 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003502 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003503 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003504 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003506 // Only delete it when it's not being used. Otherwise it's done
3507 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003508 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003509 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003510 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003511}
3512
3513/*
3514 * Unreference a Function: decrement the reference count and free it when it
3515 * becomes zero.
3516 */
3517 void
3518func_ptr_unref(ufunc_T *fp)
3519{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003520 if (fp != NULL && --fp->uf_refcount <= 0)
3521 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003522 // Only delete it when it's not being used. Otherwise it's done
3523 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003524 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003525 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 }
3527}
3528
3529/*
3530 * Count a reference to a Function.
3531 */
3532 void
3533func_ref(char_u *name)
3534{
3535 ufunc_T *fp;
3536
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003537 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003539 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003540 if (fp != NULL)
3541 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003543 // Only give an error for a numbered function.
3544 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003545 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003546}
3547
3548/*
3549 * Count a reference to a Function.
3550 */
3551 void
3552func_ptr_ref(ufunc_T *fp)
3553{
3554 if (fp != NULL)
3555 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556}
3557
3558/*
3559 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3560 * referenced from anywhere that is in use.
3561 */
3562 static int
3563can_free_funccal(funccall_T *fc, int copyID)
3564{
3565 return (fc->l_varlist.lv_copyID != copyID
3566 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003567 && fc->l_avars.dv_copyID != copyID
3568 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003569}
3570
3571/*
3572 * ":return [expr]"
3573 */
3574 void
3575ex_return(exarg_T *eap)
3576{
3577 char_u *arg = eap->arg;
3578 typval_T rettv;
3579 int returning = FALSE;
3580
3581 if (current_funccal == NULL)
3582 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003583 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584 return;
3585 }
3586
3587 if (eap->skip)
3588 ++emsg_skip;
3589
3590 eap->nextcmd = NULL;
3591 if ((*arg != NUL && *arg != '|' && *arg != '\n')
3592 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
3593 {
3594 if (!eap->skip)
3595 returning = do_return(eap, FALSE, TRUE, &rettv);
3596 else
3597 clear_tv(&rettv);
3598 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003599 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600 else if (!eap->skip)
3601 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003602 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003603 update_force_abort();
3604
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 /*
3606 * Return unless the expression evaluation has been cancelled due to an
3607 * aborting error, an interrupt, or an exception.
3608 */
3609 if (!aborting())
3610 returning = do_return(eap, FALSE, TRUE, NULL);
3611 }
3612
Bram Moolenaare38eab22019-12-05 21:50:01 +01003613 // When skipping or the return gets pending, advance to the next command
3614 // in this line (!returning). Otherwise, ignore the rest of the line.
3615 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 if (returning)
3617 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003618 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 eap->nextcmd = check_nextcmd(arg);
3620
3621 if (eap->skip)
3622 --emsg_skip;
3623}
3624
3625/*
3626 * ":1,25call func(arg1, arg2)" function call.
3627 */
3628 void
3629ex_call(exarg_T *eap)
3630{
3631 char_u *arg = eap->arg;
3632 char_u *startarg;
3633 char_u *name;
3634 char_u *tofree;
3635 int len;
3636 typval_T rettv;
3637 linenr_T lnum;
3638 int doesrange;
3639 int failed = FALSE;
3640 funcdict_T fudi;
3641 partial_T *partial = NULL;
3642
3643 if (eap->skip)
3644 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003645 // trans_function_name() doesn't work well when skipping, use eval0()
3646 // instead to skip to any following command, e.g. for:
3647 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 ++emsg_skip;
3649 if (eval0(eap->arg, &rettv, &eap->nextcmd, FALSE) != FAIL)
3650 clear_tv(&rettv);
3651 --emsg_skip;
3652 return;
3653 }
3654
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003655 tofree = trans_function_name(&arg, NULL, eap->skip,
3656 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 if (fudi.fd_newkey != NULL)
3658 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003659 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003660 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 vim_free(fudi.fd_newkey);
3662 }
3663 if (tofree == NULL)
3664 return;
3665
Bram Moolenaare38eab22019-12-05 21:50:01 +01003666 // Increase refcount on dictionary, it could get deleted when evaluating
3667 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 if (fudi.fd_dict != NULL)
3669 ++fudi.fd_dict->dv_refcount;
3670
Bram Moolenaare38eab22019-12-05 21:50:01 +01003671 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
3672 // contents. For VAR_PARTIAL get its partial, unless we already have one
3673 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 len = (int)STRLEN(tofree);
3675 name = deref_func_name(tofree, &len,
3676 partial != NULL ? NULL : &partial, FALSE);
3677
Bram Moolenaare38eab22019-12-05 21:50:01 +01003678 // Skip white space to allow ":call func ()". Not good, but required for
3679 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003681 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003682
3683 if (*startarg != '(')
3684 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003685 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686 goto end;
3687 }
3688
3689 /*
3690 * When skipping, evaluate the function once, to find the end of the
3691 * arguments.
3692 * When the function takes a range, this is discovered after the first
3693 * call, and the loop is broken.
3694 */
3695 if (eap->skip)
3696 {
3697 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003698 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 }
3700 else
3701 lnum = eap->line1;
3702 for ( ; lnum <= eap->line2; ++lnum)
3703 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003704 funcexe_T funcexe;
3705
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 if (!eap->skip && eap->addr_count > 0)
3707 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003708 if (lnum > curbuf->b_ml.ml_line_count)
3709 {
3710 // If the function deleted lines or switched to another buffer
3711 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003712 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003713 break;
3714 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 curwin->w_cursor.lnum = lnum;
3716 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718 }
3719 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003720
Bram Moolenaara80faa82020-04-12 19:37:17 +02003721 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003722 funcexe.firstline = eap->line1;
3723 funcexe.lastline = eap->line2;
3724 funcexe.doesrange = &doesrange;
3725 funcexe.evaluate = !eap->skip;
3726 funcexe.partial = partial;
3727 funcexe.selfdict = fudi.fd_dict;
3728 if (get_func_tv(name, -1, &rettv, &arg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 {
3730 failed = TRUE;
3731 break;
3732 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003733 if (has_watchexpr())
3734 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02003736 // Handle a function returning a Funcref, Dictionary or List.
3737 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE,
3738 name, &name) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 {
3740 failed = TRUE;
3741 break;
3742 }
3743
3744 clear_tv(&rettv);
3745 if (doesrange || eap->skip)
3746 break;
3747
Bram Moolenaare38eab22019-12-05 21:50:01 +01003748 // Stop when immediately aborting on error, or when an interrupt
3749 // occurred or an exception was thrown but not caught.
3750 // get_func_tv() returned OK, so that the check for trailing
3751 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 if (aborting())
3753 break;
3754 }
3755 if (eap->skip)
3756 --emsg_skip;
3757
Bram Moolenaare51bb172020-02-16 19:42:23 +01003758 // When inside :try we need to check for following "| catch".
3759 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003761 // Check for trailing illegal characters and a following command.
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003762 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01003764 if (!failed)
3765 {
3766 emsg_severe = TRUE;
3767 emsg(_(e_trailing));
3768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 }
3770 else
3771 eap->nextcmd = check_nextcmd(arg);
3772 }
3773
3774end:
3775 dict_unref(fudi.fd_dict);
3776 vim_free(tofree);
3777}
3778
3779/*
3780 * Return from a function. Possibly makes the return pending. Also called
3781 * for a pending return at the ":endtry" or after returning from an extra
3782 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
3783 * when called due to a ":return" command. "rettv" may point to a typval_T
3784 * with the return rettv. Returns TRUE when the return can be carried out,
3785 * FALSE when the return gets pending.
3786 */
3787 int
3788do_return(
3789 exarg_T *eap,
3790 int reanimate,
3791 int is_cmd,
3792 void *rettv)
3793{
3794 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01003795 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796
3797 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 current_funccal->returned = FALSE;
3800
3801 /*
3802 * Cleanup (and inactivate) conditionals, but stop when a try conditional
3803 * not in its finally clause (which then is to be executed next) is found.
3804 * In this case, make the ":return" pending for execution at the ":endtry".
3805 * Otherwise, return normally.
3806 */
3807 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
3808 if (idx >= 0)
3809 {
3810 cstack->cs_pending[idx] = CSTP_RETURN;
3811
3812 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003813 // A pending return again gets pending. "rettv" points to an
3814 // allocated variable with the rettv of the original ":return"'s
3815 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 cstack->cs_rettv[idx] = rettv;
3817 else
3818 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003819 // When undoing a return in order to make it pending, get the stored
3820 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 if (reanimate)
3822 rettv = current_funccal->rettv;
3823
3824 if (rettv != NULL)
3825 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003826 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
3828 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
3829 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003830 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 }
3832 else
3833 cstack->cs_rettv[idx] = NULL;
3834
3835 if (reanimate)
3836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003837 // The pending return value could be overwritten by a ":return"
3838 // without argument in a finally clause; reset the default
3839 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 current_funccal->rettv->v_type = VAR_NUMBER;
3841 current_funccal->rettv->vval.v_number = 0;
3842 }
3843 }
3844 report_make_pending(CSTP_RETURN, rettv);
3845 }
3846 else
3847 {
3848 current_funccal->returned = TRUE;
3849
Bram Moolenaare38eab22019-12-05 21:50:01 +01003850 // If the return is carried out now, store the return value. For
3851 // a return immediately after reanimation, the value is already
3852 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 if (!reanimate && rettv != NULL)
3854 {
3855 clear_tv(current_funccal->rettv);
3856 *current_funccal->rettv = *(typval_T *)rettv;
3857 if (!is_cmd)
3858 vim_free(rettv);
3859 }
3860 }
3861
3862 return idx < 0;
3863}
3864
3865/*
3866 * Free the variable with a pending return value.
3867 */
3868 void
3869discard_pending_return(void *rettv)
3870{
3871 free_tv((typval_T *)rettv);
3872}
3873
3874/*
3875 * Generate a return command for producing the value of "rettv". The result
3876 * is an allocated string. Used by report_pending() for verbose messages.
3877 */
3878 char_u *
3879get_return_cmd(void *rettv)
3880{
3881 char_u *s = NULL;
3882 char_u *tofree = NULL;
3883 char_u numbuf[NUMBUFLEN];
3884
3885 if (rettv != NULL)
3886 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
3887 if (s == NULL)
3888 s = (char_u *)"";
3889
3890 STRCPY(IObuff, ":return ");
3891 STRNCPY(IObuff + 8, s, IOSIZE - 8);
3892 if (STRLEN(s) + 8 >= IOSIZE)
3893 STRCPY(IObuff + IOSIZE - 4, "...");
3894 vim_free(tofree);
3895 return vim_strsave(IObuff);
3896}
3897
3898/*
3899 * Get next function line.
3900 * Called by do_cmdline() to get the next line.
3901 * Returns allocated string, or NULL for end of function.
3902 */
3903 char_u *
3904get_func_line(
3905 int c UNUSED,
3906 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02003907 int indent UNUSED,
3908 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909{
3910 funccall_T *fcp = (funccall_T *)cookie;
3911 ufunc_T *fp = fcp->func;
3912 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003913 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914
Bram Moolenaare38eab22019-12-05 21:50:01 +01003915 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916 if (fcp->dbg_tick != debug_tick)
3917 {
3918 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003919 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 fcp->dbg_tick = debug_tick;
3921 }
3922#ifdef FEAT_PROFILE
3923 if (do_profiling == PROF_YES)
3924 func_line_end(cookie);
3925#endif
3926
3927 gap = &fp->uf_lines;
3928 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
3929 || fcp->returned)
3930 retval = NULL;
3931 else
3932 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003933 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 while (fcp->linenr < gap->ga_len
3935 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
3936 ++fcp->linenr;
3937 if (fcp->linenr >= gap->ga_len)
3938 retval = NULL;
3939 else
3940 {
3941 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003942 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943#ifdef FEAT_PROFILE
3944 if (do_profiling == PROF_YES)
3945 func_line_start(cookie);
3946#endif
3947 }
3948 }
3949
Bram Moolenaare38eab22019-12-05 21:50:01 +01003950 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003951 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003953 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003954 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003956 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 fcp->dbg_tick = debug_tick;
3958 }
3959
3960 return retval;
3961}
3962
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963/*
3964 * Return TRUE if the currently active function should be ended, because a
3965 * return was encountered or an error occurred. Used inside a ":while".
3966 */
3967 int
3968func_has_ended(void *cookie)
3969{
3970 funccall_T *fcp = (funccall_T *)cookie;
3971
Bram Moolenaare38eab22019-12-05 21:50:01 +01003972 // Ignore the "abort" flag if the abortion behavior has been changed due to
3973 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003974 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
3975 || fcp->returned);
3976}
3977
3978/*
3979 * return TRUE if cookie indicates a function which "abort"s on errors.
3980 */
3981 int
3982func_has_abort(
3983 void *cookie)
3984{
3985 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
3986}
3987
3988
3989/*
3990 * Turn "dict.Func" into a partial for "Func" bound to "dict".
3991 * Don't do this when "Func" is already a partial that was bound
3992 * explicitly (pt_auto is FALSE).
3993 * Changes "rettv" in-place.
3994 * Returns the updated "selfdict_in".
3995 */
3996 dict_T *
3997make_partial(dict_T *selfdict_in, typval_T *rettv)
3998{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003999 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000 char_u *tofree = NULL;
4001 ufunc_T *fp;
4002 char_u fname_buf[FLEN_FIXED + 1];
4003 int error;
4004 dict_T *selfdict = selfdict_in;
4005
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004006 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4007 fp = rettv->vval.v_partial->pt_func;
4008 else
4009 {
4010 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4011 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004012 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004013 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004014 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004015 vim_free(tofree);
4016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017
4018 if (fp != NULL && (fp->uf_flags & FC_DICT))
4019 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004020 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021
4022 if (pt != NULL)
4023 {
4024 pt->pt_refcount = 1;
4025 pt->pt_dict = selfdict;
4026 pt->pt_auto = TRUE;
4027 selfdict = NULL;
4028 if (rettv->v_type == VAR_FUNC)
4029 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004030 // Just a function: Take over the function name and use
4031 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 pt->pt_name = rettv->vval.v_string;
4033 }
4034 else
4035 {
4036 partial_T *ret_pt = rettv->vval.v_partial;
4037 int i;
4038
Bram Moolenaare38eab22019-12-05 21:50:01 +01004039 // Partial: copy the function name, use selfdict and copy
4040 // args. Can't take over name or args, the partial might
4041 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004042 if (ret_pt->pt_name != NULL)
4043 {
4044 pt->pt_name = vim_strsave(ret_pt->pt_name);
4045 func_ref(pt->pt_name);
4046 }
4047 else
4048 {
4049 pt->pt_func = ret_pt->pt_func;
4050 func_ptr_ref(pt->pt_func);
4051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 if (ret_pt->pt_argc > 0)
4053 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004054 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004056 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 pt->pt_argc = 0;
4058 else
4059 {
4060 pt->pt_argc = ret_pt->pt_argc;
4061 for (i = 0; i < pt->pt_argc; i++)
4062 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4063 }
4064 }
4065 partial_unref(ret_pt);
4066 }
4067 rettv->v_type = VAR_PARTIAL;
4068 rettv->vval.v_partial = pt;
4069 }
4070 }
4071 return selfdict;
4072}
4073
4074/*
4075 * Return the name of the executed function.
4076 */
4077 char_u *
4078func_name(void *cookie)
4079{
4080 return ((funccall_T *)cookie)->func->uf_name;
4081}
4082
4083/*
4084 * Return the address holding the next breakpoint line for a funccall cookie.
4085 */
4086 linenr_T *
4087func_breakpoint(void *cookie)
4088{
4089 return &((funccall_T *)cookie)->breakpoint;
4090}
4091
4092/*
4093 * Return the address holding the debug tick for a funccall cookie.
4094 */
4095 int *
4096func_dbg_tick(void *cookie)
4097{
4098 return &((funccall_T *)cookie)->dbg_tick;
4099}
4100
4101/*
4102 * Return the nesting level for a funccall cookie.
4103 */
4104 int
4105func_level(void *cookie)
4106{
4107 return ((funccall_T *)cookie)->level;
4108}
4109
4110/*
4111 * Return TRUE when a function was ended by a ":return" command.
4112 */
4113 int
4114current_func_returned(void)
4115{
4116 return current_funccal->returned;
4117}
4118
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004119 int
4120free_unref_funccal(int copyID, int testing)
4121{
4122 int did_free = FALSE;
4123 int did_free_funccal = FALSE;
4124 funccall_T *fc, **pfc;
4125
4126 for (pfc = &previous_funccal; *pfc != NULL; )
4127 {
4128 if (can_free_funccal(*pfc, copyID))
4129 {
4130 fc = *pfc;
4131 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004132 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133 did_free = TRUE;
4134 did_free_funccal = TRUE;
4135 }
4136 else
4137 pfc = &(*pfc)->caller;
4138 }
4139 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004140 // When a funccal was freed some more items might be garbage
4141 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142 (void)garbage_collect(testing);
4143
4144 return did_free;
4145}
4146
4147/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004148 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004149 */
4150 static funccall_T *
4151get_funccal(void)
4152{
4153 int i;
4154 funccall_T *funccal;
4155 funccall_T *temp_funccal;
4156
4157 funccal = current_funccal;
4158 if (debug_backtrace_level > 0)
4159 {
4160 for (i = 0; i < debug_backtrace_level; i++)
4161 {
4162 temp_funccal = funccal->caller;
4163 if (temp_funccal)
4164 funccal = temp_funccal;
4165 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004166 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 debug_backtrace_level = i;
4168 }
4169 }
4170 return funccal;
4171}
4172
4173/*
4174 * Return the hashtable used for local variables in the current funccal.
4175 * Return NULL if there is no current funccal.
4176 */
4177 hashtab_T *
4178get_funccal_local_ht()
4179{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004180 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 return NULL;
4182 return &get_funccal()->l_vars.dv_hashtab;
4183}
4184
4185/*
4186 * Return the l: scope variable.
4187 * Return NULL if there is no current funccal.
4188 */
4189 dictitem_T *
4190get_funccal_local_var()
4191{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004192 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 return NULL;
4194 return &get_funccal()->l_vars_var;
4195}
4196
4197/*
4198 * Return the hashtable used for argument in the current funccal.
4199 * Return NULL if there is no current funccal.
4200 */
4201 hashtab_T *
4202get_funccal_args_ht()
4203{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004204 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004205 return NULL;
4206 return &get_funccal()->l_avars.dv_hashtab;
4207}
4208
4209/*
4210 * Return the a: scope variable.
4211 * Return NULL if there is no current funccal.
4212 */
4213 dictitem_T *
4214get_funccal_args_var()
4215{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004216 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004218 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219}
4220
4221/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222 * List function variables, if there is a function.
4223 */
4224 void
4225list_func_vars(int *first)
4226{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004227 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004228 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004229 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230}
4231
4232/*
4233 * If "ht" is the hashtable for local variables in the current funccal, return
4234 * the dict that contains it.
4235 * Otherwise return NULL.
4236 */
4237 dict_T *
4238get_current_funccal_dict(hashtab_T *ht)
4239{
4240 if (current_funccal != NULL
4241 && ht == &current_funccal->l_vars.dv_hashtab)
4242 return &current_funccal->l_vars;
4243 return NULL;
4244}
4245
4246/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004247 * Search hashitem in parent scope.
4248 */
4249 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004250find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004251{
4252 funccall_T *old_current_funccal = current_funccal;
4253 hashtab_T *ht;
4254 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004255 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004256
4257 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4258 return NULL;
4259
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004261 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004262 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004263 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004264 ht = find_var_ht(name, &varname);
4265 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004266 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004267 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004268 if (!HASHITEM_EMPTY(hi))
4269 {
4270 *pht = ht;
4271 break;
4272 }
4273 }
4274 if (current_funccal == current_funccal->func->uf_scoped)
4275 break;
4276 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004277 }
4278 current_funccal = old_current_funccal;
4279
4280 return hi;
4281}
4282
4283/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004284 * Search variable in parent scope.
4285 */
4286 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004287find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004288{
4289 dictitem_T *v = NULL;
4290 funccall_T *old_current_funccal = current_funccal;
4291 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004292 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004293
4294 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4295 return NULL;
4296
Bram Moolenaare38eab22019-12-05 21:50:01 +01004297 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004298 current_funccal = current_funccal->func->uf_scoped;
4299 while (current_funccal)
4300 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004301 ht = find_var_ht(name, &varname);
4302 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004303 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004304 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004305 if (v != NULL)
4306 break;
4307 }
4308 if (current_funccal == current_funccal->func->uf_scoped)
4309 break;
4310 current_funccal = current_funccal->func->uf_scoped;
4311 }
4312 current_funccal = old_current_funccal;
4313
4314 return v;
4315}
4316
4317/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 * Set "copyID + 1" in previous_funccal and callers.
4319 */
4320 int
4321set_ref_in_previous_funccal(int copyID)
4322{
4323 int abort = FALSE;
4324 funccall_T *fc;
4325
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004326 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004328 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004329 abort = abort
4330 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4331 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004332 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333 }
4334 return abort;
4335}
4336
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004337 static int
4338set_ref_in_funccal(funccall_T *fc, int copyID)
4339{
4340 int abort = FALSE;
4341
4342 if (fc->fc_copyID != copyID)
4343 {
4344 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004345 abort = abort
4346 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4347 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004348 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004349 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004350 }
4351 return abort;
4352}
4353
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004354/*
4355 * Set "copyID" in all local vars and arguments in the call stack.
4356 */
4357 int
4358set_ref_in_call_stack(int copyID)
4359{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004360 int abort = FALSE;
4361 funccall_T *fc;
4362 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004364 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004365 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004366
4367 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004368 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4369 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004370 abort = abort || set_ref_in_funccal(fc, copyID);
4371
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004372 return abort;
4373}
4374
4375/*
4376 * Set "copyID" in all functions available by name.
4377 */
4378 int
4379set_ref_in_functions(int copyID)
4380{
4381 int todo;
4382 hashitem_T *hi = NULL;
4383 int abort = FALSE;
4384 ufunc_T *fp;
4385
4386 todo = (int)func_hashtab.ht_used;
4387 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004388 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004389 if (!HASHITEM_EMPTY(hi))
4390 {
4391 --todo;
4392 fp = HI2UF(hi);
4393 if (!func_name_refcount(fp->uf_name))
4394 abort = abort || set_ref_in_func(NULL, fp, copyID);
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004395 else if (fp->uf_dfunc_idx >= 0)
4396 abort = abort || set_ref_in_dfunc(fp, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 }
4399 return abort;
4400}
4401
4402/*
4403 * Set "copyID" in all function arguments.
4404 */
4405 int
4406set_ref_in_func_args(int copyID)
4407{
4408 int i;
4409 int abort = FALSE;
4410
4411 for (i = 0; i < funcargs.ga_len; ++i)
4412 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4413 copyID, NULL, NULL);
4414 return abort;
4415}
4416
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004417/*
4418 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004419 * Returns TRUE if setting references failed somehow.
4420 */
4421 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004422set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004423{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004424 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004425 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004426 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004427 char_u fname_buf[FLEN_FIXED + 1];
4428 char_u *tofree = NULL;
4429 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004430 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004431
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004432 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004433 return FALSE;
4434
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004435 if (fp_in == NULL)
4436 {
4437 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004438 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004439 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004440 if (fp != NULL)
4441 {
4442 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004443 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004444 if (fp->uf_dfunc_idx >= 0)
4445 abort = abort || set_ref_in_dfunc(fp, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004446 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004447
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004448 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004449 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004450}
4451
Bram Moolenaare38eab22019-12-05 21:50:01 +01004452#endif // FEAT_EVAL