blob: 97c8f871af6937f529e6e3b93489da3123f028a2 [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;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200242 if (eval1(&p, &rettv, 0) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200243 {
244 if (ga_grow(default_args, 1) == FAIL)
245 goto err_ret;
246
247 // trim trailing whitespace
248 while (p > expr && VIM_ISWHITE(p[-1]))
249 p--;
250 c = *p;
251 *p = NUL;
252 expr = vim_strsave(expr);
253 if (expr == NULL)
254 {
255 *p = c;
256 goto err_ret;
257 }
258 ((char_u **)(default_args->ga_data))
259 [default_args->ga_len] = expr;
260 default_args->ga_len++;
261 *p = c;
262 }
263 else
264 mustend = TRUE;
265 }
266 else if (any_default)
267 {
268 emsg(_("E989: Non-default argument follows default argument"));
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 Moolenaar04b12692020-05-04 23:24:44 +0200332 * Get a name for a lambda. Returned in static memory.
333 */
334 char_u *
335get_lambda_name(void)
336{
337 static char_u name[30];
338 static int lambda_no = 0;
339
340 sprintf((char*)name, "<lambda>%d", ++lambda_no);
341 return name;
342}
343
344/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200345 * Parse a lambda expression and get a Funcref from "*arg".
346 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
347 */
348 int
349get_lambda_tv(char_u **arg, typval_T *rettv, int evaluate)
350{
351 garray_T newargs;
352 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200353 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200354 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100355 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200356 int varargs;
357 int ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200358 char_u *start = skipwhite(*arg + 1);
359 char_u *s, *e;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200360 int *old_eval_lavars = eval_lavars_used;
361 int eval_lavars = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362
363 ga_init(&newargs);
364 ga_init(&newlines);
365
Bram Moolenaare38eab22019-12-05 21:50:01 +0100366 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200367 ret = get_function_args(&start, '-', NULL, NULL, NULL, NULL, TRUE,
368 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200369 if (ret == FAIL || *start != '>')
370 return NOTDONE;
371
Bram Moolenaare38eab22019-12-05 21:50:01 +0100372 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200373 if (evaluate)
374 pnewargs = &newargs;
375 else
376 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 *arg = skipwhite(*arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100378 // TODO: argument types
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200379 ret = get_function_args(arg, '-', pnewargs, NULL, &varargs, NULL, FALSE,
380 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200381 if (ret == FAIL || **arg != '>')
382 goto errret;
383
Bram Moolenaare38eab22019-12-05 21:50:01 +0100384 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200385 if (evaluate)
386 eval_lavars_used = &eval_lavars;
387
Bram Moolenaare38eab22019-12-05 21:50:01 +0100388 // Get the start and the end of the expression.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200389 *arg = skipwhite(*arg + 1);
390 s = *arg;
391 ret = skip_expr(arg);
392 if (ret == FAIL)
393 goto errret;
394 e = *arg;
395 *arg = skipwhite(*arg);
396 if (**arg != '}')
Bram Moolenaaree619e52020-03-28 21:38:06 +0100397 {
398 semsg(_("E451: Expected }: %s"), *arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200399 goto errret;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100400 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200401 ++*arg;
402
403 if (evaluate)
404 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200405 int len, flags = 0;
406 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200407 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200408
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200409 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200410 if (fp == NULL)
411 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200412 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200413 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200414 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200415 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200416
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200417 ga_init2(&newlines, (int)sizeof(char_u *), 1);
418 if (ga_grow(&newlines, 1) == FAIL)
419 goto errret;
420
Bram Moolenaare38eab22019-12-05 21:50:01 +0100421 // Add "return " before the expression.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200422 len = 7 + e - s + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200423 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200424 if (p == NULL)
425 goto errret;
426 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
427 STRCPY(p, "return ");
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200428 vim_strncpy(p + 7, s, e - s);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200429 if (strstr((char *)p + 7, "a:") == NULL)
430 // No a: variables are used for sure.
431 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200432
433 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100434 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200435 hash_add(&func_hashtab, UF2HIKEY(fp));
436 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200437 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200438 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200439 if (current_funccal != NULL && eval_lavars)
440 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200441 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200442 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200443 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200444 }
445 else
446 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200447
448#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200449 if (prof_def_func())
450 func_do_profile(fp);
451#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200452 if (sandbox)
453 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100454 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200455 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200456 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200457 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200458 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100459 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200460
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200461 pt->pt_func = fp;
462 pt->pt_refcount = 1;
463 rettv->vval.v_partial = pt;
464 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200466
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200467 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200468 return OK;
469
470errret:
471 ga_clear_strings(&newargs);
472 ga_clear_strings(&newlines);
473 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100474 vim_free(pt);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200475 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200476 return FAIL;
477}
478
479/*
480 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
481 * name it contains, otherwise return "name".
482 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
483 * "partialp".
484 */
485 char_u *
486deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
487{
488 dictitem_T *v;
489 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200490 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200491
492 if (partialp != NULL)
493 *partialp = NULL;
494
495 cc = name[*lenp];
496 name[*lenp] = NUL;
497 v = find_var(name, NULL, no_autoload);
498 name[*lenp] = cc;
499 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
500 {
501 if (v->di_tv.vval.v_string == NULL)
502 {
503 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100504 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200505 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200506 s = v->di_tv.vval.v_string;
507 *lenp = (int)STRLEN(s);
508 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200509 }
510
511 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
512 {
513 partial_T *pt = v->di_tv.vval.v_partial;
514
515 if (pt == NULL)
516 {
517 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100518 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200519 }
520 if (partialp != NULL)
521 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200522 s = partial_name(pt);
523 *lenp = (int)STRLEN(s);
524 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200525 }
526
527 return name;
528}
529
530/*
531 * Give an error message with a function name. Handle <SNR> things.
532 * "ermsg" is to be passed without translation, use N_() instead of _().
533 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100534 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200535emsg_funcname(char *ermsg, char_u *name)
536{
537 char_u *p;
538
539 if (*name == K_SPECIAL)
540 p = concat_str((char_u *)"<SNR>", name + 3);
541 else
542 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100543 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200544 if (p != name)
545 vim_free(p);
546}
547
548/*
549 * Allocate a variable for the result of a function.
550 * Return OK or FAIL.
551 */
552 int
553get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200554 char_u *name, // name of the function
555 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200556 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200557 char_u **arg, // argument, pointing to the '('
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200558 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200559{
560 char_u *argp;
561 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100562 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
563 int argcount = 0; // number of arguments found
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200564
565 /*
566 * Get the arguments.
567 */
568 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200569 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
570 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200571 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100572 argp = skipwhite(argp + 1); // skip the '(' or ','
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200573 if (*argp == ')' || *argp == ',' || *argp == NUL)
574 break;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200575 if (eval1(&argp, &argvars[argcount],
576 funcexe->evaluate ? EVAL_EVALUATE : 0) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200577 {
578 ret = FAIL;
579 break;
580 }
581 ++argcount;
582 if (*argp != ',')
583 break;
584 }
585 if (*argp == ')')
586 ++argp;
587 else
588 ret = FAIL;
589
590 if (ret == OK)
591 {
592 int i = 0;
593
594 if (get_vim_var_nr(VV_TESTING))
595 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100596 // Prepare for calling test_garbagecollect_now(), need to know
597 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200598 if (funcargs.ga_itemsize == 0)
599 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
600 for (i = 0; i < argcount; ++i)
601 if (ga_grow(&funcargs, 1) == OK)
602 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
603 &argvars[i];
604 }
605
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200606 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200607
608 funcargs.ga_len -= i;
609 }
610 else if (!aborting())
611 {
612 if (argcount == MAX_FUNC_ARGS)
613 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
614 else
615 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
616 }
617
618 while (--argcount >= 0)
619 clear_tv(&argvars[argcount]);
620
621 *arg = skipwhite(argp);
622 return ret;
623}
624
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200625/*
626 * Return TRUE if "p" starts with "<SID>" or "s:".
627 * Only works if eval_fname_script() returned non-zero for "p"!
628 */
629 static int
630eval_fname_sid(char_u *p)
631{
632 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
633}
634
635/*
636 * In a script change <SID>name() and s:name() to K_SNR 123_name().
637 * Change <SNR>123_name() to K_SNR 123_name().
638 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
639 * (slow).
640 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100641 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200642fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
643{
644 int llen;
645 char_u *fname;
646 int i;
647
648 llen = eval_fname_script(name);
649 if (llen > 0)
650 {
651 fname_buf[0] = K_SPECIAL;
652 fname_buf[1] = KS_EXTRA;
653 fname_buf[2] = (int)KE_SNR;
654 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100655 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200656 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200657 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100658 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200659 else
660 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200661 sprintf((char *)fname_buf + 3, "%ld_",
662 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200663 i = (int)STRLEN(fname_buf);
664 }
665 }
666 if (i + STRLEN(name + llen) < FLEN_FIXED)
667 {
668 STRCPY(fname_buf + i, name + llen);
669 fname = fname_buf;
670 }
671 else
672 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200673 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200674 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100675 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200676 else
677 {
678 *tofree = fname;
679 mch_memmove(fname, fname_buf, (size_t)i);
680 STRCPY(fname + i, name + llen);
681 }
682 }
683 }
684 else
685 fname = name;
686 return fname;
687}
688
689/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100690 * Find a function "name" in script "sid".
691 */
692 static ufunc_T *
693find_func_with_sid(char_u *name, int sid)
694{
695 hashitem_T *hi;
696 char_u buffer[200];
697
698 buffer[0] = K_SPECIAL;
699 buffer[1] = KS_EXTRA;
700 buffer[2] = (int)KE_SNR;
701 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
702 (long)sid, name);
703 hi = hash_find(&func_hashtab, buffer);
704 if (!HASHITEM_EMPTY(hi))
705 return HI2UF(hi);
706
707 return NULL;
708}
709
710/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200711 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200712 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200713 * Return NULL for unknown function.
714 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100715 static ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200716find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200717{
718 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100719 ufunc_T *func;
720 imported_T *imported;
721
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200722 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100723 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200724 char_u *after_script = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100725
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200726 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100727 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200728 // Find script-local function before global one.
729 func = find_func_with_sid(name, current_sctx.sc_sid);
730 if (func != NULL)
731 return func;
732 }
733
734 if (!in_vim9script()
735 && name[0] == K_SPECIAL
736 && name[1] == KS_EXTRA
737 && name[2] == KE_SNR)
738 {
739 long sid;
740
741 // Caller changes s: to <SNR>99_name.
742
743 after_script = name + 3;
744 sid = getdigits(&after_script);
745 if (sid == current_sctx.sc_sid && *after_script == '_')
746 ++after_script;
747 else
748 after_script = NULL;
749 }
750 if (in_vim9script() || after_script != NULL)
751 {
752 // Find imported function before global one.
753 imported = find_imported(
754 after_script == NULL ? name : after_script, 0, cctx);
755 if (imported != NULL && imported->imp_funcname != NULL)
756 {
757 hi = hash_find(&func_hashtab, imported->imp_funcname);
758 if (!HASHITEM_EMPTY(hi))
759 return HI2UF(hi);
760 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100761 }
762 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200763
Bram Moolenaara26b9702020-04-18 19:53:28 +0200764 hi = hash_find(&func_hashtab,
765 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200766 if (!HASHITEM_EMPTY(hi))
767 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100768
769 return NULL;
770}
771
772/*
773 * Find a function by name, return pointer to it in ufuncs.
774 * "cctx" is passed in a :def function to find imported functions.
775 * Return NULL for unknown or dead function.
776 */
777 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200778find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100779{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200780 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100781
782 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
783 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200784 return NULL;
785}
786
787/*
788 * Copy the function name of "fp" to buffer "buf".
789 * "buf" must be able to hold the function name plus three bytes.
790 * Takes care of script-local function names.
791 */
792 static void
793cat_func_name(char_u *buf, ufunc_T *fp)
794{
795 if (fp->uf_name[0] == K_SPECIAL)
796 {
797 STRCPY(buf, "<SNR>");
798 STRCAT(buf, fp->uf_name + 3);
799 }
800 else
801 STRCPY(buf, fp->uf_name);
802}
803
804/*
805 * Add a number variable "name" to dict "dp" with value "nr".
806 */
807 static void
808add_nr_var(
809 dict_T *dp,
810 dictitem_T *v,
811 char *name,
812 varnumber_T nr)
813{
814 STRCPY(v->di_key, name);
815 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
816 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
817 v->di_tv.v_type = VAR_NUMBER;
818 v->di_tv.v_lock = VAR_FIXED;
819 v->di_tv.vval.v_number = nr;
820}
821
822/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100823 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200824 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100825 static void
826free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200827{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100828 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200829
830 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
831 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100832 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200833
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100834 // When garbage collecting a funccall_T may be freed before the
835 // function that references it, clear its uf_scoped field.
836 // The function may have been redefined and point to another
837 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200838 if (fp != NULL && fp->uf_scoped == fc)
839 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200840 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200841 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200842
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200843 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200844 vim_free(fc);
845}
846
847/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100848 * Free "fc" and what it contains.
849 * Can be called only when "fc" is kept beyond the period of it called,
850 * i.e. after cleanup_function_call(fc).
851 */
852 static void
853free_funccal_contents(funccall_T *fc)
854{
855 listitem_T *li;
856
857 // Free all l: variables.
858 vars_clear(&fc->l_vars.dv_hashtab);
859
860 // Free all a: variables.
861 vars_clear(&fc->l_avars.dv_hashtab);
862
863 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200864 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100865 clear_tv(&li->li_tv);
866
867 free_funccal(fc);
868}
869
870/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200871 * Handle the last part of returning from a function: free the local hashtable.
872 * Unless it is still in use by a closure.
873 */
874 static void
875cleanup_function_call(funccall_T *fc)
876{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100877 int may_free_fc = fc->fc_refcount <= 0;
878 int free_fc = TRUE;
879
Bram Moolenaar6914c642017-04-01 21:21:30 +0200880 current_funccal = fc->caller;
881
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100882 // Free all l: variables if not referred.
883 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
884 vars_clear(&fc->l_vars.dv_hashtab);
885 else
886 free_fc = FALSE;
887
888 // If the a:000 list and the l: and a: dicts are not referenced and
889 // there is no closure using it, we can free the funccall_T and what's
890 // in it.
891 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
892 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200893 else
894 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100895 int todo;
896 hashitem_T *hi;
897 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200898
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100899 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200900
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100901 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200902 todo = (int)fc->l_avars.dv_hashtab.ht_used;
903 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
904 {
905 if (!HASHITEM_EMPTY(hi))
906 {
907 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100908 di = HI2DI(hi);
909 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200910 }
911 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100912 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200913
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100914 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
915 fc->l_varlist.lv_first = NULL;
916 else
917 {
918 listitem_T *li;
919
920 free_fc = FALSE;
921
922 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200923 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200924 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100925 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100926
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100927 if (free_fc)
928 free_funccal(fc);
929 else
930 {
931 static int made_copy = 0;
932
933 // "fc" is still in use. This can happen when returning "a:000",
934 // assigning "l:" to a global variable or defining a closure.
935 // Link "fc" in the list for garbage collection later.
936 fc->caller = previous_funccal;
937 previous_funccal = fc;
938
939 if (want_garbage_collect)
940 // If garbage collector is ready, clear count.
941 made_copy = 0;
942 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100943 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100944 // We have made a lot of copies, worth 4 Mbyte. This can happen
945 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100946 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100947 // too much memory.
948 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100949 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100950 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200951 }
952}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100953/*
954 * Unreference "fc": decrement the reference count and free it when it
955 * becomes zero. "fp" is detached from "fc".
956 * When "force" is TRUE we are exiting.
957 */
958 static void
959funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
960{
961 funccall_T **pfc;
962 int i;
963
964 if (fc == NULL)
965 return;
966
967 if (--fc->fc_refcount <= 0 && (force || (
968 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
969 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
970 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
971 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
972 {
973 if (fc == *pfc)
974 {
975 *pfc = fc->caller;
976 free_funccal_contents(fc);
977 return;
978 }
979 }
980 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
981 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
982 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
983}
984
985/*
986 * Remove the function from the function hashtable. If the function was
987 * deleted while it still has references this was already done.
988 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
989 */
990 static int
991func_remove(ufunc_T *fp)
992{
993 hashitem_T *hi;
994
995 // Return if it was already virtually deleted.
996 if (fp->uf_flags & FC_DEAD)
997 return FALSE;
998
999 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1000 if (!HASHITEM_EMPTY(hi))
1001 {
1002 // When there is a def-function index do not actually remove the
1003 // function, so we can find the index when defining the function again.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001004 if (fp->uf_def_status == UF_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001005 fp->uf_flags |= FC_DEAD;
1006 else
1007 hash_remove(&func_hashtab, hi);
1008 return TRUE;
1009 }
1010 return FALSE;
1011}
1012
1013 static void
1014func_clear_items(ufunc_T *fp)
1015{
1016 ga_clear_strings(&(fp->uf_args));
1017 ga_clear_strings(&(fp->uf_def_args));
1018 ga_clear_strings(&(fp->uf_lines));
1019 VIM_CLEAR(fp->uf_name_exp);
1020 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001021 VIM_CLEAR(fp->uf_def_arg_idx);
1022 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02001023 while (fp->uf_type_list.ga_len > 0)
1024 vim_free(((type_T **)fp->uf_type_list.ga_data)
1025 [--fp->uf_type_list.ga_len]);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001026 ga_clear(&fp->uf_type_list);
1027#ifdef FEAT_PROFILE
1028 VIM_CLEAR(fp->uf_tml_count);
1029 VIM_CLEAR(fp->uf_tml_total);
1030 VIM_CLEAR(fp->uf_tml_self);
1031#endif
1032}
1033
1034/*
1035 * Free all things that a function contains. Does not free the function
1036 * itself, use func_free() for that.
1037 * When "force" is TRUE we are exiting.
1038 */
1039 static void
1040func_clear(ufunc_T *fp, int force)
1041{
1042 if (fp->uf_cleared)
1043 return;
1044 fp->uf_cleared = TRUE;
1045
1046 // clear this function
1047 func_clear_items(fp);
1048 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001049 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001050}
1051
1052/*
1053 * Free a function and remove it from the list of functions. Does not free
1054 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001055 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001056 */
1057 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001058func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001059{
1060 // Only remove it when not done already, otherwise we would remove a newer
1061 // version of the function with the same name.
1062 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1063 func_remove(fp);
1064
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001065 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001066 vim_free(fp);
1067}
1068
1069/*
1070 * Free all things that a function contains and free the function itself.
1071 * When "force" is TRUE we are exiting.
1072 */
1073 static void
1074func_clear_free(ufunc_T *fp, int force)
1075{
1076 func_clear(fp, force);
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001077 if (force || fp->uf_dfunc_idx == 0)
1078 func_free(fp, force);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001079}
1080
Bram Moolenaar6914c642017-04-01 21:21:30 +02001081
1082/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001083 * Call a user function.
1084 */
1085 static void
1086call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001087 ufunc_T *fp, // pointer to function
1088 int argcount, // nr of args
1089 typval_T *argvars, // arguments
1090 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001091 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001092 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001093{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001094 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001095 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001096 funccall_T *fc;
1097 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001098 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001099 static int depth = 0;
1100 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001101 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001102 int i;
1103 int ai;
1104 int islambda = FALSE;
1105 char_u numbuf[NUMBUFLEN];
1106 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001107#ifdef FEAT_PROFILE
1108 proftime_T wait_start;
1109 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001110 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001112 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001113
Bram Moolenaare38eab22019-12-05 21:50:01 +01001114 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001115 if (depth >= p_mfd)
1116 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001117 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001118 rettv->v_type = VAR_NUMBER;
1119 rettv->vval.v_number = -1;
1120 return;
1121 }
1122 ++depth;
1123
Bram Moolenaare38eab22019-12-05 21:50:01 +01001124 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001125
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001126 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001127 if (fc == NULL)
1128 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001129 fc->caller = current_funccal;
1130 current_funccal = fc;
1131 fc->func = fp;
1132 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001133 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001134 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001135 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1136 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001137 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001138 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001139 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001140
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001141 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001142 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001143 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001144 save_current_sctx = current_sctx;
1145 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001146
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001147 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001148 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001149 --depth;
1150 current_funccal = fc->caller;
1151
1152 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001153 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001154 free_funccal(fc);
1155 return;
1156 }
1157
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001158 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1159 islambda = TRUE;
1160
1161 /*
1162 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1163 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1164 * each argument variable and saves a lot of time.
1165 */
1166 /*
1167 * Init l: variables.
1168 */
1169 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1170 if (selfdict != NULL)
1171 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001172 // Set l:self to "selfdict". Use "name" to avoid a warning from
1173 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001174 v = &fc->fixvar[fixvar_idx++].var;
1175 name = v->di_key;
1176 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001177 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001178 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1179 v->di_tv.v_type = VAR_DICT;
1180 v->di_tv.v_lock = 0;
1181 v->di_tv.vval.v_dict = selfdict;
1182 ++selfdict->dv_refcount;
1183 }
1184
1185 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001186 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001187 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001188 * Set a:000 to a list with room for the "..." arguments.
1189 */
1190 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001191 if ((fp->uf_flags & FC_NOARGS) == 0)
1192 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001193 (varnumber_T)(argcount >= fp->uf_args.ga_len
1194 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001195 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001196 if ((fp->uf_flags & FC_NOARGS) == 0)
1197 {
1198 // Use "name" to avoid a warning from some compiler that checks the
1199 // destination size.
1200 v = &fc->fixvar[fixvar_idx++].var;
1201 name = v->di_key;
1202 STRCPY(name, "000");
1203 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1204 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1205 v->di_tv.v_type = VAR_LIST;
1206 v->di_tv.v_lock = VAR_FIXED;
1207 v->di_tv.vval.v_list = &fc->l_varlist;
1208 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001209 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001210 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1211 fc->l_varlist.lv_lock = VAR_FIXED;
1212
1213 /*
1214 * Set a:firstline to "firstline" and a:lastline to "lastline".
1215 * Set a:name to named arguments.
1216 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001217 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001218 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001219 if ((fp->uf_flags & FC_NOARGS) == 0)
1220 {
1221 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001222 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001223 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001224 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001225 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001226 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001227 {
1228 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001229 typval_T def_rettv;
1230 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001231
1232 ai = i - fp->uf_args.ga_len;
1233 if (ai < 0)
1234 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001235 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001236 name = FUNCARG(fp, i);
1237 if (islambda)
1238 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001239
1240 // evaluate named argument default expression
1241 isdefault = ai + fp->uf_def_args.ga_len >= 0
1242 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1243 && argvars[i].vval.v_number == VVAL_NONE));
1244 if (isdefault)
1245 {
1246 char_u *default_expr = NULL;
1247 def_rettv.v_type = VAR_NUMBER;
1248 def_rettv.vval.v_number = -1;
1249
1250 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1251 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar32e35112020-05-14 22:41:15 +02001252 if (eval1(&default_expr, &def_rettv, EVAL_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001253 {
1254 default_arg_err = 1;
1255 break;
1256 }
1257 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001258 }
1259 else
1260 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001261 if ((fp->uf_flags & FC_NOARGS) != 0)
1262 // Bail out if no a: arguments used (in lambda).
1263 break;
1264
Bram Moolenaare38eab22019-12-05 21:50:01 +01001265 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001266 sprintf((char *)numbuf, "%d", ai + 1);
1267 name = numbuf;
1268 }
1269 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1270 {
1271 v = &fc->fixvar[fixvar_idx++].var;
1272 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001273 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 }
1275 else
1276 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001277 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001278 if (v == NULL)
1279 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001280 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001281 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001282
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001283 // Note: the values are copied directly to avoid alloc/free.
1284 // "argvars" must have VAR_FIXED for v_lock.
1285 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286 v->di_tv.v_lock = VAR_FIXED;
1287
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288 if (addlocal)
1289 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001290 // Named arguments should be accessed without the "a:" prefix in
1291 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001292 copy_tv(&v->di_tv, &v->di_tv);
1293 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001294 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001295 else
1296 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001297
1298 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1299 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001300 listitem_T *li = &fc->l_listitems[ai];
1301
1302 li->li_tv = argvars[i];
1303 li->li_tv.v_lock = VAR_FIXED;
1304 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001305 }
1306 }
1307
Bram Moolenaare38eab22019-12-05 21:50:01 +01001308 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001310
1311 if (fp->uf_flags & FC_SANDBOX)
1312 {
1313 using_sandbox = TRUE;
1314 ++sandbox;
1315 }
1316
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001317 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001318 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001319 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001320 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001321 ++no_wait_return;
1322 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001323
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001324 smsg(_("calling %s"), SOURCING_NAME);
1325 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001327 char_u buf[MSG_BUF_LEN];
1328 char_u numbuf2[NUMBUFLEN];
1329 char_u *tofree;
1330 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001331
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001332 msg_puts("(");
1333 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001334 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001335 if (i > 0)
1336 msg_puts(", ");
1337 if (argvars[i].v_type == VAR_NUMBER)
1338 msg_outnum((long)argvars[i].vval.v_number);
1339 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001340 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001341 // Do not want errors such as E724 here.
1342 ++emsg_off;
1343 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1344 --emsg_off;
1345 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001346 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001347 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001348 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001349 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1350 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001352 msg_puts((char *)s);
1353 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001354 }
1355 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001357 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001359 msg_puts("\n"); // don't overwrite this either
1360
1361 verbose_leave_scroll();
1362 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 }
1364#ifdef FEAT_PROFILE
1365 if (do_profiling == PROF_YES)
1366 {
1367 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001368 {
1369 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001370 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372 if (fp->uf_profiling
1373 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1374 {
1375 ++fp->uf_tm_count;
1376 profile_start(&call_start);
1377 profile_zero(&fp->uf_tm_children);
1378 }
1379 script_prof_save(&wait_start);
1380 }
1381#endif
1382
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001383 save_current_sctx = current_sctx;
1384 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001385 save_did_emsg = did_emsg;
1386 did_emsg = FALSE;
1387
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001388 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1389 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001390 else if (islambda)
1391 {
1392 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1393
1394 // A Lambda always has the command "return {expr}". It is much faster
1395 // to evaluate {expr} directly.
1396 ++ex_nesting_level;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001397 (void)eval1(&p, rettv, EVAL_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001398 --ex_nesting_level;
1399 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001400 else
1401 // call do_cmdline() to execute the lines
1402 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001403 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1404
1405 --RedrawingDisabled;
1406
Bram Moolenaare38eab22019-12-05 21:50:01 +01001407 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1409 {
1410 clear_tv(rettv);
1411 rettv->v_type = VAR_NUMBER;
1412 rettv->vval.v_number = -1;
1413 }
1414
1415#ifdef FEAT_PROFILE
1416 if (do_profiling == PROF_YES && (fp->uf_profiling
1417 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1418 {
1419 profile_end(&call_start);
1420 profile_sub_wait(&wait_start, &call_start);
1421 profile_add(&fp->uf_tm_total, &call_start);
1422 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1423 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1424 {
1425 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1426 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1427 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001428 if (started_profiling)
1429 // make a ":profdel func" stop profiling the function
1430 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001431 }
1432#endif
1433
Bram Moolenaare38eab22019-12-05 21:50:01 +01001434 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435 if (p_verbose >= 12)
1436 {
1437 ++no_wait_return;
1438 verbose_enter_scroll();
1439
1440 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001441 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001443 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 (long)fc->rettv->vval.v_number);
1445 else
1446 {
1447 char_u buf[MSG_BUF_LEN];
1448 char_u numbuf2[NUMBUFLEN];
1449 char_u *tofree;
1450 char_u *s;
1451
Bram Moolenaare38eab22019-12-05 21:50:01 +01001452 // The value may be very long. Skip the middle part, so that we
1453 // have some idea how it starts and ends. smsg() would always
1454 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 ++emsg_off;
1456 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1457 --emsg_off;
1458 if (s != NULL)
1459 {
1460 if (vim_strsize(s) > MSG_BUF_CLEN)
1461 {
1462 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1463 s = buf;
1464 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001465 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001466 vim_free(tofree);
1467 }
1468 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001469 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001470
1471 verbose_leave_scroll();
1472 --no_wait_return;
1473 }
1474
Bram Moolenaare31ee862020-01-07 20:59:34 +01001475 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001476 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001477 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478#ifdef FEAT_PROFILE
1479 if (do_profiling == PROF_YES)
1480 script_prof_restore(&wait_start);
1481#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001482 if (using_sandbox)
1483 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001485 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486 {
1487 ++no_wait_return;
1488 verbose_enter_scroll();
1489
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001490 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001491 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492
1493 verbose_leave_scroll();
1494 --no_wait_return;
1495 }
1496
1497 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 --depth;
1499
Bram Moolenaar6914c642017-04-01 21:21:30 +02001500 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001501}
1502
1503/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001504 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001505 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001506 int
1507call_user_func_check(
1508 ufunc_T *fp,
1509 int argcount,
1510 typval_T *argvars,
1511 typval_T *rettv,
1512 funcexe_T *funcexe,
1513 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001514{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001515 int error;
1516 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001517
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001518 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1519 *funcexe->doesrange = TRUE;
1520 if (argcount < regular_args - fp->uf_def_args.ga_len)
1521 error = FCERR_TOOFEW;
1522 else if (!has_varargs(fp) && argcount > regular_args)
1523 error = FCERR_TOOMANY;
1524 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1525 error = FCERR_DICT;
1526 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001527 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001528 int did_save_redo = FALSE;
1529 save_redo_T save_redo;
1530
1531 /*
1532 * Call the user function.
1533 * Save and restore search patterns, script variables and
1534 * redo buffer.
1535 */
1536 save_search_patterns();
1537 if (!ins_compl_active())
1538 {
1539 saveRedobuff(&save_redo);
1540 did_save_redo = TRUE;
1541 }
1542 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001543 call_user_func(fp, argcount, argvars, rettv, funcexe,
1544 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001545 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1546 // Function was unreferenced while being used, free it now.
1547 func_clear_free(fp, FALSE);
1548 if (did_save_redo)
1549 restoreRedobuff(&save_redo);
1550 restore_search_patterns();
1551 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001552 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001553 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001554}
1555
1556/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001557 * There are two kinds of function names:
1558 * 1. ordinary names, function defined with :function
1559 * 2. numbered functions and lambdas
1560 * For the first we only count the name stored in func_hashtab as a reference,
1561 * using function() does not count as a reference, because the function is
1562 * looked up by name.
1563 */
1564 static int
1565func_name_refcount(char_u *name)
1566{
1567 return isdigit(*name) || *name == '<';
1568}
1569
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001570static funccal_entry_T *funccal_stack = NULL;
1571
1572/*
1573 * Save the current function call pointer, and set it to NULL.
1574 * Used when executing autocommands and for ":source".
1575 */
1576 void
1577save_funccal(funccal_entry_T *entry)
1578{
1579 entry->top_funccal = current_funccal;
1580 entry->next = funccal_stack;
1581 funccal_stack = entry;
1582 current_funccal = NULL;
1583}
1584
1585 void
1586restore_funccal(void)
1587{
1588 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001589 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001590 else
1591 {
1592 current_funccal = funccal_stack->top_funccal;
1593 funccal_stack = funccal_stack->next;
1594 }
1595}
1596
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001597 funccall_T *
1598get_current_funccal(void)
1599{
1600 return current_funccal;
1601}
1602
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001603/*
1604 * Mark all functions of script "sid" as deleted.
1605 */
1606 void
1607delete_script_functions(int sid)
1608{
1609 hashitem_T *hi;
1610 ufunc_T *fp;
1611 long_u todo;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001612 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001613 size_t len;
1614
1615 buf[0] = K_SPECIAL;
1616 buf[1] = KS_EXTRA;
1617 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001618 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001619 len = STRLEN(buf);
1620
1621 todo = func_hashtab.ht_used;
1622 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1623 if (!HASHITEM_EMPTY(hi))
1624 {
Bram Moolenaar03afdcf2020-04-27 23:39:30 +02001625 fp = HI2UF(hi);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001626 if (STRNCMP(fp->uf_name, buf, len) == 0)
1627 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001628 fp->uf_flags |= FC_DEAD;
1629 func_clear(fp, TRUE);
1630 }
1631 --todo;
1632 }
1633}
1634
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635#if defined(EXITFREE) || defined(PROTO)
1636 void
1637free_all_functions(void)
1638{
1639 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001640 ufunc_T *fp;
1641 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001642 long_u todo = 1;
1643 long_u used;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644
Bram Moolenaare38eab22019-12-05 21:50:01 +01001645 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001646 while (current_funccal != NULL)
1647 {
1648 clear_tv(current_funccal->rettv);
1649 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001650 if (current_funccal == NULL && funccal_stack != NULL)
1651 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001652 }
1653
Bram Moolenaare38eab22019-12-05 21:50:01 +01001654 // First clear what the functions contain. Since this may lower the
1655 // reference count of a function, it may also free a function and change
1656 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001657 while (todo > 0)
1658 {
1659 todo = func_hashtab.ht_used;
1660 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1661 if (!HASHITEM_EMPTY(hi))
1662 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001663 // clear the def function index now
1664 fp = HI2UF(hi);
1665 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001666 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001667
Bram Moolenaare38eab22019-12-05 21:50:01 +01001668 // Only free functions that are not refcounted, those are
1669 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001670 if (func_name_refcount(fp->uf_name))
1671 ++skipped;
1672 else
1673 {
1674 used = func_hashtab.ht_used;
1675 func_clear(fp, TRUE);
1676 if (used != func_hashtab.ht_used)
1677 {
1678 skipped = 0;
1679 break;
1680 }
1681 }
1682 --todo;
1683 }
1684 }
1685
Bram Moolenaare38eab22019-12-05 21:50:01 +01001686 // Now actually free the functions. Need to start all over every time,
1687 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001688 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001689 while (func_hashtab.ht_used > skipped)
1690 {
1691 todo = func_hashtab.ht_used;
1692 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 if (!HASHITEM_EMPTY(hi))
1694 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001695 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001696 // Only free functions that are not refcounted, those are
1697 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001698 fp = HI2UF(hi);
1699 if (func_name_refcount(fp->uf_name))
1700 ++skipped;
1701 else
1702 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001703 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001704 skipped = 0;
1705 break;
1706 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001708 }
1709 if (skipped == 0)
1710 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001711
1712 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713}
1714#endif
1715
1716/*
1717 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001718 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 * "len" is the length of "name", or -1 for NUL terminated.
1720 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001721 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722builtin_function(char_u *name, int len)
1723{
1724 char_u *p;
1725
Bram Moolenaara26b9702020-04-18 19:53:28 +02001726 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001727 return FALSE;
1728 p = vim_strchr(name, AUTOLOAD_CHAR);
1729 return p == NULL || (len > 0 && p > name + len);
1730}
1731
1732 int
1733func_call(
1734 char_u *name,
1735 typval_T *args,
1736 partial_T *partial,
1737 dict_T *selfdict,
1738 typval_T *rettv)
1739{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001740 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 listitem_T *item;
1742 typval_T argv[MAX_FUNC_ARGS + 1];
1743 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001744 int r = 0;
1745
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001746 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001747 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001748 {
1749 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1750 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001751 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001752 break;
1753 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001754 // Make a copy of each argument. This is needed to be able to set
1755 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001756 copy_tv(&item->li_tv, &argv[argc++]);
1757 }
1758
1759 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001760 {
1761 funcexe_T funcexe;
1762
Bram Moolenaara80faa82020-04-12 19:37:17 +02001763 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001764 funcexe.firstline = curwin->w_cursor.lnum;
1765 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001766 funcexe.evaluate = TRUE;
1767 funcexe.partial = partial;
1768 funcexe.selfdict = selfdict;
1769 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1770 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771
Bram Moolenaare38eab22019-12-05 21:50:01 +01001772 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 while (argc > 0)
1774 clear_tv(&argv[--argc]);
1775
1776 return r;
1777}
1778
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001779static int callback_depth = 0;
1780
1781 int
1782get_callback_depth(void)
1783{
1784 return callback_depth;
1785}
1786
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001788 * Invoke call_func() with a callback.
1789 */
1790 int
1791call_callback(
1792 callback_T *callback,
1793 int len, // length of "name" or -1 to use strlen()
1794 typval_T *rettv, // return value goes here
1795 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001796 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001797 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001798{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001799 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001800 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001801
Bram Moolenaara80faa82020-04-12 19:37:17 +02001802 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001803 funcexe.evaluate = TRUE;
1804 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001805 ++callback_depth;
1806 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1807 --callback_depth;
1808 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001809}
1810
1811/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001812 * Give an error message for the result of a function.
1813 * Nothing if "error" is FCERR_NONE.
1814 */
1815 void
1816user_func_error(int error, char_u *name)
1817{
1818 switch (error)
1819 {
1820 case FCERR_UNKNOWN:
1821 emsg_funcname(e_unknownfunc, name);
1822 break;
1823 case FCERR_NOTMETHOD:
1824 emsg_funcname(
1825 N_("E276: Cannot use function as a method: %s"), name);
1826 break;
1827 case FCERR_DELETED:
1828 emsg_funcname(N_(e_func_deleted), name);
1829 break;
1830 case FCERR_TOOMANY:
1831 emsg_funcname((char *)e_toomanyarg, name);
1832 break;
1833 case FCERR_TOOFEW:
1834 emsg_funcname((char *)e_toofewarg, name);
1835 break;
1836 case FCERR_SCRIPT:
1837 emsg_funcname(
1838 N_("E120: Using <SID> not in a script context: %s"), name);
1839 break;
1840 case FCERR_DICT:
1841 emsg_funcname(
1842 N_("E725: Calling dict function without Dictionary: %s"),
1843 name);
1844 break;
1845 }
1846}
1847
1848/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001850 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 * Return FAIL when the function can't be called, OK otherwise.
1852 * Also returns OK when an error was encountered while executing the function.
1853 */
1854 int
1855call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001856 char_u *funcname, // name of the function
1857 int len, // length of "name" or -1 to use strlen()
1858 typval_T *rettv, // return value goes here
1859 int argcount_in, // number of "argvars"
1860 typval_T *argvars_in, // vars for arguments, must have "argcount"
1861 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001862 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001863{
1864 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01001865 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001866 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001867 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 char_u fname_buf[FLEN_FIXED + 1];
1869 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001870 char_u *fname = NULL;
1871 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001872 int argcount = argcount_in;
1873 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001874 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001875 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
1876 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001878 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001879 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001880
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02001881 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
1882 // even when call_func() returns FAIL.
1883 rettv->v_type = VAR_UNKNOWN;
1884
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001885 if (partial != NULL)
1886 fp = partial->pt_func;
1887 if (fp == NULL)
1888 {
1889 // Make a copy of the name, if it comes from a funcref variable it
1890 // could be changed or deleted in the called function.
1891 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
1892 if (name == NULL)
1893 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001894
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001895 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1896 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001897
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001898 if (funcexe->doesrange != NULL)
1899 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001900
1901 if (partial != NULL)
1902 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001903 // When the function has a partial with a dict and there is a dict
1904 // argument, use the dict argument. That is backwards compatible.
1905 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001906 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001907 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01001908 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 {
1910 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001911 {
1912 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
1913 {
Bram Moolenaaref140542019-12-31 21:27:13 +01001914 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001915 goto theend;
1916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001918 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 for (i = 0; i < argcount_in; ++i)
1920 argv[i + argv_clear] = argvars_in[i];
1921 argvars = argv;
1922 argcount = partial->pt_argc + argcount_in;
1923 }
1924 }
1925
Bram Moolenaaref140542019-12-31 21:27:13 +01001926 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 {
1928 char_u *rfname = fname;
1929
Bram Moolenaare38eab22019-12-05 21:50:01 +01001930 // Ignore "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001931 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001932 rfname = fname + 2;
1933
Bram Moolenaare38eab22019-12-05 21:50:01 +01001934 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01001936 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001937
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001938 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001939 {
1940 /*
1941 * User defined function.
1942 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001943 if (fp == NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001944 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945
Bram Moolenaare38eab22019-12-05 21:50:01 +01001946 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 if (fp == NULL
1948 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001949 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950 && !aborting())
1951 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001952 // executed an autocommand, search for the function again
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001953 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001954 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001955 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
1957 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001958 // loaded a package, search for the function again
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001959 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001960 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02001961 if (fp == NULL)
1962 {
1963 char_u *p = untrans_function_name(rfname);
1964
1965 // If using Vim9 script try not local to the script.
1966 // TODO: should not do this if the name started with "s:".
1967 if (p != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001968 fp = find_func(p, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02001969 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001970
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001971 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01001972 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001973 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001974 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001975 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01001976 // postponed filling in the arguments, do it now
1977 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001978 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001979
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001980 if (funcexe->basetv != NULL)
1981 {
1982 // Method call: base->Method()
1983 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
1984 argv[0] = *funcexe->basetv;
1985 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001986 argvars = argv;
1987 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001988 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001989
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001990 error = call_user_func_check(fp, argcount, argvars, rettv,
1991 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001992 }
1993 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02001994 else if (funcexe->basetv != NULL)
1995 {
1996 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001997 * expr->method(): Find the method name in the table, call its
1998 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02001999 */
2000 error = call_internal_method(fname, argcount, argvars, rettv,
2001 funcexe->basetv);
2002 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002003 else
2004 {
2005 /*
2006 * Find the function name in the table, call its implementation.
2007 */
2008 error = call_internal_func(fname, argcount, argvars, rettv);
2009 }
2010 /*
2011 * The function call (or "FuncUndefined" autocommand sequence) might
2012 * have been aborted by an error, an interrupt, or an explicitly thrown
2013 * exception that has not been caught so far. This situation can be
2014 * tested for by calling aborting(). For an error in an internal
2015 * function or for the "E132" error in call_user_func(), however, the
2016 * throw point at which the "force_abort" flag (temporarily reset by
2017 * emsg()) is normally updated has not been reached yet. We need to
2018 * update that flag first to make aborting() reliable.
2019 */
2020 update_force_abort();
2021 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002022 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002023 ret = OK;
2024
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002025theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002026 /*
2027 * Report an error unless the argument evaluation or function call has been
2028 * cancelled due to an aborting error, an interrupt, or an exception.
2029 */
2030 if (!aborting())
2031 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002032 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 }
2034
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002035 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002036 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002037 clear_tv(&argv[--argv_clear + argv_base]);
2038
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 vim_free(tofree);
2040 vim_free(name);
2041
2042 return ret;
2043}
2044
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002045 static char_u *
2046printable_func_name(ufunc_T *fp)
2047{
2048 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2049}
2050
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002051/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002052 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002053 */
2054 static void
2055list_func_head(ufunc_T *fp, int indent)
2056{
2057 int j;
2058
2059 msg_start();
2060 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002061 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002062 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002063 msg_puts("def ");
2064 else
2065 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002066 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002067 msg_putchar('(');
2068 for (j = 0; j < fp->uf_args.ga_len; ++j)
2069 {
2070 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002071 msg_puts(", ");
2072 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002073 if (fp->uf_arg_types != NULL)
2074 {
2075 char *tofree;
2076
2077 msg_puts(": ");
2078 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2079 vim_free(tofree);
2080 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002081 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2082 {
2083 msg_puts(" = ");
2084 msg_puts(((char **)(fp->uf_def_args.ga_data))
2085 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2086 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002087 }
2088 if (fp->uf_varargs)
2089 {
2090 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002091 msg_puts(", ");
2092 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002093 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002094 if (fp->uf_va_name != NULL)
2095 {
2096 if (j)
2097 msg_puts(", ");
2098 msg_puts("...");
2099 msg_puts((char *)fp->uf_va_name);
2100 if (fp->uf_va_type)
2101 {
2102 char *tofree;
2103
2104 msg_puts(": ");
2105 msg_puts(type_name(fp->uf_va_type, &tofree));
2106 vim_free(tofree);
2107 }
2108 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002109 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002110
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002111 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002112 {
2113 if (fp->uf_ret_type != &t_void)
2114 {
2115 char *tofree;
2116
2117 msg_puts(": ");
2118 msg_puts(type_name(fp->uf_ret_type, &tofree));
2119 vim_free(tofree);
2120 }
2121 }
2122 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002123 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002124 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002125 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002126 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002127 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002128 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002129 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002130 msg_clr_eos();
2131 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002132 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002133}
2134
2135/*
2136 * Get a function name, translating "<SID>" and "<SNR>".
2137 * Also handles a Funcref in a List or Dictionary.
2138 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002139 * Set "*is_global" to TRUE when the function must be global, unless
2140 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141 * flags:
2142 * TFN_INT: internal function name OK
2143 * TFN_QUIET: be quiet
2144 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002145 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002146 * Advances "pp" to just after the function name (if no error).
2147 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002148 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002149trans_function_name(
2150 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002151 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002152 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002154 funcdict_T *fdp, // return: info about dictionary used
2155 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156{
2157 char_u *name = NULL;
2158 char_u *start;
2159 char_u *end;
2160 int lead;
2161 char_u sid_buf[20];
2162 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002163 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002164 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002165 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002166
2167 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002168 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002169 start = *pp;
2170
Bram Moolenaare38eab22019-12-05 21:50:01 +01002171 // Check for hard coded <SNR>: already translated function ID (from a user
2172 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002173 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2174 && (*pp)[2] == (int)KE_SNR)
2175 {
2176 *pp += 3;
2177 len = get_id_len(pp) + 3;
2178 return vim_strnsave(start, len);
2179 }
2180
Bram Moolenaare38eab22019-12-05 21:50:01 +01002181 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2182 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 lead = eval_fname_script(start);
2184 if (lead > 2)
2185 start += lead;
2186
Bram Moolenaare38eab22019-12-05 21:50:01 +01002187 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002188 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002189 lead > 2 ? 0 : FNE_CHECK_START);
2190 if (end == start)
2191 {
2192 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002193 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194 goto theend;
2195 }
2196 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2197 {
2198 /*
2199 * Report an invalid expression in braces, unless the expression
2200 * evaluation has been cancelled due to an aborting error, an
2201 * interrupt, or an exception.
2202 */
2203 if (!aborting())
2204 {
2205 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002206 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002207 }
2208 else
2209 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2210 goto theend;
2211 }
2212
2213 if (lv.ll_tv != NULL)
2214 {
2215 if (fdp != NULL)
2216 {
2217 fdp->fd_dict = lv.ll_dict;
2218 fdp->fd_newkey = lv.ll_newkey;
2219 lv.ll_newkey = NULL;
2220 fdp->fd_di = lv.ll_di;
2221 }
2222 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2223 {
2224 name = vim_strsave(lv.ll_tv->vval.v_string);
2225 *pp = end;
2226 }
2227 else if (lv.ll_tv->v_type == VAR_PARTIAL
2228 && lv.ll_tv->vval.v_partial != NULL)
2229 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002230 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 *pp = end;
2232 if (partial != NULL)
2233 *partial = lv.ll_tv->vval.v_partial;
2234 }
2235 else
2236 {
2237 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2238 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002239 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002240 else
2241 *pp = end;
2242 name = NULL;
2243 }
2244 goto theend;
2245 }
2246
2247 if (lv.ll_name == NULL)
2248 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002249 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002250 *pp = end;
2251 goto theend;
2252 }
2253
Bram Moolenaare38eab22019-12-05 21:50:01 +01002254 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002255 if (lv.ll_exp_name != NULL)
2256 {
2257 len = (int)STRLEN(lv.ll_exp_name);
2258 name = deref_func_name(lv.ll_exp_name, &len, partial,
2259 flags & TFN_NO_AUTOLOAD);
2260 if (name == lv.ll_exp_name)
2261 name = NULL;
2262 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002263 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002264 {
2265 len = (int)(end - *pp);
2266 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2267 if (name == *pp)
2268 name = NULL;
2269 }
2270 if (name != NULL)
2271 {
2272 name = vim_strsave(name);
2273 *pp = end;
2274 if (STRNCMP(name, "<SNR>", 5) == 0)
2275 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002276 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 name[0] = K_SPECIAL;
2278 name[1] = KS_EXTRA;
2279 name[2] = (int)KE_SNR;
2280 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2281 }
2282 goto theend;
2283 }
2284
2285 if (lv.ll_exp_name != NULL)
2286 {
2287 len = (int)STRLEN(lv.ll_exp_name);
2288 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2289 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2290 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002291 // When there was "s:" already or the name expanded to get a
2292 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002293 lv.ll_name += 2;
2294 len -= 2;
2295 lead = 2;
2296 }
2297 }
2298 else
2299 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002300 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002302 {
2303 if (is_global != NULL && lv.ll_name[0] == 'g')
2304 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002306 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002307 len = (int)(end - lv.ll_name);
2308 }
2309
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002310 // In Vim9 script a user function is script-local by default.
2311 vim9script = ASCII_ISUPPER(*start)
2312 && current_sctx.sc_version == SCRIPT_VERSION_VIM9;
2313
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002314 /*
2315 * Copy the function name to allocated memory.
2316 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2317 * Accept <SNR>123_name() outside a script.
2318 */
2319 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002320 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002321 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002322 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323 if (!vim9script)
2324 lead = 3;
2325 if (vim9script || (lv.ll_exp_name != NULL
2326 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 || eval_fname_sid(*pp))
2328 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002329 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002330 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002332 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 goto theend;
2334 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002335 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002336 if (vim9script)
2337 extra = 3 + (int)STRLEN(sid_buf);
2338 else
2339 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340 }
2341 }
2342 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2343 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002344 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345 start);
2346 goto theend;
2347 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002348 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 {
2350 char_u *cp = vim_strchr(lv.ll_name, ':');
2351
2352 if (cp != NULL && cp < end)
2353 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002354 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 goto theend;
2356 }
2357 }
2358
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002359 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002360 if (name != NULL)
2361 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002362 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 {
2364 name[0] = K_SPECIAL;
2365 name[1] = KS_EXTRA;
2366 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002367 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002368 STRCPY(name + 3, sid_buf);
2369 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002370 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2371 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 }
2373 *pp = end;
2374
2375theend:
2376 clear_lval(&lv);
2377 return name;
2378}
2379
2380/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002381 * Assuming "name" is the result of trans_function_name() and it was prefixed
2382 * to use the script-local name, return the unmodified name (points into
2383 * "name"). Otherwise return NULL.
2384 * This can be used to first search for a script-local function and fall back
2385 * to the global function if not found.
2386 */
2387 char_u *
2388untrans_function_name(char_u *name)
2389{
2390 char_u *p;
2391
2392 if (*name == K_SPECIAL && current_sctx.sc_version == SCRIPT_VERSION_VIM9)
2393 {
2394 p = vim_strchr(name, '_');
2395 if (p != NULL)
2396 return p + 1;
2397 }
2398 return NULL;
2399}
2400
2401/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002402 * List functions. When "regmatch" is NULL all of then.
2403 * Otherwise functions matching "regmatch".
2404 */
2405 static void
2406list_functions(regmatch_T *regmatch)
2407{
2408 long_u used = func_hashtab.ht_used;
2409 long_u todo = used;
2410 hashitem_T *ht_array = func_hashtab.ht_array;
2411 hashitem_T *hi;
2412
2413 for (hi = ht_array; todo > 0 && !got_int; ++hi)
2414 {
2415 if (!HASHITEM_EMPTY(hi))
2416 {
2417 ufunc_T *fp = HI2UF(hi);
2418
2419 --todo;
2420 if ((fp->uf_flags & FC_DEAD) == 0
2421 && (regmatch == NULL
2422 ? !message_filtered(fp->uf_name)
2423 && !func_name_refcount(fp->uf_name)
2424 : !isdigit(*fp->uf_name)
2425 && vim_regexec(regmatch, fp->uf_name, 0)))
2426 {
2427 list_func_head(fp, FALSE);
2428 if (used != func_hashtab.ht_used
2429 || ht_array != func_hashtab.ht_array)
2430 {
2431 emsg(_("E454: function list was modified"));
2432 return;
2433 }
2434 }
2435 }
2436 }
2437}
2438
2439/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002440 * ":function" also supporting nested ":def".
2441 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002443 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002444def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445{
2446 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002447 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 int j;
2449 int c;
2450 int saved_did_emsg;
2451 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002452 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002453 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 char_u *p;
2455 char_u *arg;
2456 char_u *line_arg = NULL;
2457 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002458 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002459 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460 garray_T newlines;
2461 int varargs = FALSE;
2462 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002463 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002464 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002465 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 int indent;
2467 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002468#define MAX_FUNC_NESTING 50
2469 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 dictitem_T *v;
2471 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002472 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002475 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002476 linenr_T sourcing_lnum_off;
2477 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002478 int is_heredoc = FALSE;
2479 char_u *skip_until = NULL;
2480 char_u *heredoc_trimmed = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481
Bram Moolenaar822ba242020-05-24 23:00:18 +02002482 if (in_vim9script() && eap->forceit)
2483 {
2484 emsg(_(e_nobang));
2485 return NULL;
2486 }
2487
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002488 /*
2489 * ":function" without argument: list functions.
2490 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002491 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492 {
2493 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002494 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002496 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 }
2498
2499 /*
2500 * ":function /pat": list functions matching pattern.
2501 */
2502 if (*eap->arg == '/')
2503 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002504 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 if (!eap->skip)
2506 {
2507 regmatch_T regmatch;
2508
2509 c = *p;
2510 *p = NUL;
2511 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2512 *p = c;
2513 if (regmatch.regprog != NULL)
2514 {
2515 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002516 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002517 vim_regfree(regmatch.regprog);
2518 }
2519 }
2520 if (*p == '/')
2521 ++p;
2522 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002523 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 }
2525
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002526 ga_init(&newargs);
2527 ga_init(&argtypes);
2528 ga_init(&default_args);
2529
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 /*
2531 * Get the function name. There are these situations:
2532 * func normal function name
2533 * "name" == func, "fudi.fd_dict" == NULL
2534 * dict.func new dictionary entry
2535 * "name" == NULL, "fudi.fd_dict" set,
2536 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2537 * dict.func existing dict entry with a Funcref
2538 * "name" == func, "fudi.fd_dict" set,
2539 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2540 * dict.func existing dict entry that's not a Funcref
2541 * "name" == NULL, "fudi.fd_dict" set,
2542 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2543 * s:func script-local function name
2544 * g:func global function name, same as "func"
2545 */
2546 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002547 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002549 // nested function, argument is (args).
2550 paren = TRUE;
2551 CLEAR_FIELD(fudi);
2552 }
2553 else
2554 {
2555 name = trans_function_name(&p, &is_global, eap->skip,
2556 TFN_NO_AUTOLOAD, &fudi, NULL);
2557 paren = (vim_strchr(p, '(') != NULL);
2558 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002560 /*
2561 * Return on an invalid expression in braces, unless the expression
2562 * evaluation has been cancelled due to an aborting error, an
2563 * interrupt, or an exception.
2564 */
2565 if (!aborting())
2566 {
2567 if (!eap->skip && fudi.fd_newkey != NULL)
2568 semsg(_(e_dictkey), fudi.fd_newkey);
2569 vim_free(fudi.fd_newkey);
2570 return NULL;
2571 }
2572 else
2573 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 }
2576
Bram Moolenaare38eab22019-12-05 21:50:01 +01002577 // An error in a function call during evaluation of an expression in magic
2578 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002579 saved_did_emsg = did_emsg;
2580 did_emsg = FALSE;
2581
2582 /*
2583 * ":function func" with only function name: list function.
2584 */
2585 if (!paren)
2586 {
2587 if (!ends_excmd(*skipwhite(p)))
2588 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002589 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590 goto ret_free;
2591 }
2592 eap->nextcmd = check_nextcmd(p);
2593 if (eap->nextcmd != NULL)
2594 *p = NUL;
2595 if (!eap->skip && !got_int)
2596 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002597 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002598 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2599 {
2600 char_u *up = untrans_function_name(name);
2601
2602 // With Vim9 script the name was made script-local, if not
2603 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002604 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002605 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002606 }
2607
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 if (fp != NULL)
2609 {
2610 list_func_head(fp, TRUE);
2611 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2612 {
2613 if (FUNCLINE(fp, j) == NULL)
2614 continue;
2615 msg_putchar('\n');
2616 msg_outnum((long)(j + 1));
2617 if (j < 9)
2618 msg_putchar(' ');
2619 if (j < 99)
2620 msg_putchar(' ');
2621 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002622 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 ui_breakcheck();
2624 }
2625 if (!got_int)
2626 {
2627 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002628 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002629 msg_puts(" enddef");
2630 else
2631 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 }
2633 }
2634 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002635 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 }
2637 goto ret_free;
2638 }
2639
2640 /*
2641 * ":function name(arg1, arg2)" Define function.
2642 */
2643 p = skipwhite(p);
2644 if (*p != '(')
2645 {
2646 if (!eap->skip)
2647 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002648 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 goto ret_free;
2650 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002651 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 if (vim_strchr(p, '(') != NULL)
2653 p = vim_strchr(p, '(');
2654 }
2655 p = skipwhite(p + 1);
2656
2657 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2658
Bram Moolenaar04b12692020-05-04 23:24:44 +02002659 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002661 // Check the name of the function. Unless it's a dictionary function
2662 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 if (name != NULL)
2664 arg = name;
2665 else
2666 arg = fudi.fd_newkey;
2667 if (arg != NULL && (fudi.fd_di == NULL
2668 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2669 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2670 {
2671 if (*arg == K_SPECIAL)
2672 j = 3;
2673 else
2674 j = 0;
2675 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2676 : eval_isnamec(arg[j])))
2677 ++j;
2678 if (arg[j] != NUL)
2679 emsg_funcname((char *)e_invarg2, arg);
2680 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002681 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002683 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684 }
2685
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002686 // This may get more lines and make the pointers into the first line
2687 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002688 if (get_function_args(&p, ')', &newargs,
2689 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002690 &varargs, &default_args, eap->skip,
2691 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692 goto errret_2;
2693
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002694 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002696 // find the return type: :def Func(): type
2697 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002699 ret_type = skipwhite(p + 1);
2700 p = skip_type(ret_type);
2701 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002702 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002703 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002704 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002705 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002706 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002707 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002708 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002709 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002710 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002713 else
2714 // find extra arguments "range", "dict", "abort" and "closure"
2715 for (;;)
2716 {
2717 p = skipwhite(p);
2718 if (STRNCMP(p, "range", 5) == 0)
2719 {
2720 flags |= FC_RANGE;
2721 p += 5;
2722 }
2723 else if (STRNCMP(p, "dict", 4) == 0)
2724 {
2725 flags |= FC_DICT;
2726 p += 4;
2727 }
2728 else if (STRNCMP(p, "abort", 5) == 0)
2729 {
2730 flags |= FC_ABORT;
2731 p += 5;
2732 }
2733 else if (STRNCMP(p, "closure", 7) == 0)
2734 {
2735 flags |= FC_CLOSURE;
2736 p += 7;
2737 if (current_funccal == NULL)
2738 {
2739 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2740 name == NULL ? (char_u *)"" : name);
2741 goto erret;
2742 }
2743 }
2744 else
2745 break;
2746 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747
Bram Moolenaare38eab22019-12-05 21:50:01 +01002748 // When there is a line break use what follows for the function body.
2749 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 if (*p == '\n')
2751 line_arg = p + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +02002752 else if (*p != NUL && *p != '"' && !(eap->cmdidx == CMD_def && *p == '#')
2753 && !eap->skip && !did_emsg)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002754 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755
2756 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002757 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2758 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002759 */
2760 if (KeyTyped)
2761 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002762 // Check if the function already exists, don't let the user type the
2763 // whole function before telling him it doesn't work! For a script we
2764 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 if (!eap->skip && !eap->forceit)
2766 {
2767 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002768 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002769 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 emsg_funcname(e_funcexts, name);
2771 }
2772
2773 if (!eap->skip && did_emsg)
2774 goto erret;
2775
Bram Moolenaare38eab22019-12-05 21:50:01 +01002776 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 cmdline_row = msg_row;
2778 }
2779
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002780 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002781 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002782
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 indent = 2;
2784 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002785 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 for (;;)
2787 {
2788 if (KeyTyped)
2789 {
2790 msg_scroll = TRUE;
2791 saved_wait_return = FALSE;
2792 }
2793 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794
2795 if (line_arg != NULL)
2796 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002797 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 theline = line_arg;
2799 p = vim_strchr(theline, '\n');
2800 if (p == NULL)
2801 line_arg += STRLEN(line_arg);
2802 else
2803 {
2804 *p = NUL;
2805 line_arg = p + 1;
2806 }
2807 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02002809 {
2810 vim_free(line_to_free);
2811 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02002812 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002813 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02002814 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002815 line_to_free = theline;
2816 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 if (KeyTyped)
2818 lines_left = Rows - 1;
2819 if (theline == NULL)
2820 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002821 if (eap->cmdidx == CMD_def)
2822 emsg(_("E1057: Missing :enddef"));
2823 else
2824 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 goto erret;
2826 }
2827
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002828 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002829 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002830 if (SOURCING_LNUM < sourcing_lnum_off)
2831 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 else
2833 sourcing_lnum_off = 0;
2834
2835 if (skip_until != NULL)
2836 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002837 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002838 // * ":append" and "."
2839 // * ":python <<EOF" and "EOF"
2840 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
2841 if (heredoc_trimmed == NULL
2842 || (is_heredoc && skipwhite(theline) == theline)
2843 || STRNCMP(theline, heredoc_trimmed,
2844 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002845 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002846 if (heredoc_trimmed == NULL)
2847 p = theline;
2848 else if (is_heredoc)
2849 p = skipwhite(theline) == theline
2850 ? theline : theline + STRLEN(heredoc_trimmed);
2851 else
2852 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02002853 if (STRCMP(p, skip_until) == 0)
2854 {
2855 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002856 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02002857 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002858 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002859 }
2860 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 }
2862 else
2863 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002864 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01002865 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 ;
2867
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002868 // Check for "endfunction" or "enddef".
2869 if (checkforcmd(&p, nesting_def[nesting]
2870 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02002872 char_u *nextcmd = NULL;
2873
Bram Moolenaar663bb232017-06-22 19:12:10 +02002874 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02002875 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002876 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02002877 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002878 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002879 give_warning2(eap->cmdidx == CMD_def
2880 ? (char_u *)_("W1001: Text found after :enddef: %s")
2881 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02002882 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002883 if (nextcmd != NULL)
2884 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002885 // Another command follows. If the line came from "eap" we
2886 // can simply point into it, otherwise we need to change
2887 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02002888 eap->nextcmd = nextcmd;
2889 if (line_to_free != NULL)
2890 {
2891 vim_free(*eap->cmdlinep);
2892 *eap->cmdlinep = line_to_free;
2893 line_to_free = NULL;
2894 }
2895 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 break;
2897 }
2898
Bram Moolenaare38eab22019-12-05 21:50:01 +01002899 // Increase indent inside "if", "while", "for" and "try", decrease
2900 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 indent -= 2;
2903 else if (STRNCMP(p, "if", 2) == 0
2904 || STRNCMP(p, "wh", 2) == 0
2905 || STRNCMP(p, "for", 3) == 0
2906 || STRNCMP(p, "try", 3) == 0)
2907 indent += 2;
2908
Bram Moolenaare38eab22019-12-05 21:50:01 +01002909 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01002910 // Only recognize "def" inside "def", not inside "function",
2911 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002912 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01002913 if (checkforcmd(&p, "function", 2)
2914 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 {
2916 if (*p == '!')
2917 p = skipwhite(p + 1);
2918 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002919 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 if (*skipwhite(p) == '(')
2921 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002922 if (nesting == MAX_FUNC_NESTING - 1)
2923 emsg(_("E1058: function nesting too deep"));
2924 else
2925 {
2926 ++nesting;
2927 nesting_def[nesting] = (c == 'd');
2928 indent += 2;
2929 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930 }
2931 }
2932
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002933 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002934 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002935 if (eap->cmdidx != CMD_def
2936 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01002937 || (p[0] == 'c'
2938 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
2939 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
2940 && (STRNCMP(&p[3], "nge", 3) != 0
2941 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942 || (p[0] == 'i'
2943 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002944 && (!ASCII_ISALPHA(p[2])
2945 || (p[2] == 's'
2946 && (!ASCII_ISALPHA(p[3])
2947 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002948 skip_until = vim_strsave((char_u *)".");
2949
Bram Moolenaare38eab22019-12-05 21:50:01 +01002950 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 arg = skipwhite(skiptowhite(p));
2952 if (arg[0] == '<' && arg[1] =='<'
2953 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01002954 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
2955 || ((p[2] == '3' || p[2] == 'x')
2956 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002957 || (p[0] == 'p' && p[1] == 'e'
2958 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
2959 || (p[0] == 't' && p[1] == 'c'
2960 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
2961 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
2962 && !ASCII_ISALPHA(p[3]))
2963 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
2964 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
2965 || (p[0] == 'm' && p[1] == 'z'
2966 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
2967 ))
2968 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002969 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02002971 if (STRNCMP(p, "trim", 4) == 0)
2972 {
2973 // Ignore leading white space.
2974 p = skipwhite(p + 4);
2975 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002976 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02002977 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 if (*p == NUL)
2979 skip_until = vim_strsave((char_u *)".");
2980 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002981 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02002982 do_concat = FALSE;
2983 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02002985
2986 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002987 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02002988 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002989 if (*arg == '[')
2990 arg = vim_strchr(arg, ']');
2991 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002992 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002993 arg = skipwhite(skiptowhite(arg));
2994 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
2995 && ((p[0] == 'l'
2996 && p[1] == 'e'
2997 && (!ASCII_ISALNUM(p[2])
2998 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02002999 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003000 p = skipwhite(arg + 3);
3001 if (STRNCMP(p, "trim", 4) == 0)
3002 {
3003 // Ignore leading white space.
3004 p = skipwhite(p + 4);
3005 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003006 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003007 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003008 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003009 do_concat = FALSE;
3010 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003011 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003012 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013 }
3014
Bram Moolenaare38eab22019-12-05 21:50:01 +01003015 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018
Bram Moolenaare38eab22019-12-05 21:50:01 +01003019 // Copy the line to newly allocated memory. get_one_sourceline()
3020 // allocates 250 bytes per line, this saves 80% on average. The cost
3021 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003023 if (p == NULL)
3024 goto erret;
3025 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026
Bram Moolenaare38eab22019-12-05 21:50:01 +01003027 // Add NULL lines for continuation lines, so that the line count is
3028 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 while (sourcing_lnum_off-- > 0)
3030 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3031
Bram Moolenaare38eab22019-12-05 21:50:01 +01003032 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 if (line_arg != NULL && *line_arg == NUL)
3034 line_arg = NULL;
3035 }
3036
Bram Moolenaare38eab22019-12-05 21:50:01 +01003037 // Don't define the function when skipping commands or when an error was
3038 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 if (eap->skip || did_emsg)
3040 goto erret;
3041
3042 /*
3043 * If there are no errors, add the function
3044 */
3045 if (fudi.fd_dict == NULL)
3046 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003047 hashtab_T *ht;
3048
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 v = find_var(name, &ht, FALSE);
3050 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3051 {
3052 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3053 name);
3054 goto erret;
3055 }
3056
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003057 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003058 if (fp != NULL)
3059 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003060 int dead = fp->uf_flags & FC_DEAD;
3061
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003062 // Function can be replaced with "function!" and when sourcing the
3063 // same script again, but only once.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003064 if (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003065 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
3066 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003067 {
3068 emsg_funcname(e_funcexts, name);
3069 goto erret;
3070 }
3071 if (fp->uf_calls > 0)
3072 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003073 emsg_funcname(
3074 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003075 name);
3076 goto erret;
3077 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003078 if (fp->uf_refcount > 1)
3079 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003080 // This function is referenced somewhere, don't redefine it but
3081 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003082 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003083 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003084 fp = NULL;
3085 overwrite = TRUE;
3086 }
3087 else
3088 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003089 char_u *exp_name = fp->uf_name_exp;
3090
3091 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003092 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003093 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003094 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003095 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003096 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003097#ifdef FEAT_PROFILE
3098 fp->uf_profiling = FALSE;
3099 fp->uf_prof_initialized = FALSE;
3100#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003101 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003102 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 }
3104 }
3105 else
3106 {
3107 char numbuf[20];
3108
3109 fp = NULL;
3110 if (fudi.fd_newkey == NULL && !eap->forceit)
3111 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003112 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 goto erret;
3114 }
3115 if (fudi.fd_di == NULL)
3116 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003117 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003118 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 goto erret;
3120 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003121 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003122 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 goto erret;
3124
Bram Moolenaare38eab22019-12-05 21:50:01 +01003125 // Give the function a sequential number. Can only be used with a
3126 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 vim_free(name);
3128 sprintf(numbuf, "%d", ++func_nr);
3129 name = vim_strsave((char_u *)numbuf);
3130 if (name == NULL)
3131 goto erret;
3132 }
3133
3134 if (fp == NULL)
3135 {
3136 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3137 {
3138 int slen, plen;
3139 char_u *scriptname;
3140
Bram Moolenaare38eab22019-12-05 21:50:01 +01003141 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003143 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 {
3145 scriptname = autoload_name(name);
3146 if (scriptname != NULL)
3147 {
3148 p = vim_strchr(scriptname, '/');
3149 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003150 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003152 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003153 j = OK;
3154 vim_free(scriptname);
3155 }
3156 }
3157 if (j == FAIL)
3158 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003159 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 goto erret;
3161 }
3162 }
3163
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003164 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 if (fp == NULL)
3166 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003167 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003168 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003169
3170 if (fudi.fd_dict != NULL)
3171 {
3172 if (fudi.fd_di == NULL)
3173 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003174 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3176 if (fudi.fd_di == NULL)
3177 {
3178 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003179 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 goto erret;
3181 }
3182 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3183 {
3184 vim_free(fudi.fd_di);
3185 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003186 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003187 goto erret;
3188 }
3189 }
3190 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003191 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192 clear_tv(&fudi.fd_di->di_tv);
3193 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195
Bram Moolenaare38eab22019-12-05 21:50:01 +01003196 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003197 flags |= FC_DICT;
3198 }
3199
Bram Moolenaare38eab22019-12-05 21:50:01 +01003200 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003201 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003202 if (overwrite)
3203 {
3204 hi = hash_find(&func_hashtab, name);
3205 hi->hi_key = UF2HIKEY(fp);
3206 }
3207 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208 {
3209 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003210 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 goto erret;
3212 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003213 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 }
3215 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003216 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003217 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003218 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003219
3220 if (eap->cmdidx == CMD_def)
3221 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003222 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003223
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003224 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003225
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003226 // error messages are for the first function line
3227 SOURCING_LNUM = sourcing_lnum_top;
3228
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003229 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003230 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003231
3232 if (argtypes.ga_len > 0)
3233 {
3234 // When "varargs" is set the last name/type goes into uf_va_name
3235 // and uf_va_type.
3236 int len = argtypes.ga_len - (varargs ? 1 : 0);
3237
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003238 if (len > 0)
3239 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003240 if (fp->uf_arg_types != NULL)
3241 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003242 int i;
3243 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003244
3245 for (i = 0; i < len; ++ i)
3246 {
3247 p = ((char_u **)argtypes.ga_data)[i];
3248 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003249 // will get the type from the default value
3250 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003252 type = parse_type(&p, &fp->uf_type_list);
3253 if (type == NULL)
3254 {
3255 SOURCING_LNUM = lnum_save;
3256 goto errret_2;
3257 }
3258 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003259 }
3260 }
3261 if (varargs)
3262 {
3263 // Move the last argument "...name: type" to uf_va_name and
3264 // uf_va_type.
3265 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3266 [fp->uf_args.ga_len - 1];
3267 --fp->uf_args.ga_len;
3268 p = ((char_u **)argtypes.ga_data)[len];
3269 if (p == NULL)
3270 // todo: get type from default value
3271 fp->uf_va_type = &t_any;
3272 else
3273 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003274 if (fp->uf_va_type == NULL)
3275 {
3276 SOURCING_LNUM = lnum_save;
3277 goto errret_2;
3278 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 }
3280 varargs = FALSE;
3281 }
3282
3283 // parse the return type, if any
3284 if (ret_type == NULL)
3285 fp->uf_ret_type = &t_void;
3286 else
3287 {
3288 p = ret_type;
3289 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3290 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003291 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003292 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003293 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003294 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003295
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003297 if ((flags & FC_CLOSURE) != 0)
3298 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003299 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003300 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003301 }
3302 else
3303 fp->uf_scoped = NULL;
3304
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003305#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 if (prof_def_func())
3307 func_do_profile(fp);
3308#endif
3309 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003310 if (sandbox)
3311 flags |= FC_SANDBOX;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003312 if (in_vim9script() && !ASCII_ISUPPER(*fp->uf_name))
3313 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314 fp->uf_flags = flags;
3315 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003316 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003317 fp->uf_script_ctx = current_sctx;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003318 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003319 if (is_export)
3320 {
3321 fp->uf_flags |= FC_EXPORT;
3322 // let ex_export() know the export worked.
3323 is_export = FALSE;
3324 }
3325
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003326 if (eap->cmdidx == CMD_def)
3327 set_function_type(fp);
3328
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329 goto ret_free;
3330
3331erret:
3332 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003333 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334errret_2:
3335 ga_clear_strings(&newlines);
3336ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003337 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003339 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003341 if (name != name_arg)
3342 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003343 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 did_emsg |= saved_did_emsg;
3345 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003346
3347 return fp;
3348}
3349
3350/*
3351 * ":function"
3352 */
3353 void
3354ex_function(exarg_T *eap)
3355{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003356 (void)def_function(eap, NULL);
3357}
3358
3359/*
3360 * :defcompile - compile all :def functions in the current script.
3361 */
3362 void
3363ex_defcompile(exarg_T *eap UNUSED)
3364{
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003365 long_u ht_used = func_hashtab.ht_used;
3366 int todo = (int)ht_used;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003367 hashitem_T *hi;
3368 ufunc_T *ufunc;
3369
3370 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3371 {
3372 if (!HASHITEM_EMPTY(hi))
3373 {
3374 --todo;
3375 ufunc = HI2UF(hi);
3376 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003377 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003378 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003379 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003380
3381 if (func_hashtab.ht_used != ht_used)
3382 {
3383 // another function has been defined, need to start over
3384 hi = func_hashtab.ht_array;
3385 ht_used = func_hashtab.ht_used;
3386 todo = (int)ht_used;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003387 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003388 }
3389 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003390 }
3391 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392}
3393
3394/*
3395 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3396 * Return 2 if "p" starts with "s:".
3397 * Return 0 otherwise.
3398 */
3399 int
3400eval_fname_script(char_u *p)
3401{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003402 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3403 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3405 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3406 return 5;
3407 if (p[0] == 's' && p[1] == ':')
3408 return 2;
3409 return 0;
3410}
3411
3412 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003413translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414{
3415 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003416 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003417 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418}
3419
3420/*
3421 * Return TRUE when "ufunc" has old-style "..." varargs
3422 * or named varargs "...name: type".
3423 */
3424 int
3425has_varargs(ufunc_T *ufunc)
3426{
3427 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428}
3429
3430/*
3431 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003432 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 */
3434 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003435function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436{
3437 char_u *nm = name;
3438 char_u *p;
3439 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003440 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003441 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003443 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3444 if (no_deref)
3445 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003446 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 nm = skipwhite(nm);
3448
Bram Moolenaare38eab22019-12-05 21:50:01 +01003449 // Only accept "funcname", "funcname ", "funcname (..." and
3450 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003451 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003452 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 vim_free(p);
3454 return n;
3455}
3456
Bram Moolenaar113e1072019-01-20 15:30:40 +01003457#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 char_u *
3459get_expanded_name(char_u *name, int check)
3460{
3461 char_u *nm = name;
3462 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003463 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003464
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003465 p = trans_function_name(&nm, &is_global, FALSE,
3466 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003468 if (p != NULL && *nm == NUL
3469 && (!check || translated_function_exists(p, is_global)))
3470 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471
3472 vim_free(p);
3473 return NULL;
3474}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003475#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477/*
3478 * Function given to ExpandGeneric() to obtain the list of user defined
3479 * function names.
3480 */
3481 char_u *
3482get_user_func_name(expand_T *xp, int idx)
3483{
3484 static long_u done;
3485 static hashitem_T *hi;
3486 ufunc_T *fp;
3487
3488 if (idx == 0)
3489 {
3490 done = 0;
3491 hi = func_hashtab.ht_array;
3492 }
3493 if (done < func_hashtab.ht_used)
3494 {
3495 if (done++ > 0)
3496 ++hi;
3497 while (HASHITEM_EMPTY(hi))
3498 ++hi;
3499 fp = HI2UF(hi);
3500
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003501 // don't show dead, dict and lambda functions
3502 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003503 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003504 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505
3506 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003507 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508
3509 cat_func_name(IObuff, fp);
3510 if (xp->xp_context != EXPAND_USER_FUNC)
3511 {
3512 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 STRCAT(IObuff, ")");
3515 }
3516 return IObuff;
3517 }
3518 return NULL;
3519}
3520
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003521/*
3522 * ":delfunction {name}"
3523 */
3524 void
3525ex_delfunction(exarg_T *eap)
3526{
3527 ufunc_T *fp = NULL;
3528 char_u *p;
3529 char_u *name;
3530 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003531 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532
3533 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003534 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 vim_free(fudi.fd_newkey);
3536 if (name == NULL)
3537 {
3538 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003539 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540 return;
3541 }
3542 if (!ends_excmd(*skipwhite(p)))
3543 {
3544 vim_free(name);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003545 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 return;
3547 }
3548 eap->nextcmd = check_nextcmd(p);
3549 if (eap->nextcmd != NULL)
3550 *p = NUL;
3551
3552 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003553 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 vim_free(name);
3555
3556 if (!eap->skip)
3557 {
3558 if (fp == NULL)
3559 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003560 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003561 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003562 return;
3563 }
3564 if (fp->uf_calls > 0)
3565 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003566 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 return;
3568 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003569 if (fp->uf_flags & FC_VIM9)
3570 {
3571 semsg(_("E1084: Cannot delete Vim9 script function %s"), eap->arg);
3572 return;
3573 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003574
3575 if (fudi.fd_dict != NULL)
3576 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003577 // Delete the dict item that refers to the function, it will
3578 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3580 }
3581 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003582 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003583 // A normal function (not a numbered function or lambda) has a
3584 // refcount of 1 for the entry in the hashtable. When deleting
3585 // it and the refcount is more than one, it should be kept.
3586 // A numbered function and lambda should be kept if the refcount is
3587 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003588 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003589 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003590 // Function is still referenced somewhere. Don't free it but
3591 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003592 if (func_remove(fp))
3593 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003594 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003595 }
3596 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003597 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003598 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 }
3600}
3601
3602/*
3603 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003604 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 */
3606 void
3607func_unref(char_u *name)
3608{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003609 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003610
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003611 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003613 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003614 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003615 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003617 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003619 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003621 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003623 // Only delete it when it's not being used. Otherwise it's done
3624 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003625 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003626 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003627 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003628}
3629
3630/*
3631 * Unreference a Function: decrement the reference count and free it when it
3632 * becomes zero.
3633 */
3634 void
3635func_ptr_unref(ufunc_T *fp)
3636{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003637 if (fp != NULL && --fp->uf_refcount <= 0)
3638 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // Only delete it when it's not being used. Otherwise it's done
3640 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003641 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003642 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643 }
3644}
3645
3646/*
3647 * Count a reference to a Function.
3648 */
3649 void
3650func_ref(char_u *name)
3651{
3652 ufunc_T *fp;
3653
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003654 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003656 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003657 if (fp != NULL)
3658 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003660 // Only give an error for a numbered function.
3661 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003662 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003663}
3664
3665/*
3666 * Count a reference to a Function.
3667 */
3668 void
3669func_ptr_ref(ufunc_T *fp)
3670{
3671 if (fp != NULL)
3672 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673}
3674
3675/*
3676 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3677 * referenced from anywhere that is in use.
3678 */
3679 static int
3680can_free_funccal(funccall_T *fc, int copyID)
3681{
3682 return (fc->l_varlist.lv_copyID != copyID
3683 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003684 && fc->l_avars.dv_copyID != copyID
3685 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686}
3687
3688/*
3689 * ":return [expr]"
3690 */
3691 void
3692ex_return(exarg_T *eap)
3693{
3694 char_u *arg = eap->arg;
3695 typval_T rettv;
3696 int returning = FALSE;
3697
3698 if (current_funccal == NULL)
3699 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003700 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 return;
3702 }
3703
3704 if (eap->skip)
3705 ++emsg_skip;
3706
3707 eap->nextcmd = NULL;
3708 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaar32e35112020-05-14 22:41:15 +02003709 && eval0(arg, &rettv, &eap->nextcmd, eap->skip ? 0 : EVAL_EVALUATE)
3710 != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711 {
3712 if (!eap->skip)
3713 returning = do_return(eap, FALSE, TRUE, &rettv);
3714 else
3715 clear_tv(&rettv);
3716 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003717 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718 else if (!eap->skip)
3719 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003720 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003721 update_force_abort();
3722
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 /*
3724 * Return unless the expression evaluation has been cancelled due to an
3725 * aborting error, an interrupt, or an exception.
3726 */
3727 if (!aborting())
3728 returning = do_return(eap, FALSE, TRUE, NULL);
3729 }
3730
Bram Moolenaare38eab22019-12-05 21:50:01 +01003731 // When skipping or the return gets pending, advance to the next command
3732 // in this line (!returning). Otherwise, ignore the rest of the line.
3733 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 if (returning)
3735 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003736 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 eap->nextcmd = check_nextcmd(arg);
3738
3739 if (eap->skip)
3740 --emsg_skip;
3741}
3742
3743/*
3744 * ":1,25call func(arg1, arg2)" function call.
3745 */
3746 void
3747ex_call(exarg_T *eap)
3748{
3749 char_u *arg = eap->arg;
3750 char_u *startarg;
3751 char_u *name;
3752 char_u *tofree;
3753 int len;
3754 typval_T rettv;
3755 linenr_T lnum;
3756 int doesrange;
3757 int failed = FALSE;
3758 funcdict_T fudi;
3759 partial_T *partial = NULL;
3760
3761 if (eap->skip)
3762 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003763 // trans_function_name() doesn't work well when skipping, use eval0()
3764 // instead to skip to any following command, e.g. for:
3765 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 ++emsg_skip;
Bram Moolenaar32e35112020-05-14 22:41:15 +02003767 if (eval0(eap->arg, &rettv, &eap->nextcmd, 0) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768 clear_tv(&rettv);
3769 --emsg_skip;
3770 return;
3771 }
3772
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003773 tofree = trans_function_name(&arg, NULL, eap->skip,
3774 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775 if (fudi.fd_newkey != NULL)
3776 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003777 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003778 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779 vim_free(fudi.fd_newkey);
3780 }
3781 if (tofree == NULL)
3782 return;
3783
Bram Moolenaare38eab22019-12-05 21:50:01 +01003784 // Increase refcount on dictionary, it could get deleted when evaluating
3785 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 if (fudi.fd_dict != NULL)
3787 ++fudi.fd_dict->dv_refcount;
3788
Bram Moolenaare38eab22019-12-05 21:50:01 +01003789 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
3790 // contents. For VAR_PARTIAL get its partial, unless we already have one
3791 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 len = (int)STRLEN(tofree);
3793 name = deref_func_name(tofree, &len,
3794 partial != NULL ? NULL : &partial, FALSE);
3795
Bram Moolenaare38eab22019-12-05 21:50:01 +01003796 // Skip white space to allow ":call func ()". Not good, but required for
3797 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003799 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800
3801 if (*startarg != '(')
3802 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003803 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 goto end;
3805 }
3806
3807 /*
3808 * When skipping, evaluate the function once, to find the end of the
3809 * arguments.
3810 * When the function takes a range, this is discovered after the first
3811 * call, and the loop is broken.
3812 */
3813 if (eap->skip)
3814 {
3815 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003816 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 }
3818 else
3819 lnum = eap->line1;
3820 for ( ; lnum <= eap->line2; ++lnum)
3821 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003822 funcexe_T funcexe;
3823
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 if (!eap->skip && eap->addr_count > 0)
3825 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003826 if (lnum > curbuf->b_ml.ml_line_count)
3827 {
3828 // If the function deleted lines or switched to another buffer
3829 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003830 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003831 break;
3832 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 curwin->w_cursor.lnum = lnum;
3834 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 }
3837 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003838
Bram Moolenaara80faa82020-04-12 19:37:17 +02003839 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003840 funcexe.firstline = eap->line1;
3841 funcexe.lastline = eap->line2;
3842 funcexe.doesrange = &doesrange;
3843 funcexe.evaluate = !eap->skip;
3844 funcexe.partial = partial;
3845 funcexe.selfdict = fudi.fd_dict;
3846 if (get_func_tv(name, -1, &rettv, &arg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 {
3848 failed = TRUE;
3849 break;
3850 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003851 if (has_watchexpr())
3852 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02003854 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32e35112020-05-14 22:41:15 +02003855 if (handle_subscript(&arg, &rettv, eap->skip ? 0 : EVAL_EVALUATE,
3856 TRUE, name, &name) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 {
3858 failed = TRUE;
3859 break;
3860 }
3861
3862 clear_tv(&rettv);
3863 if (doesrange || eap->skip)
3864 break;
3865
Bram Moolenaare38eab22019-12-05 21:50:01 +01003866 // Stop when immediately aborting on error, or when an interrupt
3867 // occurred or an exception was thrown but not caught.
3868 // get_func_tv() returned OK, so that the check for trailing
3869 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 if (aborting())
3871 break;
3872 }
3873 if (eap->skip)
3874 --emsg_skip;
3875
Bram Moolenaare51bb172020-02-16 19:42:23 +01003876 // When inside :try we need to check for following "| catch".
3877 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003879 // Check for trailing illegal characters and a following command.
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003880 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01003882 if (!failed)
3883 {
3884 emsg_severe = TRUE;
3885 emsg(_(e_trailing));
3886 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 }
3888 else
3889 eap->nextcmd = check_nextcmd(arg);
3890 }
3891
3892end:
3893 dict_unref(fudi.fd_dict);
3894 vim_free(tofree);
3895}
3896
3897/*
3898 * Return from a function. Possibly makes the return pending. Also called
3899 * for a pending return at the ":endtry" or after returning from an extra
3900 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
3901 * when called due to a ":return" command. "rettv" may point to a typval_T
3902 * with the return rettv. Returns TRUE when the return can be carried out,
3903 * FALSE when the return gets pending.
3904 */
3905 int
3906do_return(
3907 exarg_T *eap,
3908 int reanimate,
3909 int is_cmd,
3910 void *rettv)
3911{
3912 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01003913 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914
3915 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003916 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 current_funccal->returned = FALSE;
3918
3919 /*
3920 * Cleanup (and inactivate) conditionals, but stop when a try conditional
3921 * not in its finally clause (which then is to be executed next) is found.
3922 * In this case, make the ":return" pending for execution at the ":endtry".
3923 * Otherwise, return normally.
3924 */
3925 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
3926 if (idx >= 0)
3927 {
3928 cstack->cs_pending[idx] = CSTP_RETURN;
3929
3930 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003931 // A pending return again gets pending. "rettv" points to an
3932 // allocated variable with the rettv of the original ":return"'s
3933 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 cstack->cs_rettv[idx] = rettv;
3935 else
3936 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003937 // When undoing a return in order to make it pending, get the stored
3938 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 if (reanimate)
3940 rettv = current_funccal->rettv;
3941
3942 if (rettv != NULL)
3943 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003944 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
3946 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
3947 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003948 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 }
3950 else
3951 cstack->cs_rettv[idx] = NULL;
3952
3953 if (reanimate)
3954 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003955 // The pending return value could be overwritten by a ":return"
3956 // without argument in a finally clause; reset the default
3957 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 current_funccal->rettv->v_type = VAR_NUMBER;
3959 current_funccal->rettv->vval.v_number = 0;
3960 }
3961 }
3962 report_make_pending(CSTP_RETURN, rettv);
3963 }
3964 else
3965 {
3966 current_funccal->returned = TRUE;
3967
Bram Moolenaare38eab22019-12-05 21:50:01 +01003968 // If the return is carried out now, store the return value. For
3969 // a return immediately after reanimation, the value is already
3970 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 if (!reanimate && rettv != NULL)
3972 {
3973 clear_tv(current_funccal->rettv);
3974 *current_funccal->rettv = *(typval_T *)rettv;
3975 if (!is_cmd)
3976 vim_free(rettv);
3977 }
3978 }
3979
3980 return idx < 0;
3981}
3982
3983/*
3984 * Free the variable with a pending return value.
3985 */
3986 void
3987discard_pending_return(void *rettv)
3988{
3989 free_tv((typval_T *)rettv);
3990}
3991
3992/*
3993 * Generate a return command for producing the value of "rettv". The result
3994 * is an allocated string. Used by report_pending() for verbose messages.
3995 */
3996 char_u *
3997get_return_cmd(void *rettv)
3998{
3999 char_u *s = NULL;
4000 char_u *tofree = NULL;
4001 char_u numbuf[NUMBUFLEN];
4002
4003 if (rettv != NULL)
4004 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4005 if (s == NULL)
4006 s = (char_u *)"";
4007
4008 STRCPY(IObuff, ":return ");
4009 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4010 if (STRLEN(s) + 8 >= IOSIZE)
4011 STRCPY(IObuff + IOSIZE - 4, "...");
4012 vim_free(tofree);
4013 return vim_strsave(IObuff);
4014}
4015
4016/*
4017 * Get next function line.
4018 * Called by do_cmdline() to get the next line.
4019 * Returns allocated string, or NULL for end of function.
4020 */
4021 char_u *
4022get_func_line(
4023 int c UNUSED,
4024 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004025 int indent UNUSED,
4026 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027{
4028 funccall_T *fcp = (funccall_T *)cookie;
4029 ufunc_T *fp = fcp->func;
4030 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004031 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032
Bram Moolenaare38eab22019-12-05 21:50:01 +01004033 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 if (fcp->dbg_tick != debug_tick)
4035 {
4036 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004037 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 fcp->dbg_tick = debug_tick;
4039 }
4040#ifdef FEAT_PROFILE
4041 if (do_profiling == PROF_YES)
4042 func_line_end(cookie);
4043#endif
4044
4045 gap = &fp->uf_lines;
4046 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4047 || fcp->returned)
4048 retval = NULL;
4049 else
4050 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004051 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 while (fcp->linenr < gap->ga_len
4053 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4054 ++fcp->linenr;
4055 if (fcp->linenr >= gap->ga_len)
4056 retval = NULL;
4057 else
4058 {
4059 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004060 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061#ifdef FEAT_PROFILE
4062 if (do_profiling == PROF_YES)
4063 func_line_start(cookie);
4064#endif
4065 }
4066 }
4067
Bram Moolenaare38eab22019-12-05 21:50:01 +01004068 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004069 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004071 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004072 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004074 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 fcp->dbg_tick = debug_tick;
4076 }
4077
4078 return retval;
4079}
4080
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081/*
4082 * Return TRUE if the currently active function should be ended, because a
4083 * return was encountered or an error occurred. Used inside a ":while".
4084 */
4085 int
4086func_has_ended(void *cookie)
4087{
4088 funccall_T *fcp = (funccall_T *)cookie;
4089
Bram Moolenaare38eab22019-12-05 21:50:01 +01004090 // Ignore the "abort" flag if the abortion behavior has been changed due to
4091 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4093 || fcp->returned);
4094}
4095
4096/*
4097 * return TRUE if cookie indicates a function which "abort"s on errors.
4098 */
4099 int
4100func_has_abort(
4101 void *cookie)
4102{
4103 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4104}
4105
4106
4107/*
4108 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4109 * Don't do this when "Func" is already a partial that was bound
4110 * explicitly (pt_auto is FALSE).
4111 * Changes "rettv" in-place.
4112 * Returns the updated "selfdict_in".
4113 */
4114 dict_T *
4115make_partial(dict_T *selfdict_in, typval_T *rettv)
4116{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004117 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 char_u *tofree = NULL;
4119 ufunc_T *fp;
4120 char_u fname_buf[FLEN_FIXED + 1];
4121 int error;
4122 dict_T *selfdict = selfdict_in;
4123
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004124 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4125 fp = rettv->vval.v_partial->pt_func;
4126 else
4127 {
4128 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4129 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004130 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004131 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004132 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004133 vim_free(tofree);
4134 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135
4136 if (fp != NULL && (fp->uf_flags & FC_DICT))
4137 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004138 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139
4140 if (pt != NULL)
4141 {
4142 pt->pt_refcount = 1;
4143 pt->pt_dict = selfdict;
4144 pt->pt_auto = TRUE;
4145 selfdict = NULL;
4146 if (rettv->v_type == VAR_FUNC)
4147 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004148 // Just a function: Take over the function name and use
4149 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 pt->pt_name = rettv->vval.v_string;
4151 }
4152 else
4153 {
4154 partial_T *ret_pt = rettv->vval.v_partial;
4155 int i;
4156
Bram Moolenaare38eab22019-12-05 21:50:01 +01004157 // Partial: copy the function name, use selfdict and copy
4158 // args. Can't take over name or args, the partial might
4159 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004160 if (ret_pt->pt_name != NULL)
4161 {
4162 pt->pt_name = vim_strsave(ret_pt->pt_name);
4163 func_ref(pt->pt_name);
4164 }
4165 else
4166 {
4167 pt->pt_func = ret_pt->pt_func;
4168 func_ptr_ref(pt->pt_func);
4169 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 if (ret_pt->pt_argc > 0)
4171 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004172 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004174 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 pt->pt_argc = 0;
4176 else
4177 {
4178 pt->pt_argc = ret_pt->pt_argc;
4179 for (i = 0; i < pt->pt_argc; i++)
4180 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4181 }
4182 }
4183 partial_unref(ret_pt);
4184 }
4185 rettv->v_type = VAR_PARTIAL;
4186 rettv->vval.v_partial = pt;
4187 }
4188 }
4189 return selfdict;
4190}
4191
4192/*
4193 * Return the name of the executed function.
4194 */
4195 char_u *
4196func_name(void *cookie)
4197{
4198 return ((funccall_T *)cookie)->func->uf_name;
4199}
4200
4201/*
4202 * Return the address holding the next breakpoint line for a funccall cookie.
4203 */
4204 linenr_T *
4205func_breakpoint(void *cookie)
4206{
4207 return &((funccall_T *)cookie)->breakpoint;
4208}
4209
4210/*
4211 * Return the address holding the debug tick for a funccall cookie.
4212 */
4213 int *
4214func_dbg_tick(void *cookie)
4215{
4216 return &((funccall_T *)cookie)->dbg_tick;
4217}
4218
4219/*
4220 * Return the nesting level for a funccall cookie.
4221 */
4222 int
4223func_level(void *cookie)
4224{
4225 return ((funccall_T *)cookie)->level;
4226}
4227
4228/*
4229 * Return TRUE when a function was ended by a ":return" command.
4230 */
4231 int
4232current_func_returned(void)
4233{
4234 return current_funccal->returned;
4235}
4236
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 int
4238free_unref_funccal(int copyID, int testing)
4239{
4240 int did_free = FALSE;
4241 int did_free_funccal = FALSE;
4242 funccall_T *fc, **pfc;
4243
4244 for (pfc = &previous_funccal; *pfc != NULL; )
4245 {
4246 if (can_free_funccal(*pfc, copyID))
4247 {
4248 fc = *pfc;
4249 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004250 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004251 did_free = TRUE;
4252 did_free_funccal = TRUE;
4253 }
4254 else
4255 pfc = &(*pfc)->caller;
4256 }
4257 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004258 // When a funccal was freed some more items might be garbage
4259 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 (void)garbage_collect(testing);
4261
4262 return did_free;
4263}
4264
4265/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004266 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 */
4268 static funccall_T *
4269get_funccal(void)
4270{
4271 int i;
4272 funccall_T *funccal;
4273 funccall_T *temp_funccal;
4274
4275 funccal = current_funccal;
4276 if (debug_backtrace_level > 0)
4277 {
4278 for (i = 0; i < debug_backtrace_level; i++)
4279 {
4280 temp_funccal = funccal->caller;
4281 if (temp_funccal)
4282 funccal = temp_funccal;
4283 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004284 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285 debug_backtrace_level = i;
4286 }
4287 }
4288 return funccal;
4289}
4290
4291/*
4292 * Return the hashtable used for local variables in the current funccal.
4293 * Return NULL if there is no current funccal.
4294 */
4295 hashtab_T *
4296get_funccal_local_ht()
4297{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004298 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 return NULL;
4300 return &get_funccal()->l_vars.dv_hashtab;
4301}
4302
4303/*
4304 * Return the l: scope variable.
4305 * Return NULL if there is no current funccal.
4306 */
4307 dictitem_T *
4308get_funccal_local_var()
4309{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004310 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311 return NULL;
4312 return &get_funccal()->l_vars_var;
4313}
4314
4315/*
4316 * Return the hashtable used for argument in the current funccal.
4317 * Return NULL if there is no current funccal.
4318 */
4319 hashtab_T *
4320get_funccal_args_ht()
4321{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004322 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 return NULL;
4324 return &get_funccal()->l_avars.dv_hashtab;
4325}
4326
4327/*
4328 * Return the a: scope variable.
4329 * Return NULL if there is no current funccal.
4330 */
4331 dictitem_T *
4332get_funccal_args_var()
4333{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004334 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004336 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337}
4338
4339/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 * List function variables, if there is a function.
4341 */
4342 void
4343list_func_vars(int *first)
4344{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004345 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004347 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348}
4349
4350/*
4351 * If "ht" is the hashtable for local variables in the current funccal, return
4352 * the dict that contains it.
4353 * Otherwise return NULL.
4354 */
4355 dict_T *
4356get_current_funccal_dict(hashtab_T *ht)
4357{
4358 if (current_funccal != NULL
4359 && ht == &current_funccal->l_vars.dv_hashtab)
4360 return &current_funccal->l_vars;
4361 return NULL;
4362}
4363
4364/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004365 * Search hashitem in parent scope.
4366 */
4367 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004368find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004369{
4370 funccall_T *old_current_funccal = current_funccal;
4371 hashtab_T *ht;
4372 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004373 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004374
4375 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4376 return NULL;
4377
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004378 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004379 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004380 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004381 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004382 ht = find_var_ht(name, &varname);
4383 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004384 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004385 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004386 if (!HASHITEM_EMPTY(hi))
4387 {
4388 *pht = ht;
4389 break;
4390 }
4391 }
4392 if (current_funccal == current_funccal->func->uf_scoped)
4393 break;
4394 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004395 }
4396 current_funccal = old_current_funccal;
4397
4398 return hi;
4399}
4400
4401/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004402 * Search variable in parent scope.
4403 */
4404 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004405find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004406{
4407 dictitem_T *v = NULL;
4408 funccall_T *old_current_funccal = current_funccal;
4409 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004410 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004411
4412 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4413 return NULL;
4414
Bram Moolenaare38eab22019-12-05 21:50:01 +01004415 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004416 current_funccal = current_funccal->func->uf_scoped;
4417 while (current_funccal)
4418 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004419 ht = find_var_ht(name, &varname);
4420 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004421 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004422 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004423 if (v != NULL)
4424 break;
4425 }
4426 if (current_funccal == current_funccal->func->uf_scoped)
4427 break;
4428 current_funccal = current_funccal->func->uf_scoped;
4429 }
4430 current_funccal = old_current_funccal;
4431
4432 return v;
4433}
4434
4435/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 * Set "copyID + 1" in previous_funccal and callers.
4437 */
4438 int
4439set_ref_in_previous_funccal(int copyID)
4440{
4441 int abort = FALSE;
4442 funccall_T *fc;
4443
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004444 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004445 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004446 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004447 abort = abort
4448 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4449 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004450 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004451 }
4452 return abort;
4453}
4454
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004455 static int
4456set_ref_in_funccal(funccall_T *fc, int copyID)
4457{
4458 int abort = FALSE;
4459
4460 if (fc->fc_copyID != copyID)
4461 {
4462 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004463 abort = abort
4464 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4465 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004466 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004467 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004468 }
4469 return abort;
4470}
4471
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472/*
4473 * Set "copyID" in all local vars and arguments in the call stack.
4474 */
4475 int
4476set_ref_in_call_stack(int copyID)
4477{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004478 int abort = FALSE;
4479 funccall_T *fc;
4480 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004482 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004483 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004484
4485 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004486 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4487 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004488 abort = abort || set_ref_in_funccal(fc, copyID);
4489
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004490 return abort;
4491}
4492
4493/*
4494 * Set "copyID" in all functions available by name.
4495 */
4496 int
4497set_ref_in_functions(int copyID)
4498{
4499 int todo;
4500 hashitem_T *hi = NULL;
4501 int abort = FALSE;
4502 ufunc_T *fp;
4503
4504 todo = (int)func_hashtab.ht_used;
4505 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004507 if (!HASHITEM_EMPTY(hi))
4508 {
4509 --todo;
4510 fp = HI2UF(hi);
4511 if (!func_name_refcount(fp->uf_name))
4512 abort = abort || set_ref_in_func(NULL, fp, copyID);
4513 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 }
4515 return abort;
4516}
4517
4518/*
4519 * Set "copyID" in all function arguments.
4520 */
4521 int
4522set_ref_in_func_args(int copyID)
4523{
4524 int i;
4525 int abort = FALSE;
4526
4527 for (i = 0; i < funcargs.ga_len; ++i)
4528 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4529 copyID, NULL, NULL);
4530 return abort;
4531}
4532
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004533/*
4534 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004535 * Returns TRUE if setting references failed somehow.
4536 */
4537 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004538set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004539{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004540 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004541 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004542 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004543 char_u fname_buf[FLEN_FIXED + 1];
4544 char_u *tofree = NULL;
4545 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004546 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004547
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004548 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004549 return FALSE;
4550
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004551 if (fp_in == NULL)
4552 {
4553 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004554 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004555 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004556 if (fp != NULL)
4557 {
4558 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004559 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004560 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004561
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004562 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004563 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004564}
4565
Bram Moolenaare38eab22019-12-05 21:50:01 +01004566#endif // FEAT_EVAL