blob: 01c44d44018fbcd4699593255aaaad3b92ba5951 [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 Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200201 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200279 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 typval_T rettv;
284
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100285 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 any_default = TRUE;
287 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200288 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200289 p = skipwhite(p);
290 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200291 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200292 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200293 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200294 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200311 default_args->ga_len++;
312 *p = c;
313 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200321 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200344 goto err_ret;
345 }
346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 else
348 mustend = TRUE;
349 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200350 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200351 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200352 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200353
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200354 if (*p != endchar)
355 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100356 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357
358 *argp = p;
359 return OK;
360
361err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200364 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200365 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200366 return FAIL;
367}
368
369/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
374parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200376 int len = 0;
377
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200383 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100400 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100435 return OK;
436}
437
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100438 static int
439parse_return_type(ufunc_T *fp, char_u *ret_type)
440{
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455}
456
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100457/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
461register_closure(ufunc_T *fp)
462{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200463 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200466 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200474 return OK;
475}
476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100477 static void
478set_ufunc_name(ufunc_T *fp, char_u *name)
479{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493}
494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
499get_lambda_name(void)
500{
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506}
507
Bram Moolenaar801ab062020-06-25 19:27:56 +0200508#if defined(FEAT_LUA) || defined(PROTO)
509/*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
514register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515{
516 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200521 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200522
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200523 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
526 fp->uf_flags = FC_CFUNC;
527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200537}
538#endif
539
Bram Moolenaar04b12692020-05-04 23:24:44 +0200540/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100553{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556
557 if (equal_arrow)
558 {
559 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100560 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100564 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 return skipwhite(s + 1);
593}
594
595/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
602is_function_cmd(char_u **cmd)
603{
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614}
615
616/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
622function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623{
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643}
644
645/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100646 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200647 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
652get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657{
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664#define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200666 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100675 char_u *heredoc_trimmed = NULL;
676
Bram Moolenaar20677332021-06-06 17:02:53 +0200677 ga_init2(&heredoc_ga, 1, 500);
678
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
723 vim_free(*line_to_free);
724 if (eap->getline == NULL)
725 theline = getcmdline(':', 0L, indent, getline_options);
726 else
727 theline = eap->getline(':', eap->cookie, indent,
728 getline_options);
729 *line_to_free = theline;
730 }
731 if (KeyTyped)
732 lines_left = Rows - 1;
733 if (theline == NULL)
734 {
735 // Use the start of the function for the line number.
736 SOURCING_LNUM = sourcing_lnum_top;
737 if (skip_until != NULL)
738 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200739 else if (nesting_inline[nesting])
740 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100741 else if (eap->cmdidx == CMD_def)
742 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100743 else
744 emsg(_("E126: Missing :endfunction"));
745 goto theend;
746 }
747
748 // Detect line continuation: SOURCING_LNUM increased more than one.
749 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
750 if (SOURCING_LNUM < sourcing_lnum_off)
751 sourcing_lnum_off -= SOURCING_LNUM;
752 else
753 sourcing_lnum_off = 0;
754
755 if (skip_until != NULL)
756 {
757 // Don't check for ":endfunc"/":enddef" between
758 // * ":append" and "."
759 // * ":python <<EOF" and "EOF"
760 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
761 if (heredoc_trimmed == NULL
762 || (is_heredoc && skipwhite(theline) == theline)
763 || STRNCMP(theline, heredoc_trimmed,
764 STRLEN(heredoc_trimmed)) == 0)
765 {
766 if (heredoc_trimmed == NULL)
767 p = theline;
768 else if (is_heredoc)
769 p = skipwhite(theline) == theline
770 ? theline : theline + STRLEN(heredoc_trimmed);
771 else
772 p = theline + STRLEN(heredoc_trimmed);
773 if (STRCMP(p, skip_until) == 0)
774 {
775 VIM_CLEAR(skip_until);
776 VIM_CLEAR(heredoc_trimmed);
777 getline_options = vim9_function
778 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
779 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200780
781 if (heredoc_concat_len > 0)
782 {
783 // Replace the starting line with all the concatenated
784 // lines.
785 ga_concat(&heredoc_ga, theline);
786 vim_free(((char_u **)(newlines->ga_data))[
787 heredoc_concat_len - 1]);
788 ((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1] = heredoc_ga.ga_data;
790 ga_init(&heredoc_ga);
791 heredoc_concat_len = 0;
792 theline += STRLEN(theline); // skip the "EOF"
793 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 }
795 }
796 }
797 else
798 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200799 int c;
800 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100801
802 // skip ':' and blanks
803 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
804 ;
805
806 // Check for "endfunction", "enddef" or "}".
807 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200808 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100809 ? *p == '}'
810 : (checkforcmd(&p, nesting_def[nesting]
811 ? "enddef" : "endfunction", 4)
812 && *p != ':'))
813 {
814 if (nesting-- == 0)
815 {
816 char_u *nextcmd = NULL;
817
818 if (*p == '|' || *p == '}')
819 nextcmd = p + 1;
820 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
821 nextcmd = line_arg;
822 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100823 && (vim9_function || p_verbose > 0))
824 {
825 if (eap->cmdidx == CMD_def)
826 semsg(_(e_text_found_after_enddef_str), p);
827 else
828 give_warning2((char_u *)
829 _("W22: Text found after :endfunction: %s"),
830 p, TRUE);
831 }
832 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100833 {
834 // Another command follows. If the line came from "eap"
835 // we can simply point into it, otherwise we need to
836 // change "eap->cmdlinep".
837 eap->nextcmd = nextcmd;
838 if (*line_to_free != NULL)
839 {
840 vim_free(*eap->cmdlinep);
841 *eap->cmdlinep = *line_to_free;
842 *line_to_free = NULL;
843 }
844 }
845 break;
846 }
847 }
848
849 // Check for mismatched "endfunc" or "enddef".
850 // We don't check for "def" inside "func" thus we also can't check
851 // for "enddef".
852 // We continue to find the end of the function, although we might
853 // not find it.
854 else if (nesting_def[nesting])
855 {
856 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
857 emsg(_(e_mismatched_endfunction));
858 }
859 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
860 emsg(_(e_mismatched_enddef));
861
862 // Increase indent inside "if", "while", "for" and "try", decrease
863 // at "end".
864 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
865 indent -= 2;
866 else if (STRNCMP(p, "if", 2) == 0
867 || STRNCMP(p, "wh", 2) == 0
868 || STRNCMP(p, "for", 3) == 0
869 || STRNCMP(p, "try", 3) == 0)
870 indent += 2;
871
872 // Check for defining a function inside this function.
873 // Only recognize "def" inside "def", not inside "function",
874 // For backwards compatibility, see Test_function_python().
875 c = *p;
876 if (is_function_cmd(&p)
877 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
878 {
879 if (*p == '!')
880 p = skipwhite(p + 1);
881 p += eval_fname_script(p);
882 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
883 NULL, NULL));
884 if (*skipwhite(p) == '(')
885 {
886 if (nesting == MAX_FUNC_NESTING - 1)
887 emsg(_(e_function_nesting_too_deep));
888 else
889 {
890 ++nesting;
891 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200892 nesting_inline[nesting] = FALSE;
893 indent += 2;
894 }
895 }
896 }
897
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200898 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200899 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200900 // Not a comment line: check for nested inline function.
901 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200902 while (end > p && VIM_ISWHITE(*end))
903 --end;
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200904 if (end > p && *end == '{')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200905 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200906 int is_block;
907
908 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200909 --end;
910 while (end > p && VIM_ISWHITE(*end))
911 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200912 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
913 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200914 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200915 char_u *s = p;
916
917 // check for line starting with "au" for :autocmd or
918 // "com" for :command, these can use a {} block
919 is_block = checkforcmd_noparen(&s, "autocmd", 2)
920 || checkforcmd_noparen(&s, "command", 3);
921 }
922
923 if (is_block)
924 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200925 if (nesting == MAX_FUNC_NESTING - 1)
926 emsg(_(e_function_nesting_too_deep));
927 else
928 {
929 ++nesting;
930 nesting_def[nesting] = TRUE;
931 nesting_inline[nesting] = TRUE;
932 indent += 2;
933 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100934 }
935 }
936 }
937
938 // Check for ":append", ":change", ":insert". Not for :def.
939 p = skip_range(p, FALSE, NULL);
940 if (!vim9_function
941 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
942 || (p[0] == 'c'
943 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
944 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
945 && (STRNCMP(&p[3], "nge", 3) != 0
946 || !ASCII_ISALPHA(p[6])))))))
947 || (p[0] == 'i'
948 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
949 && (!ASCII_ISALPHA(p[2])
950 || (p[2] == 's'
951 && (!ASCII_ISALPHA(p[3])
952 || p[3] == 'e'))))))))
953 skip_until = vim_strsave((char_u *)".");
954
955 // Check for ":python <<EOF", ":tcl <<EOF", etc.
956 arg = skipwhite(skiptowhite(p));
957 if (arg[0] == '<' && arg[1] =='<'
958 && ((p[0] == 'p' && p[1] == 'y'
959 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
960 || ((p[2] == '3' || p[2] == 'x')
961 && !ASCII_ISALPHA(p[3]))))
962 || (p[0] == 'p' && p[1] == 'e'
963 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
964 || (p[0] == 't' && p[1] == 'c'
965 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
966 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
967 && !ASCII_ISALPHA(p[3]))
968 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
969 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
970 || (p[0] == 'm' && p[1] == 'z'
971 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
972 ))
973 {
974 // ":python <<" continues until a dot, like ":append"
975 p = skipwhite(arg + 2);
976 if (STRNCMP(p, "trim", 4) == 0)
977 {
978 // Ignore leading white space.
979 p = skipwhite(p + 4);
980 heredoc_trimmed = vim_strnsave(theline,
981 skipwhite(theline) - theline);
982 }
983 if (*p == NUL)
984 skip_until = vim_strsave((char_u *)".");
985 else
986 skip_until = vim_strnsave(p, skiptowhite(p) - p);
987 getline_options = GETLINE_NONE;
988 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200989 if (eap->cmdidx == CMD_def)
990 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100991 }
992
993 // Check for ":cmd v =<< [trim] EOF"
994 // and ":cmd [a, b] =<< [trim] EOF"
995 // and "lines =<< [trim] EOF" for Vim9
996 // Where "cmd" can be "let", "var", "final" or "const".
997 arg = skipwhite(skiptowhite(p));
998 if (*arg == '[')
999 arg = vim_strchr(arg, ']');
1000 if (arg != NULL)
1001 {
1002 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1003 && arg[1] == '<' && arg[2] =='<');
1004
1005 if (!found)
1006 // skip over the argument after "cmd"
1007 arg = skipwhite(skiptowhite(arg));
1008 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1009 && (checkforcmd(&p, "let", 2)
1010 || checkforcmd(&p, "var", 3)
1011 || checkforcmd(&p, "final", 5)
1012 || checkforcmd(&p, "const", 5))))
1013 {
1014 p = skipwhite(arg + 3);
1015 if (STRNCMP(p, "trim", 4) == 0)
1016 {
1017 // Ignore leading white space.
1018 p = skipwhite(p + 4);
1019 heredoc_trimmed = vim_strnsave(theline,
1020 skipwhite(theline) - theline);
1021 }
1022 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1023 getline_options = GETLINE_NONE;
1024 is_heredoc = TRUE;
1025 }
1026 }
1027 }
1028
1029 // Add the line to the function.
1030 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1031 goto theend;
1032
Bram Moolenaar20677332021-06-06 17:02:53 +02001033 if (heredoc_concat_len > 0)
1034 {
1035 // For a :def function "python << EOF" concatenats all the lines,
1036 // to be used for the instruction later.
1037 ga_concat(&heredoc_ga, theline);
1038 ga_concat(&heredoc_ga, (char_u *)"\n");
1039 p = vim_strsave((char_u *)"");
1040 }
1041 else
1042 {
1043 // Copy the line to newly allocated memory. get_one_sourceline()
1044 // allocates 250 bytes per line, this saves 80% on average. The
1045 // cost is an extra alloc/free.
1046 p = vim_strsave(theline);
1047 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001048 if (p == NULL)
1049 goto theend;
1050 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1051
1052 // Add NULL lines for continuation lines, so that the line count is
1053 // equal to the index in the growarray.
1054 while (sourcing_lnum_off-- > 0)
1055 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1056
1057 // Check for end of eap->arg.
1058 if (line_arg != NULL && *line_arg == NUL)
1059 line_arg = NULL;
1060 }
1061
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001062 // Return OK when no error was detected.
1063 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001064 ret = OK;
1065
1066theend:
1067 vim_free(skip_until);
1068 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001069 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001070 need_wait_return |= saved_wait_return;
1071 return ret;
1072}
1073
1074/*
1075 * Handle the body of a lambda. *arg points to the "{", process statements
1076 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001077 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001078 * When successful "rettv" is set to a funcref.
1079 */
1080 static int
1081lambda_function_body(
1082 char_u **arg,
1083 typval_T *rettv,
1084 evalarg_T *evalarg,
1085 garray_T *newargs,
1086 garray_T *argtypes,
1087 int varargs,
1088 garray_T *default_args,
1089 char_u *ret_type)
1090{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001091 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001092 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001093 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001094 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001095 exarg_T eap;
1096 garray_T newlines;
1097 char_u *cmdline = NULL;
1098 int ret = FAIL;
1099 char_u *line_to_free = NULL;
1100 partial_T *pt;
1101 char_u *name;
1102 int lnum_save = -1;
1103 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1104
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001105 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1106 {
1107 semsg(_(e_trailing_arg), *arg + 1);
1108 return FAIL;
1109 }
1110
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001111 CLEAR_FIELD(eap);
1112 eap.cmdidx = CMD_block;
1113 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001114 eap.cmdlinep = &cmdline;
1115 eap.skip = !evaluate;
1116 if (evalarg->eval_cctx != NULL)
1117 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1118 else
1119 {
1120 eap.getline = evalarg->eval_getline;
1121 eap.cookie = evalarg->eval_cookie;
1122 }
1123
1124 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1125 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001126 {
1127 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001128 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001129 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001130
1131 // When inside a lambda must add the function lines to evalarg.eval_ga.
1132 evalarg->eval_break_count += newlines.ga_len;
1133 if (gap->ga_itemsize > 0)
1134 {
1135 int idx;
1136 char_u *last;
1137 size_t plen;
1138 char_u *pnl;
1139
1140 for (idx = 0; idx < newlines.ga_len; ++idx)
1141 {
1142 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1143
Bram Moolenaarecb66452021-05-18 15:09:18 +02001144 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001145 goto erret;
1146
1147 // Going to concatenate the lines after parsing. For an empty or
1148 // comment line use an empty string.
1149 // Insert NL characters at the start of each line, the string will
1150 // be split again later in .get_lambda_tv().
1151 if (*p == NUL || vim9_comment_start(p))
1152 p = (char_u *)"";
1153 plen = STRLEN(p);
1154 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1155 if (pnl != NULL)
1156 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001157 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1158 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001159 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001160 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001161 goto erret;
1162 if (cmdline != NULL)
1163 // more is following after the "}", which was skipped
1164 last = cmdline;
1165 else
1166 // nothing is following the "}"
1167 last = (char_u *)"}";
1168 plen = STRLEN(last);
1169 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1170 if (pnl != NULL)
1171 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001172 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1173 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001174 }
1175
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001176 if (cmdline != NULL)
1177 {
1178 // Something comes after the "}".
1179 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001180
1181 // "arg" points into cmdline, need to keep the line and free it later.
1182 vim_free(evalarg->eval_tofree_cmdline);
1183 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001184 }
1185 else
1186 *arg = (char_u *)"";
1187
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001188 if (!evaluate)
1189 {
1190 ret = OK;
1191 goto erret;
1192 }
1193
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001194 name = get_lambda_name();
1195 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1196 if (ufunc == NULL)
1197 goto erret;
1198 set_ufunc_name(ufunc, name);
1199 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001200 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001201 ufunc->uf_refcount = 1;
1202 ufunc->uf_args = *newargs;
1203 newargs->ga_data = NULL;
1204 ufunc->uf_def_args = *default_args;
1205 default_args->ga_data = NULL;
1206 ufunc->uf_func_type = &t_func_any;
1207
1208 // error messages are for the first function line
1209 lnum_save = SOURCING_LNUM;
1210 SOURCING_LNUM = sourcing_lnum_top;
1211
1212 // parse argument types
1213 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1214 {
1215 SOURCING_LNUM = lnum_save;
1216 goto erret;
1217 }
1218
1219 // parse the return type, if any
1220 if (parse_return_type(ufunc, ret_type) == FAIL)
1221 goto erret;
1222
1223 pt = ALLOC_CLEAR_ONE(partial_T);
1224 if (pt == NULL)
1225 goto erret;
1226 pt->pt_func = ufunc;
1227 pt->pt_refcount = 1;
1228
1229 ufunc->uf_lines = newlines;
1230 newlines.ga_data = NULL;
1231 if (sandbox)
1232 ufunc->uf_flags |= FC_SANDBOX;
1233 if (!ASCII_ISUPPER(*ufunc->uf_name))
1234 ufunc->uf_flags |= FC_VIM9;
1235 ufunc->uf_script_ctx = current_sctx;
1236 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1237 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1238 set_function_type(ufunc);
1239
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001240 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1241
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001242 rettv->vval.v_partial = pt;
1243 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001244 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001245 ret = OK;
1246
1247erret:
1248 if (lnum_save >= 0)
1249 SOURCING_LNUM = lnum_save;
1250 vim_free(line_to_free);
1251 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001252 if (newargs != NULL)
1253 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001254 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001255 if (ufunc != NULL)
1256 {
1257 func_clear(ufunc, TRUE);
1258 func_free(ufunc, TRUE);
1259 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001260 return ret;
1261}
1262
1263/*
1264 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001265 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001266 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1268 */
1269 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001270get_lambda_tv(
1271 char_u **arg,
1272 typval_T *rettv,
1273 int types_optional,
1274 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001275{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001276 int evaluate = evalarg != NULL
1277 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001278 garray_T newargs;
1279 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001280 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001281 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001283 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001284 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001286 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001288 char_u *s;
1289 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001290 int *old_eval_lavars = eval_lavars_used;
1291 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001292 char_u *tofree1 = NULL;
1293 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001294 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001295 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001296 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001297
1298 if (equal_arrow && !in_vim9script())
1299 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001300
1301 ga_init(&newargs);
1302 ga_init(&newlines);
1303
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001304 // First, check if this is really a lambda expression. "->" or "=>" must
1305 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001306 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001307 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001308 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001309 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001310 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001311 {
1312 if (types_optional)
1313 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001314 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001315 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001316
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001317 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001318 if (evaluate)
1319 pnewargs = &newargs;
1320 else
1321 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001322 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001323 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001324 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001325 &varargs, &default_args,
1326 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001327 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001328 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001329 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001330 {
1331 if (types_optional)
1332 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001333 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001334 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001335 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001336 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001337
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001338 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1339 if (ret_type != NULL)
1340 {
1341 ret_type = vim_strsave(ret_type);
1342 tofree2 = ret_type;
1343 }
1344
Bram Moolenaare38eab22019-12-05 21:50:01 +01001345 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001346 if (evaluate)
1347 eval_lavars_used = &eval_lavars;
1348
Bram Moolenaar65c44152020-12-24 15:14:01 +01001349 *arg = skipwhite_and_linebreak(*arg, evalarg);
1350
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001351 // Recognize "{" as the start of a function body.
1352 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001353 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001354 if (evalarg == NULL)
1355 // cannot happen?
1356 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001357 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1358 types_optional ? &argtypes : NULL, varargs,
1359 &default_args, ret_type) == FAIL)
1360 goto errret;
1361 goto theend;
1362 }
1363 if (default_args.ga_len > 0)
1364 {
1365 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001366 goto errret;
1367 }
1368
Bram Moolenaare38eab22019-12-05 21:50:01 +01001369 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001370 start = *arg;
1371 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372 if (ret == FAIL)
1373 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001374 if (evalarg != NULL)
1375 {
1376 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001377 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001378 evalarg->eval_tofree = NULL;
1379 }
1380
Bram Moolenaar65c44152020-12-24 15:14:01 +01001381 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001382 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001383 *arg = skipwhite_and_linebreak(*arg, evalarg);
1384 if (**arg != '}')
1385 {
1386 semsg(_("E451: Expected }: %s"), *arg);
1387 goto errret;
1388 }
1389 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001390 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001391
1392 if (evaluate)
1393 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001394 int len;
1395 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001396 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001397 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001398 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001399
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001400 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001401 if (fp == NULL)
1402 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001403 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001404 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001405 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001406 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001407
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1409 if (ga_grow(&newlines, 1) == FAIL)
1410 goto errret;
1411
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001412 // If there are line breaks, we need to split up the string.
1413 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001414 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001415 line_end = end;
1416
1417 // Add "return " before the expression (or the first line).
1418 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001419 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420 if (p == NULL)
1421 goto errret;
1422 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1423 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001424 vim_strncpy(p + 7, start, line_end - start);
1425
1426 if (line_end != end)
1427 {
1428 // Add more lines, split by line breaks. Thus is used when a
1429 // lambda with { cmds } is encountered.
1430 while (*line_end == '\n')
1431 {
1432 if (ga_grow(&newlines, 1) == FAIL)
1433 goto errret;
1434 start = line_end + 1;
1435 line_end = vim_strchr(start, '\n');
1436 if (line_end == NULL)
1437 line_end = end;
1438 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1439 vim_strnsave(start, line_end - start);
1440 }
1441 }
1442
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001443 if (strstr((char *)p + 7, "a:") == NULL)
1444 // No a: variables are used for sure.
1445 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001446
1447 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001448 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001450 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001451 if (types_optional)
1452 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001453 if (parse_argument_types(fp, &argtypes,
1454 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001455 goto errret;
1456 if (ret_type != NULL)
1457 {
1458 fp->uf_ret_type = parse_type(&ret_type,
1459 &fp->uf_type_list, TRUE);
1460 if (fp->uf_ret_type == NULL)
1461 goto errret;
1462 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001463 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001464 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001465 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001466
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001468 if (current_funccal != NULL && eval_lavars)
1469 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001470 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001471 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001472 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001473 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474
1475#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476 if (prof_def_func())
1477 func_do_profile(fp);
1478#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001479 if (sandbox)
1480 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001481 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001482 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1483 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001484 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001486 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001487 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001489 function_using_block_scopes(fp, evalarg->eval_cstack);
1490
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001491 pt->pt_func = fp;
1492 pt->pt_refcount = 1;
1493 rettv->vval.v_partial = pt;
1494 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001495
1496 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001497 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001499theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001500 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001501 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001502 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001503 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001504 vim_free(tofree1);
1505 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001506 if (types_optional)
1507 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509 return OK;
1510
1511errret:
1512 ga_clear_strings(&newargs);
1513 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001514 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001515 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001516 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001517 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001518 if (fp != NULL)
1519 vim_free(fp->uf_arg_types);
1520 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001521 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001522 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001523 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001524 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001525 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001526 vim_free(tofree1);
1527 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001528 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 return FAIL;
1530}
1531
1532/*
1533 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1534 * name it contains, otherwise return "name".
1535 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1536 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001537 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1538 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001539 */
1540 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001541deref_func_name(
1542 char_u *name,
1543 int *lenp,
1544 partial_T **partialp,
1545 type_T **type,
1546 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001547{
1548 dictitem_T *v;
1549 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001550 char_u *s = NULL;
1551 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552
1553 if (partialp != NULL)
1554 *partialp = NULL;
1555
1556 cc = name[*lenp];
1557 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001558
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001559 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001561 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001563 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001565 if (v->di_tv.vval.v_string == NULL)
1566 {
1567 *lenp = 0;
1568 return (char_u *)""; // just in case
1569 }
1570 s = v->di_tv.vval.v_string;
1571 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001573
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001574 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001576 partial_T *pt = v->di_tv.vval.v_partial;
1577
1578 if (pt == NULL)
1579 {
1580 *lenp = 0;
1581 return (char_u *)""; // just in case
1582 }
1583 if (partialp != NULL)
1584 *partialp = pt;
1585 s = partial_name(pt);
1586 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001588
1589 if (s != NULL)
1590 {
1591 if (type != NULL && ht == get_script_local_ht())
1592 {
Bram Moolenaarc967d572021-07-08 21:38:50 +02001593 svar_T *sv = find_typval_in_script(&v->di_tv);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001594
1595 if (sv != NULL)
1596 *type = sv->sv_type;
1597 }
1598 return s;
1599 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 }
1601
1602 return name;
1603}
1604
1605/*
1606 * Give an error message with a function name. Handle <SNR> things.
1607 * "ermsg" is to be passed without translation, use N_() instead of _().
1608 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001609 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610emsg_funcname(char *ermsg, char_u *name)
1611{
1612 char_u *p;
1613
1614 if (*name == K_SPECIAL)
1615 p = concat_str((char_u *)"<SNR>", name + 3);
1616 else
1617 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001618 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619 if (p != name)
1620 vim_free(p);
1621}
1622
1623/*
1624 * Allocate a variable for the result of a function.
1625 * Return OK or FAIL.
1626 */
1627 int
1628get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001629 char_u *name, // name of the function
1630 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001631 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001632 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001633 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001634 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635{
1636 char_u *argp;
1637 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001638 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1639 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001640 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001641
1642 /*
1643 * Get the arguments.
1644 */
1645 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001646 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1647 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001649 // skip the '(' or ',' and possibly line breaks
1650 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1651
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 if (*argp == ')' || *argp == ',' || *argp == NUL)
1653 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001654 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001655 {
1656 ret = FAIL;
1657 break;
1658 }
1659 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001660 // The comma should come right after the argument, but this wasn't
1661 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001662 if (vim9script)
1663 {
1664 if (*argp != ',' && *skipwhite(argp) == ',')
1665 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001666 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001667 ret = FAIL;
1668 break;
1669 }
1670 }
1671 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001672 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001673 if (*argp != ',')
1674 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001675 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1676 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001677 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001678 ret = FAIL;
1679 break;
1680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001682 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 if (*argp == ')')
1684 ++argp;
1685 else
1686 ret = FAIL;
1687
1688 if (ret == OK)
1689 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001690 int i = 0;
1691 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692
1693 if (get_vim_var_nr(VV_TESTING))
1694 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001695 // Prepare for calling test_garbagecollect_now(), need to know
1696 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 if (funcargs.ga_itemsize == 0)
1698 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1699 for (i = 0; i < argcount; ++i)
1700 if (ga_grow(&funcargs, 1) == OK)
1701 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1702 &argvars[i];
1703 }
1704
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001705 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001706 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001707 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001708 // An error in a builtin function does not return FAIL, but we do
1709 // want to abort further processing if an error was given.
1710 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001711 clear_tv(rettv);
1712 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713
1714 funcargs.ga_len -= i;
1715 }
1716 else if (!aborting())
1717 {
1718 if (argcount == MAX_FUNC_ARGS)
1719 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1720 else
1721 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1722 }
1723
1724 while (--argcount >= 0)
1725 clear_tv(&argvars[argcount]);
1726
Bram Moolenaar8294d492020-08-10 22:40:56 +02001727 if (in_vim9script())
1728 *arg = argp;
1729 else
1730 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731 return ret;
1732}
1733
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734/*
1735 * Return TRUE if "p" starts with "<SID>" or "s:".
1736 * Only works if eval_fname_script() returned non-zero for "p"!
1737 */
1738 static int
1739eval_fname_sid(char_u *p)
1740{
1741 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1742}
1743
1744/*
1745 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1746 * Change <SNR>123_name() to K_SNR 123_name().
1747 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1748 * (slow).
1749 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001750 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1752{
1753 int llen;
1754 char_u *fname;
1755 int i;
1756
1757 llen = eval_fname_script(name);
1758 if (llen > 0)
1759 {
1760 fname_buf[0] = K_SPECIAL;
1761 fname_buf[1] = KS_EXTRA;
1762 fname_buf[2] = (int)KE_SNR;
1763 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001764 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001766 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001767 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001768 else
1769 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001770 sprintf((char *)fname_buf + 3, "%ld_",
1771 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001772 i = (int)STRLEN(fname_buf);
1773 }
1774 }
1775 if (i + STRLEN(name + llen) < FLEN_FIXED)
1776 {
1777 STRCPY(fname_buf + i, name + llen);
1778 fname = fname_buf;
1779 }
1780 else
1781 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001782 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001784 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 else
1786 {
1787 *tofree = fname;
1788 mch_memmove(fname, fname_buf, (size_t)i);
1789 STRCPY(fname + i, name + llen);
1790 }
1791 }
1792 }
1793 else
1794 fname = name;
1795 return fname;
1796}
1797
1798/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001799 * Find a function "name" in script "sid".
1800 */
1801 static ufunc_T *
1802find_func_with_sid(char_u *name, int sid)
1803{
1804 hashitem_T *hi;
1805 char_u buffer[200];
1806
1807 buffer[0] = K_SPECIAL;
1808 buffer[1] = KS_EXTRA;
1809 buffer[2] = (int)KE_SNR;
1810 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1811 (long)sid, name);
1812 hi = hash_find(&func_hashtab, buffer);
1813 if (!HASHITEM_EMPTY(hi))
1814 return HI2UF(hi);
1815
1816 return NULL;
1817}
1818
1819/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001821 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 * Return NULL for unknown function.
1823 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001824 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001825find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826{
1827 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001828 ufunc_T *func;
1829 imported_T *imported;
1830
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001831 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001832 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001833 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001834 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001835 int find_script_local = in_vim9script()
1836 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001837
Bram Moolenaar95006e32020-08-29 17:47:08 +02001838 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001839 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001840 // Find script-local function before global one.
1841 func = find_func_with_sid(name, current_sctx.sc_sid);
1842 if (func != NULL)
1843 return func;
1844 }
1845
Bram Moolenaarefa94442020-08-08 22:16:00 +02001846 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001847 && name[1] == KS_EXTRA
1848 && name[2] == KE_SNR)
1849 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001850 // Caller changes s: to <SNR>99_name.
1851
1852 after_script = name + 3;
1853 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001854 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001855 ++after_script;
1856 else
1857 after_script = NULL;
1858 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001859 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001860 {
1861 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001862 if (after_script != NULL && sid != current_sctx.sc_sid)
1863 imported = find_imported_in_script(after_script, 0, sid);
1864 else
1865 imported = find_imported(after_script == NULL
1866 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001867 if (imported != NULL && imported->imp_funcname != NULL)
1868 {
1869 hi = hash_find(&func_hashtab, imported->imp_funcname);
1870 if (!HASHITEM_EMPTY(hi))
1871 return HI2UF(hi);
1872 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001873 }
1874 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875
Bram Moolenaara26b9702020-04-18 19:53:28 +02001876 hi = hash_find(&func_hashtab,
1877 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001878 if (!HASHITEM_EMPTY(hi))
1879 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001880
1881 return NULL;
1882}
1883
1884/*
1885 * Find a function by name, return pointer to it in ufuncs.
1886 * "cctx" is passed in a :def function to find imported functions.
1887 * Return NULL for unknown or dead function.
1888 */
1889 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001890find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001891{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001892 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001893
1894 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1895 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 return NULL;
1897}
1898
1899/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001900 * Return TRUE if "ufunc" is a global function.
1901 */
1902 int
1903func_is_global(ufunc_T *ufunc)
1904{
1905 return ufunc->uf_name[0] != K_SPECIAL;
1906}
1907
1908/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 * Copy the function name of "fp" to buffer "buf".
1910 * "buf" must be able to hold the function name plus three bytes.
1911 * Takes care of script-local function names.
1912 */
1913 static void
1914cat_func_name(char_u *buf, ufunc_T *fp)
1915{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001916 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 {
1918 STRCPY(buf, "<SNR>");
1919 STRCAT(buf, fp->uf_name + 3);
1920 }
1921 else
1922 STRCPY(buf, fp->uf_name);
1923}
1924
1925/*
1926 * Add a number variable "name" to dict "dp" with value "nr".
1927 */
1928 static void
1929add_nr_var(
1930 dict_T *dp,
1931 dictitem_T *v,
1932 char *name,
1933 varnumber_T nr)
1934{
1935 STRCPY(v->di_key, name);
1936 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1937 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1938 v->di_tv.v_type = VAR_NUMBER;
1939 v->di_tv.v_lock = VAR_FIXED;
1940 v->di_tv.vval.v_number = nr;
1941}
1942
1943/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001944 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001946 static void
1947free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001948{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001949 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001950
1951 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1952 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001953 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001954
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001955 // When garbage collecting a funccall_T may be freed before the
1956 // function that references it, clear its uf_scoped field.
1957 // The function may have been redefined and point to another
1958 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001959 if (fp != NULL && fp->uf_scoped == fc)
1960 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001961 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001962 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001963
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001964 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965 vim_free(fc);
1966}
1967
1968/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001969 * Free "fc" and what it contains.
1970 * Can be called only when "fc" is kept beyond the period of it called,
1971 * i.e. after cleanup_function_call(fc).
1972 */
1973 static void
1974free_funccal_contents(funccall_T *fc)
1975{
1976 listitem_T *li;
1977
1978 // Free all l: variables.
1979 vars_clear(&fc->l_vars.dv_hashtab);
1980
1981 // Free all a: variables.
1982 vars_clear(&fc->l_avars.dv_hashtab);
1983
1984 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001985 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001986 clear_tv(&li->li_tv);
1987
1988 free_funccal(fc);
1989}
1990
1991/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001992 * Handle the last part of returning from a function: free the local hashtable.
1993 * Unless it is still in use by a closure.
1994 */
1995 static void
1996cleanup_function_call(funccall_T *fc)
1997{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001998 int may_free_fc = fc->fc_refcount <= 0;
1999 int free_fc = TRUE;
2000
Bram Moolenaar6914c642017-04-01 21:21:30 +02002001 current_funccal = fc->caller;
2002
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002003 // Free all l: variables if not referred.
2004 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2005 vars_clear(&fc->l_vars.dv_hashtab);
2006 else
2007 free_fc = FALSE;
2008
2009 // If the a:000 list and the l: and a: dicts are not referenced and
2010 // there is no closure using it, we can free the funccall_T and what's
2011 // in it.
2012 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2013 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002014 else
2015 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002016 int todo;
2017 hashitem_T *hi;
2018 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002019
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002020 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002021
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002022 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002023 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2024 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2025 {
2026 if (!HASHITEM_EMPTY(hi))
2027 {
2028 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002029 di = HI2DI(hi);
2030 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002031 }
2032 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002033 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002034
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002035 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2036 fc->l_varlist.lv_first = NULL;
2037 else
2038 {
2039 listitem_T *li;
2040
2041 free_fc = FALSE;
2042
2043 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002044 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002045 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002046 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002047
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002048 if (free_fc)
2049 free_funccal(fc);
2050 else
2051 {
2052 static int made_copy = 0;
2053
2054 // "fc" is still in use. This can happen when returning "a:000",
2055 // assigning "l:" to a global variable or defining a closure.
2056 // Link "fc" in the list for garbage collection later.
2057 fc->caller = previous_funccal;
2058 previous_funccal = fc;
2059
2060 if (want_garbage_collect)
2061 // If garbage collector is ready, clear count.
2062 made_copy = 0;
2063 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002064 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002065 // We have made a lot of copies, worth 4 Mbyte. This can happen
2066 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002067 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002068 // too much memory.
2069 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002070 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002071 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002072 }
2073}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002074
2075/*
2076 * There are two kinds of function names:
2077 * 1. ordinary names, function defined with :function or :def
2078 * 2. numbered functions and lambdas
2079 * For the first we only count the name stored in func_hashtab as a reference,
2080 * using function() does not count as a reference, because the function is
2081 * looked up by name.
2082 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002083 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002084func_name_refcount(char_u *name)
2085{
2086 return isdigit(*name) || *name == '<';
2087}
2088
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002089/*
2090 * Unreference "fc": decrement the reference count and free it when it
2091 * becomes zero. "fp" is detached from "fc".
2092 * When "force" is TRUE we are exiting.
2093 */
2094 static void
2095funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2096{
2097 funccall_T **pfc;
2098 int i;
2099
2100 if (fc == NULL)
2101 return;
2102
2103 if (--fc->fc_refcount <= 0 && (force || (
2104 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2105 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2106 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2107 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2108 {
2109 if (fc == *pfc)
2110 {
2111 *pfc = fc->caller;
2112 free_funccal_contents(fc);
2113 return;
2114 }
2115 }
2116 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2117 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2118 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2119}
2120
2121/*
2122 * Remove the function from the function hashtable. If the function was
2123 * deleted while it still has references this was already done.
2124 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2125 */
2126 static int
2127func_remove(ufunc_T *fp)
2128{
2129 hashitem_T *hi;
2130
2131 // Return if it was already virtually deleted.
2132 if (fp->uf_flags & FC_DEAD)
2133 return FALSE;
2134
2135 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2136 if (!HASHITEM_EMPTY(hi))
2137 {
2138 // When there is a def-function index do not actually remove the
2139 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002140 // Do remove it when it's a copy.
2141 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002142 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002143 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002144 return FALSE;
2145 }
2146 hash_remove(&func_hashtab, hi);
2147 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002148 return TRUE;
2149 }
2150 return FALSE;
2151}
2152
2153 static void
2154func_clear_items(ufunc_T *fp)
2155{
2156 ga_clear_strings(&(fp->uf_args));
2157 ga_clear_strings(&(fp->uf_def_args));
2158 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002159 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002160 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002161 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002162 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002163
2164 // Increment the refcount of this function to avoid it being freed
2165 // recursively when the partial is freed.
2166 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002167 partial_unref(fp->uf_partial);
2168 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002169 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002170
2171#ifdef FEAT_LUA
2172 if (fp->uf_cb_free != NULL)
2173 {
2174 fp->uf_cb_free(fp->uf_cb_state);
2175 fp->uf_cb_free = NULL;
2176 }
2177
2178 fp->uf_cb_state = NULL;
2179 fp->uf_cb = NULL;
2180#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002181#ifdef FEAT_PROFILE
2182 VIM_CLEAR(fp->uf_tml_count);
2183 VIM_CLEAR(fp->uf_tml_total);
2184 VIM_CLEAR(fp->uf_tml_self);
2185#endif
2186}
2187
2188/*
2189 * Free all things that a function contains. Does not free the function
2190 * itself, use func_free() for that.
2191 * When "force" is TRUE we are exiting.
2192 */
2193 static void
2194func_clear(ufunc_T *fp, int force)
2195{
2196 if (fp->uf_cleared)
2197 return;
2198 fp->uf_cleared = TRUE;
2199
2200 // clear this function
2201 func_clear_items(fp);
2202 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002203 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002204}
2205
2206/*
2207 * Free a function and remove it from the list of functions. Does not free
2208 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002209 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002210 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002211 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002212 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002213func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002214{
2215 // Only remove it when not done already, otherwise we would remove a newer
2216 // version of the function with the same name.
2217 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2218 func_remove(fp);
2219
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002220 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002221 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002222 if (fp->uf_dfunc_idx > 0)
2223 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002224 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002225 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002226 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002227 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002228 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002229}
2230
2231/*
2232 * Free all things that a function contains and free the function itself.
2233 * When "force" is TRUE we are exiting.
2234 */
2235 static void
2236func_clear_free(ufunc_T *fp, int force)
2237{
2238 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002239 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2240 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002241 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002242 else
2243 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002244}
2245
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002246/*
2247 * Copy already defined function "lambda" to a new function with name "global".
2248 * This is for when a compiled function defines a global function.
2249 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002250 int
2251copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002252{
2253 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002254 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002255
2256 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002257 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002258 semsg(_(e_lambda_function_not_found_str), lambda);
2259 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002260 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002261
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002262 fp = find_func(global, TRUE, NULL);
2263 if (fp != NULL)
2264 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002265 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002266 semsg(_(e_funcexts), global);
2267 return FAIL;
2268 }
2269
2270 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2271 if (fp == NULL)
2272 return FAIL;
2273
2274 fp->uf_varargs = ufunc->uf_varargs;
2275 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2276 fp->uf_def_status = ufunc->uf_def_status;
2277 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2278 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2279 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2280 == FAIL
2281 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2282 goto failed;
2283
2284 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2285 : vim_strsave(ufunc->uf_name_exp);
2286 if (ufunc->uf_arg_types != NULL)
2287 {
2288 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2289 if (fp->uf_arg_types == NULL)
2290 goto failed;
2291 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2292 sizeof(type_T *) * fp->uf_args.ga_len);
2293 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002294 if (ufunc->uf_va_name != NULL)
2295 {
2296 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2297 if (fp->uf_va_name == NULL)
2298 goto failed;
2299 }
2300 fp->uf_ret_type = ufunc->uf_ret_type;
2301
2302 fp->uf_refcount = 1;
2303 STRCPY(fp->uf_name, global);
2304 hash_add(&func_hashtab, UF2HIKEY(fp));
2305
2306 // the referenced dfunc_T is now used one more time
2307 link_def_function(fp);
2308
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002309 // Create a partial to store the context of the function where it was
2310 // instantiated. Only needs to be done once. Do this on the original
2311 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002312 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2313 {
2314 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2315
2316 if (pt == NULL)
2317 goto failed;
2318 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002319 {
2320 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002321 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002322 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002323 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002324 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002325 }
2326
2327 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002328
2329failed:
2330 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002331 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002332}
2333
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002334static int funcdepth = 0;
2335
2336/*
2337 * Increment the function call depth count.
2338 * Return FAIL when going over 'maxfuncdepth'.
2339 * Otherwise return OK, must call funcdepth_decrement() later!
2340 */
2341 int
2342funcdepth_increment(void)
2343{
2344 if (funcdepth >= p_mfd)
2345 {
2346 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2347 return FAIL;
2348 }
2349 ++funcdepth;
2350 return OK;
2351}
2352
2353 void
2354funcdepth_decrement(void)
2355{
2356 --funcdepth;
2357}
2358
2359/*
2360 * Get the current function call depth.
2361 */
2362 int
2363funcdepth_get(void)
2364{
2365 return funcdepth;
2366}
2367
2368/*
2369 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002370 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002371 * times as funcdepth_increment().
2372 */
2373 void
2374funcdepth_restore(int depth)
2375{
2376 funcdepth = depth;
2377}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002378
2379/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002380 * Call a user function.
2381 */
2382 static void
2383call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002384 ufunc_T *fp, // pointer to function
2385 int argcount, // nr of args
2386 typval_T *argvars, // arguments
2387 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002388 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002389 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002391 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002392 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 funccall_T *fc;
2394 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002395 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002397 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 int i;
2399 int ai;
2400 int islambda = FALSE;
2401 char_u numbuf[NUMBUFLEN];
2402 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002403 typval_T *tv_to_free[MAX_FUNC_ARGS];
2404 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002406 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002408 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409
Bram Moolenaarb2049902021-01-24 12:53:53 +01002410#ifdef FEAT_PROFILE
2411 CLEAR_FIELD(profile_info);
2412#endif
2413
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002414 // If depth of calling is getting too high, don't execute the function.
2415 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002417 rettv->v_type = VAR_NUMBER;
2418 rettv->vval.v_number = -1;
2419 return;
2420 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421
Bram Moolenaare38eab22019-12-05 21:50:01 +01002422 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002424 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002425 if (fc == NULL)
2426 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002427 fc->caller = current_funccal;
2428 current_funccal = fc;
2429 fc->func = fp;
2430 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002431 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002432 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2434 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002435 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002436 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002437 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002439 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002440 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002441#ifdef FEAT_PROFILE
2442 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2443#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002444 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002445#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002446 if (do_profiling == PROF_YES)
2447 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002448#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002449 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002450 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002451#ifdef FEAT_PROFILE
2452 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002453 || (caller != NULL && caller->uf_profiling)))
2454 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002455#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002456 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002457 free_funccal(fc);
2458 return;
2459 }
2460
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2462 islambda = TRUE;
2463
2464 /*
2465 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2466 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2467 * each argument variable and saves a lot of time.
2468 */
2469 /*
2470 * Init l: variables.
2471 */
2472 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2473 if (selfdict != NULL)
2474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002475 // Set l:self to "selfdict". Use "name" to avoid a warning from
2476 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477 v = &fc->fixvar[fixvar_idx++].var;
2478 name = v->di_key;
2479 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002480 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2482 v->di_tv.v_type = VAR_DICT;
2483 v->di_tv.v_lock = 0;
2484 v->di_tv.vval.v_dict = selfdict;
2485 ++selfdict->dv_refcount;
2486 }
2487
2488 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002489 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002490 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 * Set a:000 to a list with room for the "..." arguments.
2492 */
2493 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002494 if ((fp->uf_flags & FC_NOARGS) == 0)
2495 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002496 (varnumber_T)(argcount >= fp->uf_args.ga_len
2497 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002498 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002499 if ((fp->uf_flags & FC_NOARGS) == 0)
2500 {
2501 // Use "name" to avoid a warning from some compiler that checks the
2502 // destination size.
2503 v = &fc->fixvar[fixvar_idx++].var;
2504 name = v->di_key;
2505 STRCPY(name, "000");
2506 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2507 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2508 v->di_tv.v_type = VAR_LIST;
2509 v->di_tv.v_lock = VAR_FIXED;
2510 v->di_tv.vval.v_list = &fc->l_varlist;
2511 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002512 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2514 fc->l_varlist.lv_lock = VAR_FIXED;
2515
2516 /*
2517 * Set a:firstline to "firstline" and a:lastline to "lastline".
2518 * Set a:name to named arguments.
2519 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002520 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002522 if ((fp->uf_flags & FC_NOARGS) == 0)
2523 {
2524 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002525 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002526 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002527 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002528 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002529 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 {
2531 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002532 typval_T def_rettv;
2533 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534
2535 ai = i - fp->uf_args.ga_len;
2536 if (ai < 0)
2537 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002538 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 name = FUNCARG(fp, i);
2540 if (islambda)
2541 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002542
2543 // evaluate named argument default expression
2544 isdefault = ai + fp->uf_def_args.ga_len >= 0
2545 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2546 && argvars[i].vval.v_number == VVAL_NONE));
2547 if (isdefault)
2548 {
2549 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002550
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002551 def_rettv.v_type = VAR_NUMBER;
2552 def_rettv.vval.v_number = -1;
2553
2554 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2555 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002556 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002557 {
2558 default_arg_err = 1;
2559 break;
2560 }
2561 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002562 }
2563 else
2564 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002565 if ((fp->uf_flags & FC_NOARGS) != 0)
2566 // Bail out if no a: arguments used (in lambda).
2567 break;
2568
Bram Moolenaare38eab22019-12-05 21:50:01 +01002569 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 sprintf((char *)numbuf, "%d", ai + 1);
2571 name = numbuf;
2572 }
2573 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2574 {
2575 v = &fc->fixvar[fixvar_idx++].var;
2576 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002577 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 }
2579 else
2580 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002581 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582 if (v == NULL)
2583 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002584 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002587 // Note: the values are copied directly to avoid alloc/free.
2588 // "argvars" must have VAR_FIXED for v_lock.
2589 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590 v->di_tv.v_lock = VAR_FIXED;
2591
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002592 if (isdefault)
2593 // Need to free this later, no matter where it's stored.
2594 tv_to_free[tv_to_free_len++] = &v->di_tv;
2595
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002596 if (addlocal)
2597 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002598 // Named arguments should be accessed without the "a:" prefix in
2599 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002600 copy_tv(&v->di_tv, &v->di_tv);
2601 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002603 else
2604 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002605
2606 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2607 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002608 listitem_T *li = &fc->l_listitems[ai];
2609
2610 li->li_tv = argvars[i];
2611 li->li_tv.v_lock = VAR_FIXED;
2612 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 }
2614 }
2615
Bram Moolenaare38eab22019-12-05 21:50:01 +01002616 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002617 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002618
2619 if (fp->uf_flags & FC_SANDBOX)
2620 {
2621 using_sandbox = TRUE;
2622 ++sandbox;
2623 }
2624
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002625 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002626 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002627 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002629 ++no_wait_return;
2630 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002632 smsg(_("calling %s"), SOURCING_NAME);
2633 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002635 char_u buf[MSG_BUF_LEN];
2636 char_u numbuf2[NUMBUFLEN];
2637 char_u *tofree;
2638 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002640 msg_puts("(");
2641 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002643 if (i > 0)
2644 msg_puts(", ");
2645 if (argvars[i].v_type == VAR_NUMBER)
2646 msg_outnum((long)argvars[i].vval.v_number);
2647 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002649 // Do not want errors such as E724 here.
2650 ++emsg_off;
2651 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2652 --emsg_off;
2653 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002654 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002655 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002657 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2658 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002660 msg_puts((char *)s);
2661 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 }
2663 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002665 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002667 msg_puts("\n"); // don't overwrite this either
2668
2669 verbose_leave_scroll();
2670 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002671 }
2672#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002673 if (do_profiling == PROF_YES)
2674 profile_may_start_func(&profile_info, fp,
2675 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676#endif
2677
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002678 save_current_sctx = current_sctx;
2679 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680 save_did_emsg = did_emsg;
2681 did_emsg = FALSE;
2682
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002683 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2684 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002685 else if (islambda)
2686 {
2687 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2688
2689 // A Lambda always has the command "return {expr}". It is much faster
2690 // to evaluate {expr} directly.
2691 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002692 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002693 --ex_nesting_level;
2694 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002695 else
2696 // call do_cmdline() to execute the lines
2697 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2699
2700 --RedrawingDisabled;
2701
Bram Moolenaare38eab22019-12-05 21:50:01 +01002702 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2704 {
2705 clear_tv(rettv);
2706 rettv->v_type = VAR_NUMBER;
2707 rettv->vval.v_number = -1;
2708 }
2709
2710#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002711 if (do_profiling == PROF_YES)
2712 {
2713 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2714
2715 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2716 profile_may_end_func(&profile_info, fp, caller);
2717 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718#endif
2719
Bram Moolenaare38eab22019-12-05 21:50:01 +01002720 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 if (p_verbose >= 12)
2722 {
2723 ++no_wait_return;
2724 verbose_enter_scroll();
2725
2726 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002727 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002729 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 (long)fc->rettv->vval.v_number);
2731 else
2732 {
2733 char_u buf[MSG_BUF_LEN];
2734 char_u numbuf2[NUMBUFLEN];
2735 char_u *tofree;
2736 char_u *s;
2737
Bram Moolenaare38eab22019-12-05 21:50:01 +01002738 // The value may be very long. Skip the middle part, so that we
2739 // have some idea how it starts and ends. smsg() would always
2740 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002741 ++emsg_off;
2742 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2743 --emsg_off;
2744 if (s != NULL)
2745 {
2746 if (vim_strsize(s) > MSG_BUF_CLEN)
2747 {
2748 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2749 s = buf;
2750 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002751 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002752 vim_free(tofree);
2753 }
2754 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002755 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756
2757 verbose_leave_scroll();
2758 --no_wait_return;
2759 }
2760
Bram Moolenaare31ee862020-01-07 20:59:34 +01002761 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002762 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002763 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764#ifdef FEAT_PROFILE
2765 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002766 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002768 if (using_sandbox)
2769 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002771 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 {
2773 ++no_wait_return;
2774 verbose_enter_scroll();
2775
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002776 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002777 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778
2779 verbose_leave_scroll();
2780 --no_wait_return;
2781 }
2782
2783 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002784 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002785 for (i = 0; i < tv_to_free_len; ++i)
2786 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002787 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788}
2789
2790/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002791 * Check the argument count for user function "fp".
2792 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2793 */
2794 int
2795check_user_func_argcount(ufunc_T *fp, int argcount)
2796{
2797 int regular_args = fp->uf_args.ga_len;
2798
2799 if (argcount < regular_args - fp->uf_def_args.ga_len)
2800 return FCERR_TOOFEW;
2801 else if (!has_varargs(fp) && argcount > regular_args)
2802 return FCERR_TOOMANY;
2803 return FCERR_UNKNOWN;
2804}
2805
2806/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002807 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002808 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002809 int
2810call_user_func_check(
2811 ufunc_T *fp,
2812 int argcount,
2813 typval_T *argvars,
2814 typval_T *rettv,
2815 funcexe_T *funcexe,
2816 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002817{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002818 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002819
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002820 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2821 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002822 error = check_user_func_argcount(fp, argcount);
2823 if (error != FCERR_UNKNOWN)
2824 return error;
2825 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002826 error = FCERR_DICT;
2827 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002828 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002829 int did_save_redo = FALSE;
2830 save_redo_T save_redo;
2831
2832 /*
2833 * Call the user function.
2834 * Save and restore search patterns, script variables and
2835 * redo buffer.
2836 */
2837 save_search_patterns();
2838 if (!ins_compl_active())
2839 {
2840 saveRedobuff(&save_redo);
2841 did_save_redo = TRUE;
2842 }
2843 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002844 call_user_func(fp, argcount, argvars, rettv, funcexe,
2845 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002846 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2847 // Function was unreferenced while being used, free it now.
2848 func_clear_free(fp, FALSE);
2849 if (did_save_redo)
2850 restoreRedobuff(&save_redo);
2851 restore_search_patterns();
2852 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002853 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002854 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002855}
2856
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002857static funccal_entry_T *funccal_stack = NULL;
2858
2859/*
2860 * Save the current function call pointer, and set it to NULL.
2861 * Used when executing autocommands and for ":source".
2862 */
2863 void
2864save_funccal(funccal_entry_T *entry)
2865{
2866 entry->top_funccal = current_funccal;
2867 entry->next = funccal_stack;
2868 funccal_stack = entry;
2869 current_funccal = NULL;
2870}
2871
2872 void
2873restore_funccal(void)
2874{
2875 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002876 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002877 else
2878 {
2879 current_funccal = funccal_stack->top_funccal;
2880 funccal_stack = funccal_stack->next;
2881 }
2882}
2883
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002884 funccall_T *
2885get_current_funccal(void)
2886{
2887 return current_funccal;
2888}
2889
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002890/*
2891 * Mark all functions of script "sid" as deleted.
2892 */
2893 void
2894delete_script_functions(int sid)
2895{
2896 hashitem_T *hi;
2897 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002898 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002899 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002900 size_t len;
2901
2902 buf[0] = K_SPECIAL;
2903 buf[1] = KS_EXTRA;
2904 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002905 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002906 len = STRLEN(buf);
2907
Bram Moolenaarce658352020-07-31 23:47:12 +02002908 while (todo > 0)
2909 {
2910 todo = func_hashtab.ht_used;
2911 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2912 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002913 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002914 fp = HI2UF(hi);
2915 if (STRNCMP(fp->uf_name, buf, len) == 0)
2916 {
2917 int changed = func_hashtab.ht_changed;
2918
2919 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002920
2921 if (fp->uf_calls > 0)
2922 {
2923 // Function is executing, don't free it but do remove
2924 // it from the hashtable.
2925 if (func_remove(fp))
2926 fp->uf_refcount--;
2927 }
2928 else
2929 {
2930 func_clear(fp, TRUE);
2931 // When clearing a function another function can be
2932 // cleared as a side effect. When that happens start
2933 // over.
2934 if (changed != func_hashtab.ht_changed)
2935 break;
2936 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002937 }
2938 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002939 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002940 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002941}
2942
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002943#if defined(EXITFREE) || defined(PROTO)
2944 void
2945free_all_functions(void)
2946{
2947 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002948 ufunc_T *fp;
2949 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002950 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002951 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952
Bram Moolenaare38eab22019-12-05 21:50:01 +01002953 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002954 while (current_funccal != NULL)
2955 {
2956 clear_tv(current_funccal->rettv);
2957 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002958 if (current_funccal == NULL && funccal_stack != NULL)
2959 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002960 }
2961
Bram Moolenaare38eab22019-12-05 21:50:01 +01002962 // First clear what the functions contain. Since this may lower the
2963 // reference count of a function, it may also free a function and change
2964 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002965 while (todo > 0)
2966 {
2967 todo = func_hashtab.ht_used;
2968 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2969 if (!HASHITEM_EMPTY(hi))
2970 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002971 // clear the def function index now
2972 fp = HI2UF(hi);
2973 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002974 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002975
Bram Moolenaare38eab22019-12-05 21:50:01 +01002976 // Only free functions that are not refcounted, those are
2977 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002978 if (func_name_refcount(fp->uf_name))
2979 ++skipped;
2980 else
2981 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002982 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002983 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002984 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002985 {
2986 skipped = 0;
2987 break;
2988 }
2989 }
2990 --todo;
2991 }
2992 }
2993
Bram Moolenaare38eab22019-12-05 21:50:01 +01002994 // Now actually free the functions. Need to start all over every time,
2995 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002996 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002997 while (func_hashtab.ht_used > skipped)
2998 {
2999 todo = func_hashtab.ht_used;
3000 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 if (!HASHITEM_EMPTY(hi))
3002 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003003 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003004 // Only free functions that are not refcounted, those are
3005 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003006 fp = HI2UF(hi);
3007 if (func_name_refcount(fp->uf_name))
3008 ++skipped;
3009 else
3010 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003011 if (func_free(fp, FALSE) == OK)
3012 {
3013 skipped = 0;
3014 break;
3015 }
3016 // did not actually free it
3017 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003018 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003020 }
3021 if (skipped == 0)
3022 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023
3024 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025}
3026#endif
3027
3028/*
3029 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003030 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031 * "len" is the length of "name", or -1 for NUL terminated.
3032 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034builtin_function(char_u *name, int len)
3035{
3036 char_u *p;
3037
Bram Moolenaara26b9702020-04-18 19:53:28 +02003038 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 return FALSE;
3040 p = vim_strchr(name, AUTOLOAD_CHAR);
3041 return p == NULL || (len > 0 && p > name + len);
3042}
3043
3044 int
3045func_call(
3046 char_u *name,
3047 typval_T *args,
3048 partial_T *partial,
3049 dict_T *selfdict,
3050 typval_T *rettv)
3051{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003052 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 listitem_T *item;
3054 typval_T argv[MAX_FUNC_ARGS + 1];
3055 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056 int r = 0;
3057
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003058 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003059 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 {
3061 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3062 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003063 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003064 break;
3065 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003066 // Make a copy of each argument. This is needed to be able to set
3067 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 copy_tv(&item->li_tv, &argv[argc++]);
3069 }
3070
3071 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003072 {
3073 funcexe_T funcexe;
3074
Bram Moolenaara80faa82020-04-12 19:37:17 +02003075 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003076 funcexe.firstline = curwin->w_cursor.lnum;
3077 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003078 funcexe.evaluate = TRUE;
3079 funcexe.partial = partial;
3080 funcexe.selfdict = selfdict;
3081 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3082 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003083
Bram Moolenaare38eab22019-12-05 21:50:01 +01003084 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085 while (argc > 0)
3086 clear_tv(&argv[--argc]);
3087
3088 return r;
3089}
3090
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003091static int callback_depth = 0;
3092
3093 int
3094get_callback_depth(void)
3095{
3096 return callback_depth;
3097}
3098
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003100 * Invoke call_func() with a callback.
3101 */
3102 int
3103call_callback(
3104 callback_T *callback,
3105 int len, // length of "name" or -1 to use strlen()
3106 typval_T *rettv, // return value goes here
3107 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003108 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003109 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003110{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003111 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003112 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003113
Bram Moolenaara80faa82020-04-12 19:37:17 +02003114 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003115 funcexe.evaluate = TRUE;
3116 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003117 ++callback_depth;
3118 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3119 --callback_depth;
3120 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003121}
3122
3123/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003124 * Give an error message for the result of a function.
3125 * Nothing if "error" is FCERR_NONE.
3126 */
3127 void
3128user_func_error(int error, char_u *name)
3129{
3130 switch (error)
3131 {
3132 case FCERR_UNKNOWN:
3133 emsg_funcname(e_unknownfunc, name);
3134 break;
3135 case FCERR_NOTMETHOD:
3136 emsg_funcname(
3137 N_("E276: Cannot use function as a method: %s"), name);
3138 break;
3139 case FCERR_DELETED:
3140 emsg_funcname(N_(e_func_deleted), name);
3141 break;
3142 case FCERR_TOOMANY:
3143 emsg_funcname((char *)e_toomanyarg, name);
3144 break;
3145 case FCERR_TOOFEW:
3146 emsg_funcname((char *)e_toofewarg, name);
3147 break;
3148 case FCERR_SCRIPT:
3149 emsg_funcname(
3150 N_("E120: Using <SID> not in a script context: %s"), name);
3151 break;
3152 case FCERR_DICT:
3153 emsg_funcname(
3154 N_("E725: Calling dict function without Dictionary: %s"),
3155 name);
3156 break;
3157 }
3158}
3159
3160/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003162 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163 * Return FAIL when the function can't be called, OK otherwise.
3164 * Also returns OK when an error was encountered while executing the function.
3165 */
3166 int
3167call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003168 char_u *funcname, // name of the function
3169 int len, // length of "name" or -1 to use strlen()
3170 typval_T *rettv, // return value goes here
3171 int argcount_in, // number of "argvars"
3172 typval_T *argvars_in, // vars for arguments, must have "argcount"
3173 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003174 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175{
3176 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003177 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003179 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 char_u fname_buf[FLEN_FIXED + 1];
3181 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003182 char_u *fname = NULL;
3183 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 int argcount = argcount_in;
3185 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003186 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003187 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3188 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003189 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003190 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003191 partial_T *partial = funcexe->partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003192 type_T check_type;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003193
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003194 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3195 // even when call_func() returns FAIL.
3196 rettv->v_type = VAR_UNKNOWN;
3197
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003198 if (partial != NULL)
3199 fp = partial->pt_func;
3200 if (fp == NULL)
3201 {
3202 // Make a copy of the name, if it comes from a funcref variable it
3203 // could be changed or deleted in the called function.
3204 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3205 if (name == NULL)
3206 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003208 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3209 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003211 if (funcexe->doesrange != NULL)
3212 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213
3214 if (partial != NULL)
3215 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003216 // When the function has a partial with a dict and there is a dict
3217 // argument, use the dict argument. That is backwards compatible.
3218 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003219 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003221 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003222 {
3223 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003224 {
3225 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3226 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003227 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003228 goto theend;
3229 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003231 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 for (i = 0; i < argcount_in; ++i)
3233 argv[i + argv_clear] = argvars_in[i];
3234 argvars = argv;
3235 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003236
Bram Moolenaar22f85d02021-07-04 23:29:30 +02003237 if (funcexe->check_type != NULL
3238 && funcexe->check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003239 {
3240 // Now funcexe->check_type is missing the added arguments, make
3241 // a copy of the type with the correction.
3242 check_type = *funcexe->check_type;
3243 funcexe->check_type = &check_type;
3244 check_type.tt_argcount += partial->pt_argc;
3245 check_type.tt_min_argcount += partial->pt_argc;
3246 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247 }
3248 }
3249
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003250 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3251 {
3252 // Check that the argument types are OK for the types of the funcref.
3253 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003254 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003255 error = FCERR_OTHER;
3256 }
3257
Bram Moolenaaref140542019-12-31 21:27:13 +01003258 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 {
3260 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003261 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003262
Bram Moolenaar333894b2020-08-01 18:53:07 +02003263 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003264 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003265 {
3266 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003268 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269
Bram Moolenaare38eab22019-12-05 21:50:01 +01003270 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003272 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003274 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 {
3276 /*
3277 * User defined function.
3278 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003279 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003280 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281
Bram Moolenaare38eab22019-12-05 21:50:01 +01003282 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003283 if (fp == NULL
3284 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003285 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 && !aborting())
3287 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003288 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003289 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003290 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003291 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3293 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003294 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003295 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003297 if (fp == NULL)
3298 {
3299 char_u *p = untrans_function_name(rfname);
3300
3301 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003302 // Don't do this if the name starts with "s:".
3303 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003304 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003305 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003307 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003308 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003309#ifdef FEAT_LUA
3310 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3311 {
3312 cfunc_T cb = fp->uf_cb;
3313
3314 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3315 }
3316#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003317 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003319 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003320 // postponed filling in the arguments, do it now
3321 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003322 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003323
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003324 if (funcexe->basetv != NULL)
3325 {
3326 // Method call: base->Method()
3327 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3328 argv[0] = *funcexe->basetv;
3329 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003330 argvars = argv;
3331 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003332 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003333
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003334 error = call_user_func_check(fp, argcount, argvars, rettv,
3335 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 }
3337 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003338 else if (funcexe->basetv != NULL)
3339 {
3340 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003341 * expr->method(): Find the method name in the table, call its
3342 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003343 */
3344 error = call_internal_method(fname, argcount, argvars, rettv,
3345 funcexe->basetv);
3346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 else
3348 {
3349 /*
3350 * Find the function name in the table, call its implementation.
3351 */
3352 error = call_internal_func(fname, argcount, argvars, rettv);
3353 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003354
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355 /*
3356 * The function call (or "FuncUndefined" autocommand sequence) might
3357 * have been aborted by an error, an interrupt, or an explicitly thrown
3358 * exception that has not been caught so far. This situation can be
3359 * tested for by calling aborting(). For an error in an internal
3360 * function or for the "E132" error in call_user_func(), however, the
3361 * throw point at which the "force_abort" flag (temporarily reset by
3362 * emsg()) is normally updated has not been reached yet. We need to
3363 * update that flag first to make aborting() reliable.
3364 */
3365 update_force_abort();
3366 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003367 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 ret = OK;
3369
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003370theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 /*
3372 * Report an error unless the argument evaluation or function call has been
3373 * cancelled due to an aborting error, an interrupt, or an exception.
3374 */
3375 if (!aborting())
3376 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003377 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 }
3379
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003380 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003382 clear_tv(&argv[--argv_clear + argv_base]);
3383
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 vim_free(tofree);
3385 vim_free(name);
3386
3387 return ret;
3388}
3389
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003390 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003391printable_func_name(ufunc_T *fp)
3392{
3393 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3394}
3395
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003397 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 */
3399 static void
3400list_func_head(ufunc_T *fp, int indent)
3401{
3402 int j;
3403
3404 msg_start();
3405 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003406 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003407 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003408 msg_puts("def ");
3409 else
3410 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003411 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412 msg_putchar('(');
3413 for (j = 0; j < fp->uf_args.ga_len; ++j)
3414 {
3415 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003416 msg_puts(", ");
3417 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418 if (fp->uf_arg_types != NULL)
3419 {
3420 char *tofree;
3421
3422 msg_puts(": ");
3423 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3424 vim_free(tofree);
3425 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003426 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3427 {
3428 msg_puts(" = ");
3429 msg_puts(((char **)(fp->uf_def_args.ga_data))
3430 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 }
3433 if (fp->uf_varargs)
3434 {
3435 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003436 msg_puts(", ");
3437 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003439 if (fp->uf_va_name != NULL)
3440 {
3441 if (j)
3442 msg_puts(", ");
3443 msg_puts("...");
3444 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003445 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003446 {
3447 char *tofree;
3448
3449 msg_puts(": ");
3450 msg_puts(type_name(fp->uf_va_type, &tofree));
3451 vim_free(tofree);
3452 }
3453 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003455
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003456 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003457 {
3458 if (fp->uf_ret_type != &t_void)
3459 {
3460 char *tofree;
3461
3462 msg_puts(": ");
3463 msg_puts(type_name(fp->uf_ret_type, &tofree));
3464 vim_free(tofree);
3465 }
3466 }
3467 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003468 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003469 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003470 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003472 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003473 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003474 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 msg_clr_eos();
3476 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003477 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478}
3479
3480/*
3481 * Get a function name, translating "<SID>" and "<SNR>".
3482 * Also handles a Funcref in a List or Dictionary.
3483 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003484 * Set "*is_global" to TRUE when the function must be global, unless
3485 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 * flags:
3487 * TFN_INT: internal function name OK
3488 * TFN_QUIET: be quiet
3489 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003490 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003491 * Advances "pp" to just after the function name (if no error).
3492 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003493 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003494trans_function_name(
3495 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003496 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003497 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003499 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003500 partial_T **partial, // return: partial of a FuncRef
3501 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502{
3503 char_u *name = NULL;
3504 char_u *start;
3505 char_u *end;
3506 int lead;
3507 char_u sid_buf[20];
3508 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003509 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003511 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003512 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513
3514 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003515 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 start = *pp;
3517
Bram Moolenaare38eab22019-12-05 21:50:01 +01003518 // Check for hard coded <SNR>: already translated function ID (from a user
3519 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3521 && (*pp)[2] == (int)KE_SNR)
3522 {
3523 *pp += 3;
3524 len = get_id_len(pp) + 3;
3525 return vim_strnsave(start, len);
3526 }
3527
Bram Moolenaare38eab22019-12-05 21:50:01 +01003528 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3529 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 lead = eval_fname_script(start);
3531 if (lead > 2)
3532 start += lead;
3533
Bram Moolenaare38eab22019-12-05 21:50:01 +01003534 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003535 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 lead > 2 ? 0 : FNE_CHECK_START);
3537 if (end == start)
3538 {
3539 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003540 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 goto theend;
3542 }
3543 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3544 {
3545 /*
3546 * Report an invalid expression in braces, unless the expression
3547 * evaluation has been cancelled due to an aborting error, an
3548 * interrupt, or an exception.
3549 */
3550 if (!aborting())
3551 {
3552 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003553 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 }
3555 else
3556 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3557 goto theend;
3558 }
3559
3560 if (lv.ll_tv != NULL)
3561 {
3562 if (fdp != NULL)
3563 {
3564 fdp->fd_dict = lv.ll_dict;
3565 fdp->fd_newkey = lv.ll_newkey;
3566 lv.ll_newkey = NULL;
3567 fdp->fd_di = lv.ll_di;
3568 }
3569 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3570 {
3571 name = vim_strsave(lv.ll_tv->vval.v_string);
3572 *pp = end;
3573 }
3574 else if (lv.ll_tv->v_type == VAR_PARTIAL
3575 && lv.ll_tv->vval.v_partial != NULL)
3576 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003577 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 *pp = end;
3579 if (partial != NULL)
3580 *partial = lv.ll_tv->vval.v_partial;
3581 }
3582 else
3583 {
3584 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3585 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003586 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 else
3588 *pp = end;
3589 name = NULL;
3590 }
3591 goto theend;
3592 }
3593
3594 if (lv.ll_name == NULL)
3595 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003596 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 *pp = end;
3598 goto theend;
3599 }
3600
Bram Moolenaare38eab22019-12-05 21:50:01 +01003601 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 if (lv.ll_exp_name != NULL)
3603 {
3604 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003605 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003606 flags & TFN_NO_AUTOLOAD);
3607 if (name == lv.ll_exp_name)
3608 name = NULL;
3609 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003610 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 {
3612 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003613 name = deref_func_name(*pp, &len, partial, type,
3614 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003615 if (name == *pp)
3616 name = NULL;
3617 }
3618 if (name != NULL)
3619 {
3620 name = vim_strsave(name);
3621 *pp = end;
3622 if (STRNCMP(name, "<SNR>", 5) == 0)
3623 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003624 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 name[0] = K_SPECIAL;
3626 name[1] = KS_EXTRA;
3627 name[2] = (int)KE_SNR;
3628 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3629 }
3630 goto theend;
3631 }
3632
3633 if (lv.ll_exp_name != NULL)
3634 {
3635 len = (int)STRLEN(lv.ll_exp_name);
3636 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3637 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3638 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // When there was "s:" already or the name expanded to get a
3640 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 lv.ll_name += 2;
3642 len -= 2;
3643 lead = 2;
3644 }
3645 }
3646 else
3647 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003648 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003650 {
3651 if (is_global != NULL && lv.ll_name[0] == 'g')
3652 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003654 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 len = (int)(end - lv.ll_name);
3656 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003657 if (len <= 0)
3658 {
3659 if (!skip)
3660 emsg(_(e_function_name));
3661 goto theend;
3662 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003664 // In Vim9 script a user function is script-local by default, unless it
3665 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003666 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003667 if (vim9script)
3668 {
3669 char_u *p;
3670
3671 // SomeScript#func() is a global function.
3672 for (p = start; *p != NUL && *p != '('; ++p)
3673 if (*p == AUTOLOAD_CHAR)
3674 vim9script = FALSE;
3675 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 /*
3678 * Copy the function name to allocated memory.
3679 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3680 * Accept <SNR>123_name() outside a script.
3681 */
3682 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003683 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003684 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003686 if (!vim9script)
3687 lead = 3;
3688 if (vim9script || (lv.ll_exp_name != NULL
3689 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690 || eval_fname_sid(*pp))
3691 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003692 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003693 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003695 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 goto theend;
3697 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003698 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003699 if (vim9script)
3700 extra = 3 + (int)STRLEN(sid_buf);
3701 else
3702 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 }
3704 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003705 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3706 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003708 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 start);
3710 goto theend;
3711 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003712 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 {
3714 char_u *cp = vim_strchr(lv.ll_name, ':');
3715
3716 if (cp != NULL && cp < end)
3717 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003718 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719 goto theend;
3720 }
3721 }
3722
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003723 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 if (name != NULL)
3725 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003726 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 {
3728 name[0] = K_SPECIAL;
3729 name[1] = KS_EXTRA;
3730 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003731 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732 STRCPY(name + 3, sid_buf);
3733 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003734 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3735 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736 }
3737 *pp = end;
3738
3739theend:
3740 clear_lval(&lv);
3741 return name;
3742}
3743
3744/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003745 * Assuming "name" is the result of trans_function_name() and it was prefixed
3746 * to use the script-local name, return the unmodified name (points into
3747 * "name"). Otherwise return NULL.
3748 * This can be used to first search for a script-local function and fall back
3749 * to the global function if not found.
3750 */
3751 char_u *
3752untrans_function_name(char_u *name)
3753{
3754 char_u *p;
3755
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003756 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003757 {
3758 p = vim_strchr(name, '_');
3759 if (p != NULL)
3760 return p + 1;
3761 }
3762 return NULL;
3763}
3764
3765/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003766 * List functions. When "regmatch" is NULL all of then.
3767 * Otherwise functions matching "regmatch".
3768 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003769 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003770list_functions(regmatch_T *regmatch)
3771{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003772 int changed = func_hashtab.ht_changed;
3773 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003774 hashitem_T *hi;
3775
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003776 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003777 {
3778 if (!HASHITEM_EMPTY(hi))
3779 {
3780 ufunc_T *fp = HI2UF(hi);
3781
3782 --todo;
3783 if ((fp->uf_flags & FC_DEAD) == 0
3784 && (regmatch == NULL
3785 ? !message_filtered(fp->uf_name)
3786 && !func_name_refcount(fp->uf_name)
3787 : !isdigit(*fp->uf_name)
3788 && vim_regexec(regmatch, fp->uf_name, 0)))
3789 {
3790 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003791 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003792 {
3793 emsg(_("E454: function list was modified"));
3794 return;
3795 }
3796 }
3797 }
3798 }
3799}
3800
3801/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003802 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003803 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3804 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003805 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003807 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003808define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003810 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 int j;
3812 int c;
3813 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003814 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003815 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 char_u *p;
3817 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003818 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 char_u *line_arg = NULL;
3820 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003821 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003822 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 garray_T newlines;
3824 int varargs = FALSE;
3825 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003826 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003827 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003828 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 dictitem_T *v;
3830 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003831 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003834 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003835 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003836 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837
3838 /*
3839 * ":function" without argument: list functions.
3840 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003841 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 {
3843 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003844 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003846 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 }
3848
3849 /*
3850 * ":function /pat": list functions matching pattern.
3851 */
3852 if (*eap->arg == '/')
3853 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003854 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 if (!eap->skip)
3856 {
3857 regmatch_T regmatch;
3858
3859 c = *p;
3860 *p = NUL;
3861 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3862 *p = c;
3863 if (regmatch.regprog != NULL)
3864 {
3865 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003866 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 vim_regfree(regmatch.regprog);
3868 }
3869 }
3870 if (*p == '/')
3871 ++p;
3872 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003873 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874 }
3875
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003876 ga_init(&newargs);
3877 ga_init(&argtypes);
3878 ga_init(&default_args);
3879
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003880 /*
3881 * Get the function name. There are these situations:
3882 * func normal function name
3883 * "name" == func, "fudi.fd_dict" == NULL
3884 * dict.func new dictionary entry
3885 * "name" == NULL, "fudi.fd_dict" set,
3886 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3887 * dict.func existing dict entry with a Funcref
3888 * "name" == func, "fudi.fd_dict" set,
3889 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3890 * dict.func existing dict entry that's not a Funcref
3891 * "name" == NULL, "fudi.fd_dict" set,
3892 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3893 * s:func script-local function name
3894 * g:func global function name, same as "func"
3895 */
3896 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003897 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003898 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003899 // nested function, argument is (args).
3900 paren = TRUE;
3901 CLEAR_FIELD(fudi);
3902 }
3903 else
3904 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003905 if (STRNCMP(p, "<lambda>", 8) == 0)
3906 {
3907 p += 8;
3908 (void)getdigits(&p);
3909 name = vim_strnsave(eap->arg, p - eap->arg);
3910 CLEAR_FIELD(fudi);
3911 }
3912 else
3913 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003914 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003915 paren = (vim_strchr(p, '(') != NULL);
3916 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003918 /*
3919 * Return on an invalid expression in braces, unless the expression
3920 * evaluation has been cancelled due to an aborting error, an
3921 * interrupt, or an exception.
3922 */
3923 if (!aborting())
3924 {
3925 if (!eap->skip && fudi.fd_newkey != NULL)
3926 semsg(_(e_dictkey), fudi.fd_newkey);
3927 vim_free(fudi.fd_newkey);
3928 return NULL;
3929 }
3930 else
3931 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 }
3934
Bram Moolenaare38eab22019-12-05 21:50:01 +01003935 // An error in a function call during evaluation of an expression in magic
3936 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937 saved_did_emsg = did_emsg;
3938 did_emsg = FALSE;
3939
3940 /*
3941 * ":function func" with only function name: list function.
3942 */
3943 if (!paren)
3944 {
3945 if (!ends_excmd(*skipwhite(p)))
3946 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003947 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 goto ret_free;
3949 }
3950 eap->nextcmd = check_nextcmd(p);
3951 if (eap->nextcmd != NULL)
3952 *p = NUL;
3953 if (!eap->skip && !got_int)
3954 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003955 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003956 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3957 {
3958 char_u *up = untrans_function_name(name);
3959
3960 // With Vim9 script the name was made script-local, if not
3961 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003962 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003963 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003964 }
3965
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 if (fp != NULL)
3967 {
3968 list_func_head(fp, TRUE);
3969 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3970 {
3971 if (FUNCLINE(fp, j) == NULL)
3972 continue;
3973 msg_putchar('\n');
3974 msg_outnum((long)(j + 1));
3975 if (j < 9)
3976 msg_putchar(' ');
3977 if (j < 99)
3978 msg_putchar(' ');
3979 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003980 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 ui_breakcheck();
3982 }
3983 if (!got_int)
3984 {
3985 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003986 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003987 msg_puts(" enddef");
3988 else
3989 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 }
3991 }
3992 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003993 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 }
3995 goto ret_free;
3996 }
3997
3998 /*
3999 * ":function name(arg1, arg2)" Define function.
4000 */
4001 p = skipwhite(p);
4002 if (*p != '(')
4003 {
4004 if (!eap->skip)
4005 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004006 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007 goto ret_free;
4008 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004009 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 if (vim_strchr(p, '(') != NULL)
4011 p = vim_strchr(p, '(');
4012 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004013
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004014 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4015 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004016 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004017 goto ret_free;
4018 }
4019
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004020 // In Vim9 script only global functions can be redefined.
4021 if (vim9script && eap->forceit && !is_global)
4022 {
4023 emsg(_(e_nobang));
4024 goto ret_free;
4025 }
4026
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004027 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028
Bram Moolenaar04b12692020-05-04 23:24:44 +02004029 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004031 // Check the name of the function. Unless it's a dictionary function
4032 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 if (name != NULL)
4034 arg = name;
4035 else
4036 arg = fudi.fd_newkey;
4037 if (arg != NULL && (fudi.fd_di == NULL
4038 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4039 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4040 {
4041 if (*arg == K_SPECIAL)
4042 j = 3;
4043 else
4044 j = 0;
4045 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
4046 : eval_isnamec(arg[j])))
4047 ++j;
4048 if (arg[j] != NUL)
4049 emsg_funcname((char *)e_invarg2, arg);
4050 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004051 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004053 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 }
4055
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004056 // This may get more lines and make the pointers into the first line
4057 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004058 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004059 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004060 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004061 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004062 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004064 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004066 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004068 // find the return type: :def Func(): type
4069 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004071 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004072 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004073 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004074 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004075 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004076 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004077 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004078 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004079 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004080 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004081 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004082 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004083 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004085 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004087 else
4088 // find extra arguments "range", "dict", "abort" and "closure"
4089 for (;;)
4090 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004091 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004092 p = skipwhite(p);
4093 if (STRNCMP(p, "range", 5) == 0)
4094 {
4095 flags |= FC_RANGE;
4096 p += 5;
4097 }
4098 else if (STRNCMP(p, "dict", 4) == 0)
4099 {
4100 flags |= FC_DICT;
4101 p += 4;
4102 }
4103 else if (STRNCMP(p, "abort", 5) == 0)
4104 {
4105 flags |= FC_ABORT;
4106 p += 5;
4107 }
4108 else if (STRNCMP(p, "closure", 7) == 0)
4109 {
4110 flags |= FC_CLOSURE;
4111 p += 7;
4112 if (current_funccal == NULL)
4113 {
4114 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4115 name == NULL ? (char_u *)"" : name);
4116 goto erret;
4117 }
4118 }
4119 else
4120 break;
4121 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004122
Bram Moolenaare38eab22019-12-05 21:50:01 +01004123 // When there is a line break use what follows for the function body.
4124 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004125 if (*p == '\n')
4126 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004127 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004128 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4129 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004130 && !(VIM_ISWHITE(*whitep) && *p == '#'
4131 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004132 && !eap->skip
4133 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004134 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135
4136 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004137 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4138 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 */
4140 if (KeyTyped)
4141 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004142 // Check if the function already exists, don't let the user type the
4143 // whole function before telling him it doesn't work! For a script we
4144 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 if (!eap->skip && !eap->forceit)
4146 {
4147 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004148 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004149 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 emsg_funcname(e_funcexts, name);
4151 }
4152
4153 if (!eap->skip && did_emsg)
4154 goto erret;
4155
Bram Moolenaare38eab22019-12-05 21:50:01 +01004156 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004157 cmdline_row = msg_row;
4158 }
4159
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004160 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004161 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004162
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004163 // Do not define the function when getting the body fails and when
4164 // skipping.
4165 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4166 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 goto erret;
4168
4169 /*
4170 * If there are no errors, add the function
4171 */
4172 if (fudi.fd_dict == NULL)
4173 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004174 hashtab_T *ht;
4175
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004176 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4178 {
4179 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4180 name);
4181 goto erret;
4182 }
4183
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004184 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004185 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004187 char_u *uname = untrans_function_name(name);
4188
4189 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4190 }
4191
4192 if (fp != NULL || import != NULL)
4193 {
4194 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004195
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004196 // Function can be replaced with "function!" and when sourcing the
4197 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004198 // A name that is used by an import can not be overruled.
4199 if (import != NULL
4200 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004201 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004202 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004204 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004205 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004206 else
4207 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 goto erret;
4209 }
4210 if (fp->uf_calls > 0)
4211 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004212 emsg_funcname(
4213 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 name);
4215 goto erret;
4216 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004217 if (fp->uf_refcount > 1)
4218 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004219 // This function is referenced somewhere, don't redefine it but
4220 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004221 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004222 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004223 fp = NULL;
4224 overwrite = TRUE;
4225 }
4226 else
4227 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004228 char_u *exp_name = fp->uf_name_exp;
4229
4230 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004231 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004232 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004233 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004234 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004235 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004236#ifdef FEAT_PROFILE
4237 fp->uf_profiling = FALSE;
4238 fp->uf_prof_initialized = FALSE;
4239#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004240 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004241 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242 }
4243 }
4244 else
4245 {
4246 char numbuf[20];
4247
4248 fp = NULL;
4249 if (fudi.fd_newkey == NULL && !eap->forceit)
4250 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004251 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 goto erret;
4253 }
4254 if (fudi.fd_di == NULL)
4255 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004256 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004257 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 goto erret;
4259 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004261 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004262 goto erret;
4263
Bram Moolenaare38eab22019-12-05 21:50:01 +01004264 // Give the function a sequential number. Can only be used with a
4265 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 vim_free(name);
4267 sprintf(numbuf, "%d", ++func_nr);
4268 name = vim_strsave((char_u *)numbuf);
4269 if (name == NULL)
4270 goto erret;
4271 }
4272
4273 if (fp == NULL)
4274 {
4275 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4276 {
4277 int slen, plen;
4278 char_u *scriptname;
4279
Bram Moolenaare38eab22019-12-05 21:50:01 +01004280 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004282 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283 {
4284 scriptname = autoload_name(name);
4285 if (scriptname != NULL)
4286 {
4287 p = vim_strchr(scriptname, '/');
4288 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004289 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004291 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 j = OK;
4293 vim_free(scriptname);
4294 }
4295 }
4296 if (j == FAIL)
4297 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004298 linenr_T save_lnum = SOURCING_LNUM;
4299
4300 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004301 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004302 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 goto erret;
4304 }
4305 }
4306
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004307 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 if (fp == NULL)
4309 goto erret;
4310
4311 if (fudi.fd_dict != NULL)
4312 {
4313 if (fudi.fd_di == NULL)
4314 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004315 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4317 if (fudi.fd_di == NULL)
4318 {
4319 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004320 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 goto erret;
4322 }
4323 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4324 {
4325 vim_free(fudi.fd_di);
4326 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004327 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328 goto erret;
4329 }
4330 }
4331 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004332 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333 clear_tv(&fudi.fd_di->di_tv);
4334 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336
Bram Moolenaare38eab22019-12-05 21:50:01 +01004337 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338 flags |= FC_DICT;
4339 }
4340
Bram Moolenaare38eab22019-12-05 21:50:01 +01004341 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004342 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004343 if (overwrite)
4344 {
4345 hi = hash_find(&func_hashtab, name);
4346 hi->hi_key = UF2HIKEY(fp);
4347 }
4348 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 {
4350 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004351 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 goto erret;
4353 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004354 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 }
4356 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004357 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004358 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004359 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004360
4361 if (eap->cmdidx == CMD_def)
4362 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004363 int lnum_save = SOURCING_LNUM;
4364 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004365
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004366 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004367
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004368 // error messages are for the first function line
4369 SOURCING_LNUM = sourcing_lnum_top;
4370
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004371 // The function may use script variables from the context.
4372 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004373
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004374 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004375 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004376 SOURCING_LNUM = lnum_save;
4377 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004378 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004379 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004380
4381 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004382 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004383 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004384 SOURCING_LNUM = lnum_save;
4385 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004386 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004387 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004388 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004389 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004390 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004391
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004393 if ((flags & FC_CLOSURE) != 0)
4394 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004395 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004396 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004397 }
4398 else
4399 fp->uf_scoped = NULL;
4400
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 if (prof_def_func())
4403 func_do_profile(fp);
4404#endif
4405 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004406 if (sandbox)
4407 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004408 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004409 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 fp->uf_flags = flags;
4411 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004412 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004413 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004414 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004415 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004416 if (is_export)
4417 {
4418 fp->uf_flags |= FC_EXPORT;
4419 // let ex_export() know the export worked.
4420 is_export = FALSE;
4421 }
4422
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004423 if (eap->cmdidx == CMD_def)
4424 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004425 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4426 // :func does not use Vim9 script syntax, even in a Vim9 script file
4427 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004428
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 goto ret_free;
4430
4431erret:
4432 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004433 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004434 if (fp != NULL)
4435 {
4436 ga_init(&fp->uf_args);
4437 ga_init(&fp->uf_def_args);
4438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439errret_2:
4440 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004441 if (fp != NULL)
4442 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004444 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004445 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004447 if (name != name_arg)
4448 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004449 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004451
4452 return fp;
4453}
4454
4455/*
4456 * ":function"
4457 */
4458 void
4459ex_function(exarg_T *eap)
4460{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004461 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004462}
4463
4464/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004465 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004466 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004467 */
4468 void
4469ex_defcompile(exarg_T *eap UNUSED)
4470{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004471 long todo = (long)func_hashtab.ht_used;
4472 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004473 hashitem_T *hi;
4474 ufunc_T *ufunc;
4475
4476 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4477 {
4478 if (!HASHITEM_EMPTY(hi))
4479 {
4480 --todo;
4481 ufunc = HI2UF(hi);
4482 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004483 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4484 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004485 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004486 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004487
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004488 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004489 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004490 // a function has been added or removed, need to start over
4491 todo = (long)func_hashtab.ht_used;
4492 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004493 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004494 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004495 }
4496 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004497 }
4498 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499}
4500
4501/*
4502 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4503 * Return 2 if "p" starts with "s:".
4504 * Return 0 otherwise.
4505 */
4506 int
4507eval_fname_script(char_u *p)
4508{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004509 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4510 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4512 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4513 return 5;
4514 if (p[0] == 's' && p[1] == ':')
4515 return 2;
4516 return 0;
4517}
4518
4519 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004520translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521{
4522 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004523 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004524 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004525}
4526
4527/*
4528 * Return TRUE when "ufunc" has old-style "..." varargs
4529 * or named varargs "...name: type".
4530 */
4531 int
4532has_varargs(ufunc_T *ufunc)
4533{
4534 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535}
4536
4537/*
4538 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004539 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540 */
4541 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004542function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543{
4544 char_u *nm = name;
4545 char_u *p;
4546 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004547 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004548 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004550 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4551 if (no_deref)
4552 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004553 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 nm = skipwhite(nm);
4555
Bram Moolenaare38eab22019-12-05 21:50:01 +01004556 // Only accept "funcname", "funcname ", "funcname (..." and
4557 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004559 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004560 vim_free(p);
4561 return n;
4562}
4563
Bram Moolenaar113e1072019-01-20 15:30:40 +01004564#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 char_u *
4566get_expanded_name(char_u *name, int check)
4567{
4568 char_u *nm = name;
4569 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004570 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004572 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004573 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004575 if (p != NULL && *nm == NUL
4576 && (!check || translated_function_exists(p, is_global)))
4577 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578
4579 vim_free(p);
4580 return NULL;
4581}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004582#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004584/*
4585 * Function given to ExpandGeneric() to obtain the list of user defined
4586 * function names.
4587 */
4588 char_u *
4589get_user_func_name(expand_T *xp, int idx)
4590{
4591 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004592 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 static hashitem_T *hi;
4594 ufunc_T *fp;
4595
4596 if (idx == 0)
4597 {
4598 done = 0;
4599 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004600 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004602 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 {
4604 if (done++ > 0)
4605 ++hi;
4606 while (HASHITEM_EMPTY(hi))
4607 ++hi;
4608 fp = HI2UF(hi);
4609
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004610 // don't show dead, dict and lambda functions
4611 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004612 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004613 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614
4615 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004616 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004617
4618 cat_func_name(IObuff, fp);
4619 if (xp->xp_context != EXPAND_USER_FUNC)
4620 {
4621 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004623 STRCAT(IObuff, ")");
4624 }
4625 return IObuff;
4626 }
4627 return NULL;
4628}
4629
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630/*
4631 * ":delfunction {name}"
4632 */
4633 void
4634ex_delfunction(exarg_T *eap)
4635{
4636 ufunc_T *fp = NULL;
4637 char_u *p;
4638 char_u *name;
4639 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004640 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004641
4642 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004643 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4644 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 vim_free(fudi.fd_newkey);
4646 if (name == NULL)
4647 {
4648 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004649 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 return;
4651 }
4652 if (!ends_excmd(*skipwhite(p)))
4653 {
4654 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004655 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656 return;
4657 }
4658 eap->nextcmd = check_nextcmd(p);
4659 if (eap->nextcmd != NULL)
4660 *p = NUL;
4661
4662 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004663 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664 vim_free(name);
4665
4666 if (!eap->skip)
4667 {
4668 if (fp == NULL)
4669 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004670 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004671 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 return;
4673 }
4674 if (fp->uf_calls > 0)
4675 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004676 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004677 return;
4678 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004679 if (fp->uf_flags & FC_VIM9)
4680 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004681 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004682 return;
4683 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684
4685 if (fudi.fd_dict != NULL)
4686 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004687 // Delete the dict item that refers to the function, it will
4688 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4690 }
4691 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004692 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004693 // A normal function (not a numbered function or lambda) has a
4694 // refcount of 1 for the entry in the hashtable. When deleting
4695 // it and the refcount is more than one, it should be kept.
4696 // A numbered function and lambda should be kept if the refcount is
4697 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004698 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004699 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004700 // Function is still referenced somewhere. Don't free it but
4701 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004702 if (func_remove(fp))
4703 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004704 }
4705 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004706 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 }
4709}
4710
4711/*
4712 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004713 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004714 */
4715 void
4716func_unref(char_u *name)
4717{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004718 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004720 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004722 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004723 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004726 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004728 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004730 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004731}
4732
4733/*
4734 * Unreference a Function: decrement the reference count and free it when it
4735 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004736 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004737 */
4738 void
4739func_ptr_unref(ufunc_T *fp)
4740{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004741 if (fp != NULL && (--fp->uf_refcount <= 0
4742 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4743 && fp->uf_partial->pt_refcount <= 1
4744 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004745 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004746 // Only delete it when it's not being used. Otherwise it's done
4747 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004748 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004749 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 }
4751}
4752
4753/*
4754 * Count a reference to a Function.
4755 */
4756 void
4757func_ref(char_u *name)
4758{
4759 ufunc_T *fp;
4760
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004761 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004763 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004764 if (fp != NULL)
4765 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004766 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004767 // Only give an error for a numbered function.
4768 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004769 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004770}
4771
4772/*
4773 * Count a reference to a Function.
4774 */
4775 void
4776func_ptr_ref(ufunc_T *fp)
4777{
4778 if (fp != NULL)
4779 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780}
4781
4782/*
4783 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4784 * referenced from anywhere that is in use.
4785 */
4786 static int
4787can_free_funccal(funccall_T *fc, int copyID)
4788{
4789 return (fc->l_varlist.lv_copyID != copyID
4790 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004791 && fc->l_avars.dv_copyID != copyID
4792 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793}
4794
4795/*
4796 * ":return [expr]"
4797 */
4798 void
4799ex_return(exarg_T *eap)
4800{
4801 char_u *arg = eap->arg;
4802 typval_T rettv;
4803 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004804 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004805
4806 if (current_funccal == NULL)
4807 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004808 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 return;
4810 }
4811
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004812 CLEAR_FIELD(evalarg);
4813 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4814
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815 if (eap->skip)
4816 ++emsg_skip;
4817
4818 eap->nextcmd = NULL;
4819 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004820 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004821 {
4822 if (!eap->skip)
4823 returning = do_return(eap, FALSE, TRUE, &rettv);
4824 else
4825 clear_tv(&rettv);
4826 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004827 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828 else if (!eap->skip)
4829 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004830 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004831 update_force_abort();
4832
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 /*
4834 * Return unless the expression evaluation has been cancelled due to an
4835 * aborting error, an interrupt, or an exception.
4836 */
4837 if (!aborting())
4838 returning = do_return(eap, FALSE, TRUE, NULL);
4839 }
4840
Bram Moolenaare38eab22019-12-05 21:50:01 +01004841 // When skipping or the return gets pending, advance to the next command
4842 // in this line (!returning). Otherwise, ignore the rest of the line.
4843 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844 if (returning)
4845 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004846 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 eap->nextcmd = check_nextcmd(arg);
4848
4849 if (eap->skip)
4850 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004851 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852}
4853
4854/*
4855 * ":1,25call func(arg1, arg2)" function call.
4856 */
4857 void
4858ex_call(exarg_T *eap)
4859{
4860 char_u *arg = eap->arg;
4861 char_u *startarg;
4862 char_u *name;
4863 char_u *tofree;
4864 int len;
4865 typval_T rettv;
4866 linenr_T lnum;
4867 int doesrange;
4868 int failed = FALSE;
4869 funcdict_T fudi;
4870 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004871 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004872 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873
Bram Moolenaare6b53242020-07-01 17:28:33 +02004874 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 if (eap->skip)
4876 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004877 // trans_function_name() doesn't work well when skipping, use eval0()
4878 // instead to skip to any following command, e.g. for:
4879 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004881 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004882 clear_tv(&rettv);
4883 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004884 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885 return;
4886 }
4887
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004888 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4889 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890 if (fudi.fd_newkey != NULL)
4891 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004892 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004893 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894 vim_free(fudi.fd_newkey);
4895 }
4896 if (tofree == NULL)
4897 return;
4898
Bram Moolenaare38eab22019-12-05 21:50:01 +01004899 // Increase refcount on dictionary, it could get deleted when evaluating
4900 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 if (fudi.fd_dict != NULL)
4902 ++fudi.fd_dict->dv_refcount;
4903
Bram Moolenaare38eab22019-12-05 21:50:01 +01004904 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4905 // contents. For VAR_PARTIAL get its partial, unless we already have one
4906 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004908 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4909 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910
Bram Moolenaare38eab22019-12-05 21:50:01 +01004911 // Skip white space to allow ":call func ()". Not good, but required for
4912 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004914 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915
4916 if (*startarg != '(')
4917 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004918 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 goto end;
4920 }
4921
4922 /*
4923 * When skipping, evaluate the function once, to find the end of the
4924 * arguments.
4925 * When the function takes a range, this is discovered after the first
4926 * call, and the loop is broken.
4927 */
4928 if (eap->skip)
4929 {
4930 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004931 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932 }
4933 else
4934 lnum = eap->line1;
4935 for ( ; lnum <= eap->line2; ++lnum)
4936 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004937 funcexe_T funcexe;
4938
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939 if (!eap->skip && eap->addr_count > 0)
4940 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004941 if (lnum > curbuf->b_ml.ml_line_count)
4942 {
4943 // If the function deleted lines or switched to another buffer
4944 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02004945 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004946 break;
4947 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948 curwin->w_cursor.lnum = lnum;
4949 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951 }
4952 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004953
Bram Moolenaara80faa82020-04-12 19:37:17 +02004954 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004955 funcexe.firstline = eap->line1;
4956 funcexe.lastline = eap->line2;
4957 funcexe.doesrange = &doesrange;
4958 funcexe.evaluate = !eap->skip;
4959 funcexe.partial = partial;
4960 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004961 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004962 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004963 {
4964 failed = TRUE;
4965 break;
4966 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004967 if (has_watchexpr())
4968 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004970 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004971 if (handle_subscript(&arg, &rettv,
4972 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973 {
4974 failed = TRUE;
4975 break;
4976 }
4977
4978 clear_tv(&rettv);
4979 if (doesrange || eap->skip)
4980 break;
4981
Bram Moolenaare38eab22019-12-05 21:50:01 +01004982 // Stop when immediately aborting on error, or when an interrupt
4983 // occurred or an exception was thrown but not caught.
4984 // get_func_tv() returned OK, so that the check for trailing
4985 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004986 if (aborting())
4987 break;
4988 }
4989 if (eap->skip)
4990 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004991 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004992
Bram Moolenaare51bb172020-02-16 19:42:23 +01004993 // When inside :try we need to check for following "| catch".
4994 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004995 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004996 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004997 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004998 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004999 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005000 if (!failed)
5001 {
5002 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02005003 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005 }
5006 else
5007 eap->nextcmd = check_nextcmd(arg);
5008 }
5009
5010end:
5011 dict_unref(fudi.fd_dict);
5012 vim_free(tofree);
5013}
5014
5015/*
5016 * Return from a function. Possibly makes the return pending. Also called
5017 * for a pending return at the ":endtry" or after returning from an extra
5018 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5019 * when called due to a ":return" command. "rettv" may point to a typval_T
5020 * with the return rettv. Returns TRUE when the return can be carried out,
5021 * FALSE when the return gets pending.
5022 */
5023 int
5024do_return(
5025 exarg_T *eap,
5026 int reanimate,
5027 int is_cmd,
5028 void *rettv)
5029{
5030 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005031 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032
5033 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005034 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035 current_funccal->returned = FALSE;
5036
5037 /*
5038 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5039 * not in its finally clause (which then is to be executed next) is found.
5040 * In this case, make the ":return" pending for execution at the ":endtry".
5041 * Otherwise, return normally.
5042 */
5043 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5044 if (idx >= 0)
5045 {
5046 cstack->cs_pending[idx] = CSTP_RETURN;
5047
5048 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005049 // A pending return again gets pending. "rettv" points to an
5050 // allocated variable with the rettv of the original ":return"'s
5051 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052 cstack->cs_rettv[idx] = rettv;
5053 else
5054 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005055 // When undoing a return in order to make it pending, get the stored
5056 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005057 if (reanimate)
5058 rettv = current_funccal->rettv;
5059
5060 if (rettv != NULL)
5061 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005062 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5064 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5065 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005066 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 }
5068 else
5069 cstack->cs_rettv[idx] = NULL;
5070
5071 if (reanimate)
5072 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005073 // The pending return value could be overwritten by a ":return"
5074 // without argument in a finally clause; reset the default
5075 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076 current_funccal->rettv->v_type = VAR_NUMBER;
5077 current_funccal->rettv->vval.v_number = 0;
5078 }
5079 }
5080 report_make_pending(CSTP_RETURN, rettv);
5081 }
5082 else
5083 {
5084 current_funccal->returned = TRUE;
5085
Bram Moolenaare38eab22019-12-05 21:50:01 +01005086 // If the return is carried out now, store the return value. For
5087 // a return immediately after reanimation, the value is already
5088 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 if (!reanimate && rettv != NULL)
5090 {
5091 clear_tv(current_funccal->rettv);
5092 *current_funccal->rettv = *(typval_T *)rettv;
5093 if (!is_cmd)
5094 vim_free(rettv);
5095 }
5096 }
5097
5098 return idx < 0;
5099}
5100
5101/*
5102 * Free the variable with a pending return value.
5103 */
5104 void
5105discard_pending_return(void *rettv)
5106{
5107 free_tv((typval_T *)rettv);
5108}
5109
5110/*
5111 * Generate a return command for producing the value of "rettv". The result
5112 * is an allocated string. Used by report_pending() for verbose messages.
5113 */
5114 char_u *
5115get_return_cmd(void *rettv)
5116{
5117 char_u *s = NULL;
5118 char_u *tofree = NULL;
5119 char_u numbuf[NUMBUFLEN];
5120
5121 if (rettv != NULL)
5122 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5123 if (s == NULL)
5124 s = (char_u *)"";
5125
5126 STRCPY(IObuff, ":return ");
5127 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5128 if (STRLEN(s) + 8 >= IOSIZE)
5129 STRCPY(IObuff + IOSIZE - 4, "...");
5130 vim_free(tofree);
5131 return vim_strsave(IObuff);
5132}
5133
5134/*
5135 * Get next function line.
5136 * Called by do_cmdline() to get the next line.
5137 * Returns allocated string, or NULL for end of function.
5138 */
5139 char_u *
5140get_func_line(
5141 int c UNUSED,
5142 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005143 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005144 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145{
5146 funccall_T *fcp = (funccall_T *)cookie;
5147 ufunc_T *fp = fcp->func;
5148 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005149 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150
Bram Moolenaare38eab22019-12-05 21:50:01 +01005151 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 if (fcp->dbg_tick != debug_tick)
5153 {
5154 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005155 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 fcp->dbg_tick = debug_tick;
5157 }
5158#ifdef FEAT_PROFILE
5159 if (do_profiling == PROF_YES)
5160 func_line_end(cookie);
5161#endif
5162
5163 gap = &fp->uf_lines;
5164 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5165 || fcp->returned)
5166 retval = NULL;
5167 else
5168 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005169 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170 while (fcp->linenr < gap->ga_len
5171 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5172 ++fcp->linenr;
5173 if (fcp->linenr >= gap->ga_len)
5174 retval = NULL;
5175 else
5176 {
5177 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005178 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005179#ifdef FEAT_PROFILE
5180 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005181 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005182#endif
5183 }
5184 }
5185
Bram Moolenaare38eab22019-12-05 21:50:01 +01005186 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005187 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005189 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005190 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005191 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005192 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005193 fcp->dbg_tick = debug_tick;
5194 }
5195
5196 return retval;
5197}
5198
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199/*
5200 * Return TRUE if the currently active function should be ended, because a
5201 * return was encountered or an error occurred. Used inside a ":while".
5202 */
5203 int
5204func_has_ended(void *cookie)
5205{
5206 funccall_T *fcp = (funccall_T *)cookie;
5207
Bram Moolenaare38eab22019-12-05 21:50:01 +01005208 // Ignore the "abort" flag if the abortion behavior has been changed due to
5209 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005210 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5211 || fcp->returned);
5212}
5213
5214/*
5215 * return TRUE if cookie indicates a function which "abort"s on errors.
5216 */
5217 int
5218func_has_abort(
5219 void *cookie)
5220{
5221 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5222}
5223
5224
5225/*
5226 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5227 * Don't do this when "Func" is already a partial that was bound
5228 * explicitly (pt_auto is FALSE).
5229 * Changes "rettv" in-place.
5230 * Returns the updated "selfdict_in".
5231 */
5232 dict_T *
5233make_partial(dict_T *selfdict_in, typval_T *rettv)
5234{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005235 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 char_u *tofree = NULL;
5237 ufunc_T *fp;
5238 char_u fname_buf[FLEN_FIXED + 1];
5239 int error;
5240 dict_T *selfdict = selfdict_in;
5241
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005242 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5243 fp = rettv->vval.v_partial->pt_func;
5244 else
5245 {
5246 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5247 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005248 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005249 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005250 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005251 vim_free(tofree);
5252 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005253
5254 if (fp != NULL && (fp->uf_flags & FC_DICT))
5255 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005256 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257
5258 if (pt != NULL)
5259 {
5260 pt->pt_refcount = 1;
5261 pt->pt_dict = selfdict;
5262 pt->pt_auto = TRUE;
5263 selfdict = NULL;
5264 if (rettv->v_type == VAR_FUNC)
5265 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005266 // Just a function: Take over the function name and use
5267 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268 pt->pt_name = rettv->vval.v_string;
5269 }
5270 else
5271 {
5272 partial_T *ret_pt = rettv->vval.v_partial;
5273 int i;
5274
Bram Moolenaare38eab22019-12-05 21:50:01 +01005275 // Partial: copy the function name, use selfdict and copy
5276 // args. Can't take over name or args, the partial might
5277 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005278 if (ret_pt->pt_name != NULL)
5279 {
5280 pt->pt_name = vim_strsave(ret_pt->pt_name);
5281 func_ref(pt->pt_name);
5282 }
5283 else
5284 {
5285 pt->pt_func = ret_pt->pt_func;
5286 func_ptr_ref(pt->pt_func);
5287 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005288 if (ret_pt->pt_argc > 0)
5289 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005290 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005291 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005292 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005293 pt->pt_argc = 0;
5294 else
5295 {
5296 pt->pt_argc = ret_pt->pt_argc;
5297 for (i = 0; i < pt->pt_argc; i++)
5298 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5299 }
5300 }
5301 partial_unref(ret_pt);
5302 }
5303 rettv->v_type = VAR_PARTIAL;
5304 rettv->vval.v_partial = pt;
5305 }
5306 }
5307 return selfdict;
5308}
5309
5310/*
5311 * Return the name of the executed function.
5312 */
5313 char_u *
5314func_name(void *cookie)
5315{
5316 return ((funccall_T *)cookie)->func->uf_name;
5317}
5318
5319/*
5320 * Return the address holding the next breakpoint line for a funccall cookie.
5321 */
5322 linenr_T *
5323func_breakpoint(void *cookie)
5324{
5325 return &((funccall_T *)cookie)->breakpoint;
5326}
5327
5328/*
5329 * Return the address holding the debug tick for a funccall cookie.
5330 */
5331 int *
5332func_dbg_tick(void *cookie)
5333{
5334 return &((funccall_T *)cookie)->dbg_tick;
5335}
5336
5337/*
5338 * Return the nesting level for a funccall cookie.
5339 */
5340 int
5341func_level(void *cookie)
5342{
5343 return ((funccall_T *)cookie)->level;
5344}
5345
5346/*
5347 * Return TRUE when a function was ended by a ":return" command.
5348 */
5349 int
5350current_func_returned(void)
5351{
5352 return current_funccal->returned;
5353}
5354
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005355 int
5356free_unref_funccal(int copyID, int testing)
5357{
5358 int did_free = FALSE;
5359 int did_free_funccal = FALSE;
5360 funccall_T *fc, **pfc;
5361
5362 for (pfc = &previous_funccal; *pfc != NULL; )
5363 {
5364 if (can_free_funccal(*pfc, copyID))
5365 {
5366 fc = *pfc;
5367 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005368 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005369 did_free = TRUE;
5370 did_free_funccal = TRUE;
5371 }
5372 else
5373 pfc = &(*pfc)->caller;
5374 }
5375 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005376 // When a funccal was freed some more items might be garbage
5377 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005378 (void)garbage_collect(testing);
5379
5380 return did_free;
5381}
5382
5383/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005384 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385 */
5386 static funccall_T *
5387get_funccal(void)
5388{
5389 int i;
5390 funccall_T *funccal;
5391 funccall_T *temp_funccal;
5392
5393 funccal = current_funccal;
5394 if (debug_backtrace_level > 0)
5395 {
5396 for (i = 0; i < debug_backtrace_level; i++)
5397 {
5398 temp_funccal = funccal->caller;
5399 if (temp_funccal)
5400 funccal = temp_funccal;
5401 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005402 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005403 debug_backtrace_level = i;
5404 }
5405 }
5406 return funccal;
5407}
5408
5409/*
5410 * Return the hashtable used for local variables in the current funccal.
5411 * Return NULL if there is no current funccal.
5412 */
5413 hashtab_T *
5414get_funccal_local_ht()
5415{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005416 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005417 return NULL;
5418 return &get_funccal()->l_vars.dv_hashtab;
5419}
5420
5421/*
5422 * Return the l: scope variable.
5423 * Return NULL if there is no current funccal.
5424 */
5425 dictitem_T *
5426get_funccal_local_var()
5427{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005428 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005429 return NULL;
5430 return &get_funccal()->l_vars_var;
5431}
5432
5433/*
5434 * Return the hashtable used for argument in the current funccal.
5435 * Return NULL if there is no current funccal.
5436 */
5437 hashtab_T *
5438get_funccal_args_ht()
5439{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005440 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005441 return NULL;
5442 return &get_funccal()->l_avars.dv_hashtab;
5443}
5444
5445/*
5446 * Return the a: scope variable.
5447 * Return NULL if there is no current funccal.
5448 */
5449 dictitem_T *
5450get_funccal_args_var()
5451{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005452 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005454 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005455}
5456
5457/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005458 * List function variables, if there is a function.
5459 */
5460 void
5461list_func_vars(int *first)
5462{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005463 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005464 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005465 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005466}
5467
5468/*
5469 * If "ht" is the hashtable for local variables in the current funccal, return
5470 * the dict that contains it.
5471 * Otherwise return NULL.
5472 */
5473 dict_T *
5474get_current_funccal_dict(hashtab_T *ht)
5475{
5476 if (current_funccal != NULL
5477 && ht == &current_funccal->l_vars.dv_hashtab)
5478 return &current_funccal->l_vars;
5479 return NULL;
5480}
5481
5482/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005483 * Search hashitem in parent scope.
5484 */
5485 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005486find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005487{
5488 funccall_T *old_current_funccal = current_funccal;
5489 hashtab_T *ht;
5490 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005491 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005492
5493 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5494 return NULL;
5495
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005496 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005497 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005498 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005499 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005500 ht = find_var_ht(name, &varname);
5501 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005502 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005503 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005504 if (!HASHITEM_EMPTY(hi))
5505 {
5506 *pht = ht;
5507 break;
5508 }
5509 }
5510 if (current_funccal == current_funccal->func->uf_scoped)
5511 break;
5512 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005513 }
5514 current_funccal = old_current_funccal;
5515
5516 return hi;
5517}
5518
5519/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005520 * Search variable in parent scope.
5521 */
5522 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005523find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005524{
5525 dictitem_T *v = NULL;
5526 funccall_T *old_current_funccal = current_funccal;
5527 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005528 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005529
5530 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5531 return NULL;
5532
Bram Moolenaare38eab22019-12-05 21:50:01 +01005533 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005534 current_funccal = current_funccal->func->uf_scoped;
5535 while (current_funccal)
5536 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005537 ht = find_var_ht(name, &varname);
5538 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005539 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005540 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005541 if (v != NULL)
5542 break;
5543 }
5544 if (current_funccal == current_funccal->func->uf_scoped)
5545 break;
5546 current_funccal = current_funccal->func->uf_scoped;
5547 }
5548 current_funccal = old_current_funccal;
5549
5550 return v;
5551}
5552
5553/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005554 * Set "copyID + 1" in previous_funccal and callers.
5555 */
5556 int
5557set_ref_in_previous_funccal(int copyID)
5558{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005559 funccall_T *fc;
5560
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005561 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005562 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005563 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005564 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5565 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5566 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5567 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005568 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005569 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005570}
5571
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005572 static int
5573set_ref_in_funccal(funccall_T *fc, int copyID)
5574{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005575 if (fc->fc_copyID != copyID)
5576 {
5577 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005578 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5579 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5580 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5581 || set_ref_in_func(NULL, fc->func, copyID))
5582 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005583 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005584 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005585}
5586
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005587/*
5588 * Set "copyID" in all local vars and arguments in the call stack.
5589 */
5590 int
5591set_ref_in_call_stack(int copyID)
5592{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005593 funccall_T *fc;
5594 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005595
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005596 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5597 if (set_ref_in_funccal(fc, copyID))
5598 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005599
5600 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005601 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5602 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5603 if (set_ref_in_funccal(fc, copyID))
5604 return TRUE;
5605 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005606}
5607
5608/*
5609 * Set "copyID" in all functions available by name.
5610 */
5611 int
5612set_ref_in_functions(int copyID)
5613{
5614 int todo;
5615 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005616 ufunc_T *fp;
5617
5618 todo = (int)func_hashtab.ht_used;
5619 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005620 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005621 if (!HASHITEM_EMPTY(hi))
5622 {
5623 --todo;
5624 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005625 if (!func_name_refcount(fp->uf_name)
5626 && set_ref_in_func(NULL, fp, copyID))
5627 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005628 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005629 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005630 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005631}
5632
5633/*
5634 * Set "copyID" in all function arguments.
5635 */
5636 int
5637set_ref_in_func_args(int copyID)
5638{
5639 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005640
5641 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005642 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5643 copyID, NULL, NULL))
5644 return TRUE;
5645 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005646}
5647
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005648/*
5649 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005650 * Returns TRUE if setting references failed somehow.
5651 */
5652 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005653set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005654{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005655 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005656 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005657 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005658 char_u fname_buf[FLEN_FIXED + 1];
5659 char_u *tofree = NULL;
5660 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005661 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005662
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005663 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005664 return FALSE;
5665
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005666 if (fp_in == NULL)
5667 {
5668 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005669 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005670 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005671 if (fp != NULL)
5672 {
5673 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005674 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005675 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005676
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005677 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005678 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005679}
5680
Bram Moolenaare38eab22019-12-05 21:50:01 +01005681#endif // FEAT_EVAL