blob: 8d82beb7eb3a6f8cc16b4d6101c1e7c76bccaf63 [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
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020035
36 void
37func_init()
38{
39 hash_init(&func_hashtab);
40}
41
Dominique Pelle748b3082022-01-08 12:41:16 +000042#if defined(FEAT_PROFILE) || defined(PROTO)
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
Dominique Pelle748b3082022-01-08 12:41:16 +000051#endif
Bram Moolenaar660a10a2019-07-14 15:48:38 +020052
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaardce24412022-02-08 20:35:30 +000058 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000069 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020070 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020075 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000085 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000092 evalarg == NULL ? NULL : evalarg->eval_cctx,
93 eap == NULL ? NULL : eap->cstack, 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 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000117 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200118 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 Moolenaar7473a842021-12-28 17:55:26 +0000171 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000172 * Get a next line, store it in "eap" if appropriate and put the line in
173 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000174 */
175 static char_u *
176get_function_line(
177 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000178 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000179 int indent,
180 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000181{
182 char_u *theline;
183
184 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000185 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000186 else
187 theline = eap->getline(':', eap->cookie, indent, getline_options);
188 if (theline != NULL)
189 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000190 if (lines_to_free->ga_len > 0
191 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
192 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000193 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000194 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000195 }
196
197 return theline;
198}
199
200/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100203 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200204 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100205 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206get_function_args(
207 char_u **argp,
208 char_u endchar,
209 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100210 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100211 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100212 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200213 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200214 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000216 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000217 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218{
219 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100220 char_u *arg;
221 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200223 int any_default = FALSE;
224 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100225 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200226
227 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000228 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200231 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200233
234 if (varargs != NULL)
235 *varargs = FALSE;
236
237 /*
238 * Isolate the arguments: "arg1, arg2, ...)"
239 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100240 arg = skipwhite(*argp);
241 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 while (*p != endchar)
243 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200244 while (eap != NULL && eap->getline != NULL
245 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200247 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000248 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000249 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000250
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 if (theline == NULL)
252 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200253 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200254 p = skipwhite(theline);
255 }
256
257 if (mustend && *p != endchar)
258 {
259 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000260 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100261 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200262 }
263 if (*p == endchar)
264 break;
265
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
267 {
268 if (varargs != NULL)
269 *varargs = TRUE;
270 p += 3;
271 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272
273 if (argtypes != NULL)
274 {
275 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200276 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100278 if (!skip)
279 emsg(_(e_missing_name_after_dots));
280 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100281 }
282
283 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100284 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000285 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 if (p == arg)
287 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100288 if (*skipwhite(p) == '=')
289 {
290 emsg(_(e_cannot_use_default_for_variable_arguments));
291 break;
292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 }
295 else
296 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200297 char_u *np;
298
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100300 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000301 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304
Bram Moolenaar015cf102021-06-26 21:52:02 +0200305 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200306 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200307 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200308 if (*np == '=' && np[1] != '=' && np[1] != '~'
309 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 {
311 typval_T rettv;
312
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100313 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 any_default = TRUE;
315 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200316 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 p = skipwhite(p);
318 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200319 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200323 if (ga_grow(default_args, 1) == FAIL)
324 goto err_ret;
325
326 // trim trailing whitespace
327 while (p > expr && VIM_ISWHITE(p[-1]))
328 p--;
329 c = *p;
330 *p = NUL;
331 expr = vim_strsave(expr);
332 if (expr == NULL)
333 {
334 *p = c;
335 goto err_ret;
336 }
337 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200338 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200339 default_args->ga_len++;
340 *p = c;
341 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200342 }
343 else
344 mustend = TRUE;
345 }
346 else if (any_default)
347 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000348 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200349 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200350 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200351
352 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
353 {
354 // Be tolerant when skipping
355 if (!skip)
356 {
357 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
358 goto err_ret;
359 }
360 p = skipwhite(p);
361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200364 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200365 // Don't give this error when skipping, it makes the "->" not
366 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100367 // Allow missing space after comma in legacy functions.
368 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
370 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100371 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200372 goto err_ret;
373 }
374 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200375 else
376 mustend = TRUE;
377 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200378 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200379 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200380 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200381
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200382 if (*p != endchar)
383 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100384 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200385
386 *argp = p;
387 return OK;
388
389err_ret:
390 if (newargs != NULL)
391 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200392 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200393 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200394 return FAIL;
395}
396
397/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100398 * Parse the argument types, filling "fp->uf_arg_types".
399 * Return OK or FAIL.
400 */
401 static int
402parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
403{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200404 int len = 0;
405
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
407 if (argtypes->ga_len > 0)
408 {
409 // When "varargs" is set the last name/type goes into uf_va_name
410 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200411 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100412
413 if (len > 0)
414 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
415 if (fp->uf_arg_types != NULL)
416 {
417 int i;
418 type_T *type;
419
420 for (i = 0; i < len; ++ i)
421 {
422 char_u *p = ((char_u **)argtypes->ga_data)[i];
423
424 if (p == NULL)
425 // will get the type from the default value
426 type = &t_unknown;
427 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100428 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100429 if (type == NULL)
430 return FAIL;
431 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000432 if (i < fp->uf_args.ga_len
433 && (type->tt_type == VAR_FUNC
434 || type->tt_type == VAR_PARTIAL)
435 && var_wrong_func_name(
436 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
437 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100438 }
439 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100440 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200441
442 if (varargs)
443 {
444 char_u *p;
445
446 // Move the last argument "...name: type" to uf_va_name and
447 // uf_va_type.
448 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
449 [fp->uf_args.ga_len - 1];
450 --fp->uf_args.ga_len;
451 p = ((char_u **)argtypes->ga_data)[len];
452 if (p == NULL)
453 // TODO: get type from default value
454 fp->uf_va_type = &t_list_any;
455 else
456 {
457 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
458 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
459 {
460 semsg(_(e_variable_arguments_type_must_be_list_str),
461 ((char_u **)argtypes->ga_data)[len]);
462 return FAIL;
463 }
464 }
465 if (fp->uf_va_type == NULL)
466 return FAIL;
467 }
468
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100469 return OK;
470}
471
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100472 static int
473parse_return_type(ufunc_T *fp, char_u *ret_type)
474{
475 if (ret_type == NULL)
476 fp->uf_ret_type = &t_void;
477 else
478 {
479 char_u *p = ret_type;
480
481 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
482 if (fp->uf_ret_type == NULL)
483 {
484 fp->uf_ret_type = &t_void;
485 return FAIL;
486 }
487 }
488 return OK;
489}
490
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100491/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 * Register function "fp" as using "current_funccal" as its scope.
493 */
494 static int
495register_closure(ufunc_T *fp)
496{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100498 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200499 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200500 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200501 fp->uf_scoped = current_funccal;
502 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200503
Bram Moolenaar58016442016-07-31 18:30:22 +0200504 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
505 return FAIL;
506 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
507 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200508 return OK;
509}
510
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100511 static void
512set_ufunc_name(ufunc_T *fp, char_u *name)
513{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100514 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
515 // actually extends beyond the struct.
516 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100517
518 if (name[0] == K_SPECIAL)
519 {
520 fp->uf_name_exp = alloc(STRLEN(name) + 3);
521 if (fp->uf_name_exp != NULL)
522 {
523 STRCPY(fp->uf_name_exp, "<SNR>");
524 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
525 }
526 }
527}
528
Bram Moolenaar58016442016-07-31 18:30:22 +0200529/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100530 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
531 * return "buf" filled with a readable function name.
532 * Otherwise just return "name", thus the return value can always be used.
533 * "name" and "buf" may be equal.
534 */
535 char_u *
536make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
537{
538 size_t len;
539
540 if (name[0] != K_SPECIAL)
541 return name;
542 len = STRLEN(name);
543 if (len + 3 > bufsize)
544 return name;
545
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100546 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100547 mch_memmove(buf, "<SNR>", 5);
548 return buf;
549}
550
551/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200552 * Get a name for a lambda. Returned in static memory.
553 */
554 char_u *
555get_lambda_name(void)
556{
557 static char_u name[30];
558 static int lambda_no = 0;
559
560 sprintf((char*)name, "<lambda>%d", ++lambda_no);
561 return name;
562}
563
Bram Moolenaar801ab062020-06-25 19:27:56 +0200564#if defined(FEAT_LUA) || defined(PROTO)
565/*
566 * Registers a native C callback which can be called from Vim script.
567 * Returns the name of the Vim script function.
568 */
569 char_u *
570register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
571{
572 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200573 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200574
575 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
576 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200577 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200578
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200579 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200580 fp->uf_refcount = 1;
581 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000582 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200583 fp->uf_calls = 0;
584 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200585 fp->uf_cb = cb;
586 fp->uf_cb_free = cb_free;
587 fp->uf_cb_state = state;
588
589 set_ufunc_name(fp, name);
590 hash_add(&func_hashtab, UF2HIKEY(fp));
591
592 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200593}
594#endif
595
Bram Moolenaar04b12692020-05-04 23:24:44 +0200596/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100597 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100598 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100599 * If "white_error" is not NULL check for correct use of white space and set
600 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100601 * Return NULL if no valid arrow found.
602 */
603 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100604skip_arrow(
605 char_u *start,
606 int equal_arrow,
607 char_u **ret_type,
608 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100609{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100610 char_u *s = start;
611 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100612
613 if (equal_arrow)
614 {
615 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100616 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100617 if (white_error != NULL && !VIM_ISWHITE(s[1]))
618 {
619 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100620 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100621 return NULL;
622 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100623 s = skipwhite(s + 1);
624 *ret_type = s;
625 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100626 if (s == *ret_type)
627 {
628 emsg(_(e_missing_return_type));
629 return NULL;
630 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100631 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100632 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100633 s = skipwhite(s);
634 if (*s != '=')
635 return NULL;
636 ++s;
637 }
638 if (*s != '>')
639 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100640 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
641 || !IS_WHITE_OR_NUL(s[1])))
642 {
643 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100644 semsg(_(e_white_space_required_before_and_after_str_at_str),
645 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100646 return NULL;
647 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100648 return skipwhite(s + 1);
649}
650
651/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100652 * Check if "*cmd" points to a function command and if so advance "*cmd" and
653 * return TRUE.
654 * Otherwise return FALSE;
655 * Do not consider "function(" to be a command.
656 */
657 static int
658is_function_cmd(char_u **cmd)
659{
660 char_u *p = *cmd;
661
662 if (checkforcmd(&p, "function", 2))
663 {
664 if (*p == '(')
665 return FALSE;
666 *cmd = p;
667 return TRUE;
668 }
669 return FALSE;
670}
671
672/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200673 * Called when defining a function: The context may be needed for script
674 * variables declared in a block that is visible now but not when the function
675 * is compiled or called later.
676 */
677 static void
678function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
679{
680 if (cstack != NULL && cstack->cs_idx >= 0)
681 {
682 int count = cstack->cs_idx + 1;
683 int i;
684
685 fp->uf_block_ids = ALLOC_MULT(int, count);
686 if (fp->uf_block_ids != NULL)
687 {
688 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
689 sizeof(int) * count);
690 fp->uf_block_depth = count;
691 }
692
693 // Set flag in each block to indicate a function was defined. This
694 // is used to keep the variable when leaving the block, see
695 // hide_script_var().
696 for (i = 0; i <= cstack->cs_idx; ++i)
697 cstack->cs_flags[i] |= CSF_FUNC_DEF;
698 }
699}
700
701/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100702 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200703 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100704 * "newlines" must already have been initialized.
705 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
706 */
707 static int
708get_function_body(
709 exarg_T *eap,
710 garray_T *newlines,
711 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000712 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100713{
714 linenr_T sourcing_lnum_top = SOURCING_LNUM;
715 linenr_T sourcing_lnum_off;
716 int saved_wait_return = need_wait_return;
717 char_u *line_arg = line_arg_in;
718 int vim9_function = eap->cmdidx == CMD_def
719 || eap->cmdidx == CMD_block;
720#define MAX_FUNC_NESTING 50
721 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200722 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100723 int nesting = 0;
724 getline_opt_T getline_options;
725 int indent = 2;
726 char_u *skip_until = NULL;
727 int ret = FAIL;
728 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200729 int heredoc_concat_len = 0;
730 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100731 char_u *heredoc_trimmed = NULL;
732
Bram Moolenaar20677332021-06-06 17:02:53 +0200733 ga_init2(&heredoc_ga, 1, 500);
734
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100735 // Detect having skipped over comment lines to find the return
736 // type. Add NULL lines to keep the line count correct.
737 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
738 if (SOURCING_LNUM < sourcing_lnum_off)
739 {
740 sourcing_lnum_off -= SOURCING_LNUM;
741 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
742 goto theend;
743 while (sourcing_lnum_off-- > 0)
744 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
745 }
746
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200747 nesting_def[0] = vim9_function;
748 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100749 getline_options = vim9_function
750 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
751 for (;;)
752 {
753 char_u *theline;
754 char_u *p;
755 char_u *arg;
756
757 if (KeyTyped)
758 {
759 msg_scroll = TRUE;
760 saved_wait_return = FALSE;
761 }
762 need_wait_return = FALSE;
763
764 if (line_arg != NULL)
765 {
766 // Use eap->arg, split up in parts by line breaks.
767 theline = line_arg;
768 p = vim_strchr(theline, '\n');
769 if (p == NULL)
770 line_arg += STRLEN(line_arg);
771 else
772 {
773 *p = NUL;
774 line_arg = p + 1;
775 }
776 }
777 else
778 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000779 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100780 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100781 }
782 if (KeyTyped)
783 lines_left = Rows - 1;
784 if (theline == NULL)
785 {
786 // Use the start of the function for the line number.
787 SOURCING_LNUM = sourcing_lnum_top;
788 if (skip_until != NULL)
789 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200790 else if (nesting_inline[nesting])
791 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100792 else if (eap->cmdidx == CMD_def)
793 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000795 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100796 goto theend;
797 }
798
799 // Detect line continuation: SOURCING_LNUM increased more than one.
800 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
801 if (SOURCING_LNUM < sourcing_lnum_off)
802 sourcing_lnum_off -= SOURCING_LNUM;
803 else
804 sourcing_lnum_off = 0;
805
806 if (skip_until != NULL)
807 {
808 // Don't check for ":endfunc"/":enddef" between
809 // * ":append" and "."
810 // * ":python <<EOF" and "EOF"
811 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
812 if (heredoc_trimmed == NULL
813 || (is_heredoc && skipwhite(theline) == theline)
814 || STRNCMP(theline, heredoc_trimmed,
815 STRLEN(heredoc_trimmed)) == 0)
816 {
817 if (heredoc_trimmed == NULL)
818 p = theline;
819 else if (is_heredoc)
820 p = skipwhite(theline) == theline
821 ? theline : theline + STRLEN(heredoc_trimmed);
822 else
823 p = theline + STRLEN(heredoc_trimmed);
824 if (STRCMP(p, skip_until) == 0)
825 {
826 VIM_CLEAR(skip_until);
827 VIM_CLEAR(heredoc_trimmed);
828 getline_options = vim9_function
829 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
830 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200831
832 if (heredoc_concat_len > 0)
833 {
834 // Replace the starting line with all the concatenated
835 // lines.
836 ga_concat(&heredoc_ga, theline);
837 vim_free(((char_u **)(newlines->ga_data))[
838 heredoc_concat_len - 1]);
839 ((char_u **)(newlines->ga_data))[
840 heredoc_concat_len - 1] = heredoc_ga.ga_data;
841 ga_init(&heredoc_ga);
842 heredoc_concat_len = 0;
843 theline += STRLEN(theline); // skip the "EOF"
844 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100845 }
846 }
847 }
848 else
849 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200850 int c;
851 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000852 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100853
854 // skip ':' and blanks
855 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
856 ;
857
858 // Check for "endfunction", "enddef" or "}".
859 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000860 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200861 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100862 ? *p == '}'
863 : (checkforcmd(&p, nesting_def[nesting]
864 ? "enddef" : "endfunction", 4)
865 && *p != ':'))
866 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000867 if (!nesting_inline[nesting] && nesting_def[nesting]
868 && p < cmd + 6)
869 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100870 if (nesting-- == 0)
871 {
872 char_u *nextcmd = NULL;
873
874 if (*p == '|' || *p == '}')
875 nextcmd = p + 1;
876 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
877 nextcmd = line_arg;
878 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100879 && (vim9_function || p_verbose > 0))
880 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200881 SOURCING_LNUM = sourcing_lnum_top
882 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100883 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000884 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100885 else
886 give_warning2((char_u *)
887 _("W22: Text found after :endfunction: %s"),
888 p, TRUE);
889 }
890 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100891 {
892 // Another command follows. If the line came from "eap"
893 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000894 // change "eap->cmdlinep" to point to the last fetched
895 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100896 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000897 if (lines_to_free->ga_len > 0
898 && *eap->cmdlinep !=
899 ((char_u **)lines_to_free->ga_data)
900 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100901 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000902 // *cmdlinep will be freed later, thus remove the
903 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100904 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000905 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
906 [lines_to_free->ga_len - 1];
907 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100908 }
909 }
910 break;
911 }
912 }
913
914 // Check for mismatched "endfunc" or "enddef".
915 // We don't check for "def" inside "func" thus we also can't check
916 // for "enddef".
917 // We continue to find the end of the function, although we might
918 // not find it.
919 else if (nesting_def[nesting])
920 {
921 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
922 emsg(_(e_mismatched_endfunction));
923 }
924 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
925 emsg(_(e_mismatched_enddef));
926
927 // Increase indent inside "if", "while", "for" and "try", decrease
928 // at "end".
929 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
930 indent -= 2;
931 else if (STRNCMP(p, "if", 2) == 0
932 || STRNCMP(p, "wh", 2) == 0
933 || STRNCMP(p, "for", 3) == 0
934 || STRNCMP(p, "try", 3) == 0)
935 indent += 2;
936
937 // Check for defining a function inside this function.
938 // Only recognize "def" inside "def", not inside "function",
939 // For backwards compatibility, see Test_function_python().
940 c = *p;
941 if (is_function_cmd(&p)
942 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
943 {
944 if (*p == '!')
945 p = skipwhite(p + 1);
946 p += eval_fname_script(p);
947 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
948 NULL, NULL));
949 if (*skipwhite(p) == '(')
950 {
951 if (nesting == MAX_FUNC_NESTING - 1)
952 emsg(_(e_function_nesting_too_deep));
953 else
954 {
955 ++nesting;
956 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200957 nesting_inline[nesting] = FALSE;
958 indent += 2;
959 }
960 }
961 }
962
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200963 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200964 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200965 // Not a comment line: check for nested inline function.
966 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200967 while (end > p && VIM_ISWHITE(*end))
968 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200969 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200970 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200971 int is_block;
972
973 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200974 --end;
975 while (end > p && VIM_ISWHITE(*end))
976 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200977 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
978 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200979 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200980 char_u *s = p;
981
982 // check for line starting with "au" for :autocmd or
983 // "com" for :command, these can use a {} block
984 is_block = checkforcmd_noparen(&s, "autocmd", 2)
985 || checkforcmd_noparen(&s, "command", 3);
986 }
987
988 if (is_block)
989 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200990 if (nesting == MAX_FUNC_NESTING - 1)
991 emsg(_(e_function_nesting_too_deep));
992 else
993 {
994 ++nesting;
995 nesting_def[nesting] = TRUE;
996 nesting_inline[nesting] = TRUE;
997 indent += 2;
998 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100999 }
1000 }
1001 }
1002
1003 // Check for ":append", ":change", ":insert". Not for :def.
1004 p = skip_range(p, FALSE, NULL);
1005 if (!vim9_function
1006 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1007 || (p[0] == 'c'
1008 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1009 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1010 && (STRNCMP(&p[3], "nge", 3) != 0
1011 || !ASCII_ISALPHA(p[6])))))))
1012 || (p[0] == 'i'
1013 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1014 && (!ASCII_ISALPHA(p[2])
1015 || (p[2] == 's'
1016 && (!ASCII_ISALPHA(p[3])
1017 || p[3] == 'e'))))))))
1018 skip_until = vim_strsave((char_u *)".");
1019
1020 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1021 arg = skipwhite(skiptowhite(p));
1022 if (arg[0] == '<' && arg[1] =='<'
1023 && ((p[0] == 'p' && p[1] == 'y'
1024 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1025 || ((p[2] == '3' || p[2] == 'x')
1026 && !ASCII_ISALPHA(p[3]))))
1027 || (p[0] == 'p' && p[1] == 'e'
1028 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1029 || (p[0] == 't' && p[1] == 'c'
1030 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1031 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1032 && !ASCII_ISALPHA(p[3]))
1033 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1034 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1035 || (p[0] == 'm' && p[1] == 'z'
1036 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1037 ))
1038 {
1039 // ":python <<" continues until a dot, like ":append"
1040 p = skipwhite(arg + 2);
1041 if (STRNCMP(p, "trim", 4) == 0)
1042 {
1043 // Ignore leading white space.
1044 p = skipwhite(p + 4);
1045 heredoc_trimmed = vim_strnsave(theline,
1046 skipwhite(theline) - theline);
1047 }
1048 if (*p == NUL)
1049 skip_until = vim_strsave((char_u *)".");
1050 else
1051 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1052 getline_options = GETLINE_NONE;
1053 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001054 if (eap->cmdidx == CMD_def)
1055 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001056 }
1057
1058 // Check for ":cmd v =<< [trim] EOF"
1059 // and ":cmd [a, b] =<< [trim] EOF"
1060 // and "lines =<< [trim] EOF" for Vim9
1061 // Where "cmd" can be "let", "var", "final" or "const".
1062 arg = skipwhite(skiptowhite(p));
1063 if (*arg == '[')
1064 arg = vim_strchr(arg, ']');
1065 if (arg != NULL)
1066 {
1067 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1068 && arg[1] == '<' && arg[2] =='<');
1069
1070 if (!found)
1071 // skip over the argument after "cmd"
1072 arg = skipwhite(skiptowhite(arg));
1073 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1074 && (checkforcmd(&p, "let", 2)
1075 || checkforcmd(&p, "var", 3)
1076 || checkforcmd(&p, "final", 5)
1077 || checkforcmd(&p, "const", 5))))
1078 {
1079 p = skipwhite(arg + 3);
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001080 while (TRUE)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001081 {
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001082 if (STRNCMP(p, "trim", 4) == 0)
1083 {
1084 // Ignore leading white space.
1085 p = skipwhite(p + 4);
1086 heredoc_trimmed = vim_strnsave(theline,
1087 skipwhite(theline) - theline);
1088 continue;
1089 }
1090 if (STRNCMP(p, "eval", 4) == 0)
1091 {
1092 // Ignore leading white space.
1093 p = skipwhite(p + 4);
1094 continue;
1095 }
1096 break;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001097 }
1098 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1099 getline_options = GETLINE_NONE;
1100 is_heredoc = TRUE;
1101 }
1102 }
1103 }
1104
1105 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001106 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 goto theend;
1108
Bram Moolenaar20677332021-06-06 17:02:53 +02001109 if (heredoc_concat_len > 0)
1110 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001111 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001112 // to be used for the instruction later.
1113 ga_concat(&heredoc_ga, theline);
1114 ga_concat(&heredoc_ga, (char_u *)"\n");
1115 p = vim_strsave((char_u *)"");
1116 }
1117 else
1118 {
1119 // Copy the line to newly allocated memory. get_one_sourceline()
1120 // allocates 250 bytes per line, this saves 80% on average. The
1121 // cost is an extra alloc/free.
1122 p = vim_strsave(theline);
1123 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001124 if (p == NULL)
1125 goto theend;
1126 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1127
1128 // Add NULL lines for continuation lines, so that the line count is
1129 // equal to the index in the growarray.
1130 while (sourcing_lnum_off-- > 0)
1131 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1132
1133 // Check for end of eap->arg.
1134 if (line_arg != NULL && *line_arg == NUL)
1135 line_arg = NULL;
1136 }
1137
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001138 // Return OK when no error was detected.
1139 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001140 ret = OK;
1141
1142theend:
1143 vim_free(skip_until);
1144 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001145 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001146 need_wait_return |= saved_wait_return;
1147 return ret;
1148}
1149
1150/*
1151 * Handle the body of a lambda. *arg points to the "{", process statements
1152 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001153 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001154 * When successful "rettv" is set to a funcref.
1155 */
1156 static int
1157lambda_function_body(
1158 char_u **arg,
1159 typval_T *rettv,
1160 evalarg_T *evalarg,
1161 garray_T *newargs,
1162 garray_T *argtypes,
1163 int varargs,
1164 garray_T *default_args,
1165 char_u *ret_type)
1166{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001167 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001168 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001169 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001170 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001171 exarg_T eap;
1172 garray_T newlines;
1173 char_u *cmdline = NULL;
1174 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001175 partial_T *pt;
1176 char_u *name;
1177 int lnum_save = -1;
1178 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1179
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001180 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1181 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001182 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001183 return FAIL;
1184 }
1185
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001186 CLEAR_FIELD(eap);
1187 eap.cmdidx = CMD_block;
1188 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001189 eap.cmdlinep = &cmdline;
1190 eap.skip = !evaluate;
1191 if (evalarg->eval_cctx != NULL)
1192 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1193 else
1194 {
1195 eap.getline = evalarg->eval_getline;
1196 eap.cookie = evalarg->eval_cookie;
1197 }
1198
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001199 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001200 if (get_function_body(&eap, &newlines, NULL,
1201 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001202 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001203
1204 // When inside a lambda must add the function lines to evalarg.eval_ga.
1205 evalarg->eval_break_count += newlines.ga_len;
1206 if (gap->ga_itemsize > 0)
1207 {
1208 int idx;
1209 char_u *last;
1210 size_t plen;
1211 char_u *pnl;
1212
1213 for (idx = 0; idx < newlines.ga_len; ++idx)
1214 {
1215 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1216
Bram Moolenaarecb66452021-05-18 15:09:18 +02001217 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001218 goto erret;
1219
1220 // Going to concatenate the lines after parsing. For an empty or
1221 // comment line use an empty string.
1222 // Insert NL characters at the start of each line, the string will
1223 // be split again later in .get_lambda_tv().
1224 if (*p == NUL || vim9_comment_start(p))
1225 p = (char_u *)"";
1226 plen = STRLEN(p);
1227 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1228 if (pnl != NULL)
1229 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001230 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1231 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001232 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001233 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001234 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001235 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 // more is following after the "}", which was skipped
1237 last = cmdline;
1238 else
1239 // nothing is following the "}"
1240 last = (char_u *)"}";
1241 plen = STRLEN(last);
1242 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1243 if (pnl != NULL)
1244 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001245 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1246 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001247 }
1248
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001249 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001250 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001251 garray_T *tfgap = &evalarg->eval_tofree_ga;
1252
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001253 // Something comes after the "}".
1254 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001255
1256 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001257 if (ga_grow(tfgap, 1) == OK)
1258 {
1259 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1260 evalarg->eval_using_cmdline = TRUE;
1261 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262 }
1263 else
1264 *arg = (char_u *)"";
1265
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001266 if (!evaluate)
1267 {
1268 ret = OK;
1269 goto erret;
1270 }
1271
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001272 name = get_lambda_name();
1273 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1274 if (ufunc == NULL)
1275 goto erret;
1276 set_ufunc_name(ufunc, name);
1277 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001278 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001279 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 ufunc->uf_refcount = 1;
1281 ufunc->uf_args = *newargs;
1282 newargs->ga_data = NULL;
1283 ufunc->uf_def_args = *default_args;
1284 default_args->ga_data = NULL;
1285 ufunc->uf_func_type = &t_func_any;
1286
1287 // error messages are for the first function line
1288 lnum_save = SOURCING_LNUM;
1289 SOURCING_LNUM = sourcing_lnum_top;
1290
1291 // parse argument types
1292 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1293 {
1294 SOURCING_LNUM = lnum_save;
1295 goto erret;
1296 }
1297
1298 // parse the return type, if any
1299 if (parse_return_type(ufunc, ret_type) == FAIL)
1300 goto erret;
1301
1302 pt = ALLOC_CLEAR_ONE(partial_T);
1303 if (pt == NULL)
1304 goto erret;
1305 pt->pt_func = ufunc;
1306 pt->pt_refcount = 1;
1307
1308 ufunc->uf_lines = newlines;
1309 newlines.ga_data = NULL;
1310 if (sandbox)
1311 ufunc->uf_flags |= FC_SANDBOX;
1312 if (!ASCII_ISUPPER(*ufunc->uf_name))
1313 ufunc->uf_flags |= FC_VIM9;
1314 ufunc->uf_script_ctx = current_sctx;
1315 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1316 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1317 set_function_type(ufunc);
1318
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001319 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1320
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001321 rettv->vval.v_partial = pt;
1322 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001323 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001324 ret = OK;
1325
1326erret:
1327 if (lnum_save >= 0)
1328 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001329 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001330 if (newargs != NULL)
1331 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001332 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001333 if (ufunc != NULL)
1334 {
1335 func_clear(ufunc, TRUE);
1336 func_free(ufunc, TRUE);
1337 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001338 return ret;
1339}
1340
1341/*
1342 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001343 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001344 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001345 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1346 */
1347 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001348get_lambda_tv(
1349 char_u **arg,
1350 typval_T *rettv,
1351 int types_optional,
1352 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001353{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001354 int evaluate = evalarg != NULL
1355 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 garray_T newargs;
1357 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001358 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001359 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001360 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001361 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001362 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001364 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001366 char_u *s;
1367 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001368 int *old_eval_lavars = eval_lavars_used;
1369 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001370 char_u *tofree1 = NULL;
1371 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001372 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001373 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001374 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001375 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001376 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001377
Bram Moolenaar4525a572022-02-13 11:57:33 +00001378 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001379 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380
1381 ga_init(&newargs);
1382 ga_init(&newlines);
1383
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001384 // First, check if this is really a lambda expression. "->" or "=>" must
1385 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001386 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001387 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001388 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001389 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001390 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001391 {
1392 if (types_optional)
1393 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001394 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001395 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001396
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001397 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001398 if (evaluate)
1399 pnewargs = &newargs;
1400 else
1401 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001402 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001403 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001404 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001405 &varargs, &default_args,
1406 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001407 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001408 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001409 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001410 {
1411 if (types_optional)
1412 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001413 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001414 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001415 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001416 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001417
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001418 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1419 if (ret_type != NULL)
1420 {
1421 ret_type = vim_strsave(ret_type);
1422 tofree2 = ret_type;
1423 }
1424
Bram Moolenaare38eab22019-12-05 21:50:01 +01001425 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001426 if (evaluate)
1427 eval_lavars_used = &eval_lavars;
1428
Bram Moolenaar65c44152020-12-24 15:14:01 +01001429 *arg = skipwhite_and_linebreak(*arg, evalarg);
1430
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001431 // Recognize "{" as the start of a function body.
1432 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001433 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001434 if (evalarg == NULL)
1435 // cannot happen?
1436 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001437 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001438 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1439 types_optional ? &argtypes : NULL, varargs,
1440 &default_args, ret_type) == FAIL)
1441 goto errret;
1442 goto theend;
1443 }
1444 if (default_args.ga_len > 0)
1445 {
1446 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001447 goto errret;
1448 }
1449
Bram Moolenaare38eab22019-12-05 21:50:01 +01001450 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001451 start = *arg;
1452 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453 if (ret == FAIL)
1454 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001455 if (evalarg != NULL)
1456 {
1457 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001458 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001459 evalarg->eval_tofree = NULL;
1460 }
1461
Bram Moolenaar65c44152020-12-24 15:14:01 +01001462 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001463 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001464 *arg = skipwhite_and_linebreak(*arg, evalarg);
1465 if (**arg != '}')
1466 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001467 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001468 goto errret;
1469 }
1470 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001471 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001472
1473 if (evaluate)
1474 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001475 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001476 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001477 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001478 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001479 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001480
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001481 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482 if (fp == NULL)
1483 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001484 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001485 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001486 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001487 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001489 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001490 if (ga_grow(&newlines, 1) == FAIL)
1491 goto errret;
1492
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001493 // If there are line breaks, we need to split up the string.
1494 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001495 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001496 line_end = end;
1497
1498 // Add "return " before the expression (or the first line).
1499 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001500 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001501 if (p == NULL)
1502 goto errret;
1503 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1504 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001505 vim_strncpy(p + 7, start, line_end - start);
1506
1507 if (line_end != end)
1508 {
1509 // Add more lines, split by line breaks. Thus is used when a
1510 // lambda with { cmds } is encountered.
1511 while (*line_end == '\n')
1512 {
1513 if (ga_grow(&newlines, 1) == FAIL)
1514 goto errret;
1515 start = line_end + 1;
1516 line_end = vim_strchr(start, '\n');
1517 if (line_end == NULL)
1518 line_end = end;
1519 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1520 vim_strnsave(start, line_end - start);
1521 }
1522 }
1523
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001524 if (strstr((char *)p + 7, "a:") == NULL)
1525 // No a: variables are used for sure.
1526 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001527
1528 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001529 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001530 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001531 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001532 if (types_optional)
1533 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001534 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001535 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001536 goto errret;
1537 if (ret_type != NULL)
1538 {
1539 fp->uf_ret_type = parse_type(&ret_type,
1540 &fp->uf_type_list, TRUE);
1541 if (fp->uf_ret_type == NULL)
1542 goto errret;
1543 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001544 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001545 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001546 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001547
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001549 if (current_funccal != NULL && eval_lavars)
1550 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001551 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001552 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001553 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555
1556#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001557 if (prof_def_func())
1558 func_do_profile(fp);
1559#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001560 if (sandbox)
1561 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001562 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001563 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001564 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001565 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001567 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001568 // Use the line number of the arguments.
1569 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001571 function_using_block_scopes(fp, evalarg->eval_cstack);
1572
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001573 pt->pt_func = fp;
1574 pt->pt_refcount = 1;
1575 rettv->vval.v_partial = pt;
1576 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001577
1578 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001579 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001581theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001582 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001583 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001584 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001585 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001586 vim_free(tofree1);
1587 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001588 if (types_optional)
1589 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001590
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001591 return OK;
1592
1593errret:
1594 ga_clear_strings(&newargs);
1595 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001596 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001597 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001598 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001599 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001600 if (fp != NULL)
1601 vim_free(fp->uf_arg_types);
1602 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001604 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001605 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001606 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001607 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001608 vim_free(tofree1);
1609 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001610 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611 return FAIL;
1612}
1613
1614/*
1615 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1616 * name it contains, otherwise return "name".
1617 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1618 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001619 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1620 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001621 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001622 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 */
1624 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001625deref_func_name(
1626 char_u *name,
1627 int *lenp,
1628 partial_T **partialp,
1629 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001630 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001631 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001632 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633{
1634 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001635 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001637 char_u *s = NULL;
1638 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001639 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640
1641 if (partialp != NULL)
1642 *partialp = NULL;
1643
1644 cc = name[*lenp];
1645 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001646
Bram Moolenaar71f21932022-01-07 18:20:55 +00001647 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001649 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001651 tv = &v->di_tv;
1652 }
1653 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1654 {
1655 imported_T *import;
1656 char_u *p = name;
1657 int len = *lenp;
1658
1659 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001661 p = name + 2;
1662 len -= 2;
1663 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001664 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001665
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001666 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001667 if (import != NULL)
1668 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001669 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001670 if (new_function)
1671 semsg(_(e_redefining_imported_item_str), name);
1672 else
1673 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001674 name[len] = cc;
1675 *lenp = 0;
1676 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001677 }
1678 }
1679
1680 if (tv != NULL)
1681 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001682 if (found_var != NULL)
1683 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001684 if (tv->v_type == VAR_FUNC)
1685 {
1686 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001687 {
1688 *lenp = 0;
1689 return (char_u *)""; // just in case
1690 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001691 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001692 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001695 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001697 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001698
1699 if (pt == NULL)
1700 {
1701 *lenp = 0;
1702 return (char_u *)""; // just in case
1703 }
1704 if (partialp != NULL)
1705 *partialp = pt;
1706 s = partial_name(pt);
1707 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001709
1710 if (s != NULL)
1711 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001712 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001713 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001714 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001715
1716 if (sv != NULL)
1717 *type = sv->sv_type;
1718 }
1719 return s;
1720 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721 }
1722
1723 return name;
1724}
1725
1726/*
1727 * Give an error message with a function name. Handle <SNR> things.
1728 * "ermsg" is to be passed without translation, use N_() instead of _().
1729 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001730 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731emsg_funcname(char *ermsg, char_u *name)
1732{
Bram Moolenaar54598062022-01-13 12:05:09 +00001733 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734
Bram Moolenaar54598062022-01-13 12:05:09 +00001735 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001737 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738 if (p != name)
1739 vim_free(p);
1740}
1741
1742/*
1743 * Allocate a variable for the result of a function.
1744 * Return OK or FAIL.
1745 */
1746 int
1747get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001748 char_u *name, // name of the function
1749 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001751 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001752 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001753 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754{
1755 char_u *argp;
1756 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001757 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1758 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001759 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001760 int evaluate = evalarg == NULL
1761 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762
1763 /*
1764 * Get the arguments.
1765 */
1766 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001767 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1768 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001770 // skip the '(' or ',' and possibly line breaks
1771 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1772
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 if (*argp == ')' || *argp == ',' || *argp == NUL)
1774 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001775 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 {
1777 ret = FAIL;
1778 break;
1779 }
1780 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001781 // The comma should come right after the argument, but this wasn't
1782 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001783 if (vim9script)
1784 {
1785 if (*argp != ',' && *skipwhite(argp) == ',')
1786 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001787 if (evaluate)
1788 semsg(_(e_no_white_space_allowed_before_str_str),
1789 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001790 ret = FAIL;
1791 break;
1792 }
1793 }
1794 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001795 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796 if (*argp != ',')
1797 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001798 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1799 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001800 if (evaluate)
1801 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001802 ret = FAIL;
1803 break;
1804 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001806 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807 if (*argp == ')')
1808 ++argp;
1809 else
1810 ret = FAIL;
1811
1812 if (ret == OK)
1813 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001814 int i = 0;
1815 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816
1817 if (get_vim_var_nr(VV_TESTING))
1818 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001819 // Prepare for calling test_garbagecollect_now(), need to know
1820 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001822 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823 for (i = 0; i < argcount; ++i)
1824 if (ga_grow(&funcargs, 1) == OK)
1825 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1826 &argvars[i];
1827 }
1828
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001829 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001830 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001831 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001832 // An error in a builtin function does not return FAIL, but we do
1833 // want to abort further processing if an error was given.
1834 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001835 clear_tv(rettv);
1836 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837
1838 funcargs.ga_len -= i;
1839 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001840 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 {
1842 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001843 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001844 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001845 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846 }
1847
1848 while (--argcount >= 0)
1849 clear_tv(&argvars[argcount]);
1850
Bram Moolenaar4525a572022-02-13 11:57:33 +00001851 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001852 *arg = argp;
1853 else
1854 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 return ret;
1856}
1857
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858/*
1859 * Return TRUE if "p" starts with "<SID>" or "s:".
1860 * Only works if eval_fname_script() returned non-zero for "p"!
1861 */
1862 static int
1863eval_fname_sid(char_u *p)
1864{
1865 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1866}
1867
1868/*
1869 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1870 * Change <SNR>123_name() to K_SNR 123_name().
1871 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1872 * (slow).
1873 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001874 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1876{
1877 int llen;
1878 char_u *fname;
1879 int i;
1880
1881 llen = eval_fname_script(name);
1882 if (llen > 0)
1883 {
1884 fname_buf[0] = K_SPECIAL;
1885 fname_buf[1] = KS_EXTRA;
1886 fname_buf[2] = (int)KE_SNR;
1887 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001888 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001889 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001890 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001891 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001892 else
1893 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001894 sprintf((char *)fname_buf + 3, "%ld_",
1895 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 i = (int)STRLEN(fname_buf);
1897 }
1898 }
1899 if (i + STRLEN(name + llen) < FLEN_FIXED)
1900 {
1901 STRCPY(fname_buf + i, name + llen);
1902 fname = fname_buf;
1903 }
1904 else
1905 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001906 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001907 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001908 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 else
1910 {
1911 *tofree = fname;
1912 mch_memmove(fname, fname_buf, (size_t)i);
1913 STRCPY(fname + i, name + llen);
1914 }
1915 }
1916 }
1917 else
1918 fname = name;
1919 return fname;
1920}
1921
1922/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001923 * Concatenate the script ID and function name into "<SNR>99_name".
1924 * "buffer" must have size MAX_FUNC_NAME_LEN.
1925 */
1926 void
1927func_name_with_sid(char_u *name, int sid, char_u *buffer)
1928{
1929 // A script-local function is stored as "<SNR>99_name".
1930 buffer[0] = K_SPECIAL;
1931 buffer[1] = KS_EXTRA;
1932 buffer[2] = (int)KE_SNR;
1933 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1934 (long)sid, name);
1935}
1936
1937/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001938 * Find a function "name" in script "sid".
1939 */
1940 static ufunc_T *
1941find_func_with_sid(char_u *name, int sid)
1942{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001943 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001944 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001945
Bram Moolenaarb8822442022-01-11 15:24:05 +00001946 if (!SCRIPT_ID_VALID(sid))
1947 return NULL; // not in a script
1948
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001949 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001950 hi = hash_find(&func_hashtab, buffer);
1951 if (!HASHITEM_EMPTY(hi))
1952 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001953 return NULL;
1954}
1955
1956/*
1957 * Find a function "name" in script "sid" prefixing the autoload prefix.
1958 */
1959 static ufunc_T *
1960find_func_with_prefix(char_u *name, int sid)
1961{
1962 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001963 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001964 scriptitem_T *si;
1965
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001966 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001967 return NULL; // already has the prefix
1968 if (!SCRIPT_ID_VALID(sid))
1969 return NULL; // not in a script
1970 si = SCRIPT_ITEM(sid);
1971 if (si->sn_autoload_prefix != NULL)
1972 {
1973 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1974 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001975 char_u *namep;
1976
1977 // skip a "<SNR>99_" prefix
1978 namep = untrans_function_name(name);
1979 if (namep == NULL)
1980 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001981
1982 // An exported function in an autoload script is stored as
1983 // "dir#path#name".
1984 if (len < sizeof(buffer))
1985 auto_name = buffer;
1986 else
1987 auto_name = alloc(len);
1988 if (auto_name != NULL)
1989 {
1990 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001991 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001992 hi = hash_find(&func_hashtab, auto_name);
1993 if (auto_name != buffer)
1994 vim_free(auto_name);
1995 if (!HASHITEM_EMPTY(hi))
1996 return HI2UF(hi);
1997 }
1998 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001999
2000 return NULL;
2001}
2002
2003/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002004 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002005 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2006 * functions.
2007 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002008 * Return NULL for unknown function.
2009 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002010 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002011find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002012{
2013 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002014 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002015
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002016 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002017 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002018 // Find script-local function before global one.
2019 if (in_vim9script() && eval_isnamec1(*name)
2020 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002021 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002022 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2023 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002024 if (func != NULL)
2025 return func;
2026 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002027 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2028 {
2029 char_u *p = name + 5;
2030 long sid;
2031
2032 // printable "<SNR>123_Name" form
2033 sid = getdigits(&p);
2034 if (*p == '_')
2035 {
2036 func = find_func_with_sid(p + 1, (int)sid);
2037 if (func != NULL)
2038 return func;
2039 }
2040 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002041 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002042
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002043 if ((flags & FFED_NO_GLOBAL) == 0)
2044 {
2045 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002046 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002047 if (!HASHITEM_EMPTY(hi))
2048 return HI2UF(hi);
2049 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002050
Bram Moolenaarb8822442022-01-11 15:24:05 +00002051 // Find autoload function if this is an autoload script.
2052 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2053 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002054}
2055
2056/*
2057 * Find a function by name, return pointer to it in ufuncs.
2058 * "cctx" is passed in a :def function to find imported functions.
2059 * Return NULL for unknown or dead function.
2060 */
2061 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002062find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002063{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002064 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002065
2066 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2067 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002068 return NULL;
2069}
2070
2071/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002072 * Return TRUE if "ufunc" is a global function.
2073 */
2074 int
2075func_is_global(ufunc_T *ufunc)
2076{
2077 return ufunc->uf_name[0] != K_SPECIAL;
2078}
2079
2080/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002081 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2082 */
2083 int
2084func_requires_g_prefix(ufunc_T *ufunc)
2085{
2086 return ufunc->uf_name[0] != K_SPECIAL
2087 && (ufunc->uf_flags & FC_LAMBDA) == 0
2088 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2089}
2090
2091/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002092 * Copy the function name of "fp" to buffer "buf".
2093 * "buf" must be able to hold the function name plus three bytes.
2094 * Takes care of script-local function names.
2095 */
2096 static void
2097cat_func_name(char_u *buf, ufunc_T *fp)
2098{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002099 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002100 {
2101 STRCPY(buf, "<SNR>");
2102 STRCAT(buf, fp->uf_name + 3);
2103 }
2104 else
2105 STRCPY(buf, fp->uf_name);
2106}
2107
2108/*
2109 * Add a number variable "name" to dict "dp" with value "nr".
2110 */
2111 static void
2112add_nr_var(
2113 dict_T *dp,
2114 dictitem_T *v,
2115 char *name,
2116 varnumber_T nr)
2117{
2118 STRCPY(v->di_key, name);
2119 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2120 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2121 v->di_tv.v_type = VAR_NUMBER;
2122 v->di_tv.v_lock = VAR_FIXED;
2123 v->di_tv.vval.v_number = nr;
2124}
2125
2126/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002127 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002128 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 static void
2130free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002131{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002132 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002133
2134 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2135 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002136 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002137
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002138 // When garbage collecting a funccall_T may be freed before the
2139 // function that references it, clear its uf_scoped field.
2140 // The function may have been redefined and point to another
2141 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002142 if (fp != NULL && fp->uf_scoped == fc)
2143 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002144 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002145 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002146
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002147 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002148 vim_free(fc);
2149}
2150
2151/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002152 * Free "fc" and what it contains.
2153 * Can be called only when "fc" is kept beyond the period of it called,
2154 * i.e. after cleanup_function_call(fc).
2155 */
2156 static void
2157free_funccal_contents(funccall_T *fc)
2158{
2159 listitem_T *li;
2160
2161 // Free all l: variables.
2162 vars_clear(&fc->l_vars.dv_hashtab);
2163
2164 // Free all a: variables.
2165 vars_clear(&fc->l_avars.dv_hashtab);
2166
2167 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002168 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002169 clear_tv(&li->li_tv);
2170
2171 free_funccal(fc);
2172}
2173
2174/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002175 * Handle the last part of returning from a function: free the local hashtable.
2176 * Unless it is still in use by a closure.
2177 */
2178 static void
2179cleanup_function_call(funccall_T *fc)
2180{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002181 int may_free_fc = fc->fc_refcount <= 0;
2182 int free_fc = TRUE;
2183
Bram Moolenaar6914c642017-04-01 21:21:30 +02002184 current_funccal = fc->caller;
2185
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002186 // Free all l: variables if not referred.
2187 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2188 vars_clear(&fc->l_vars.dv_hashtab);
2189 else
2190 free_fc = FALSE;
2191
2192 // If the a:000 list and the l: and a: dicts are not referenced and
2193 // there is no closure using it, we can free the funccall_T and what's
2194 // in it.
2195 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2196 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002197 else
2198 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002199 int todo;
2200 hashitem_T *hi;
2201 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002202
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002203 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002204
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002205 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002206 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2207 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2208 {
2209 if (!HASHITEM_EMPTY(hi))
2210 {
2211 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002212 di = HI2DI(hi);
2213 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002214 }
2215 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002216 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002217
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002218 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2219 fc->l_varlist.lv_first = NULL;
2220 else
2221 {
2222 listitem_T *li;
2223
2224 free_fc = FALSE;
2225
2226 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002227 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002228 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002229 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002230
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002231 if (free_fc)
2232 free_funccal(fc);
2233 else
2234 {
2235 static int made_copy = 0;
2236
2237 // "fc" is still in use. This can happen when returning "a:000",
2238 // assigning "l:" to a global variable or defining a closure.
2239 // Link "fc" in the list for garbage collection later.
2240 fc->caller = previous_funccal;
2241 previous_funccal = fc;
2242
2243 if (want_garbage_collect)
2244 // If garbage collector is ready, clear count.
2245 made_copy = 0;
2246 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002247 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002248 // We have made a lot of copies, worth 4 Mbyte. This can happen
2249 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002250 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002251 // too much memory.
2252 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002253 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002254 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002255 }
2256}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002257
2258/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002259 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2260 */
2261 static int
2262numbered_function(char_u *name)
2263{
2264 return isdigit(*name)
2265 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2266}
2267
2268/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002269 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002270 * 1. ordinary names, function defined with :function or :def;
2271 * can start with "<SNR>123_" literally or with K_SPECIAL.
2272 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002273 * For the first we only count the name stored in func_hashtab as a reference,
2274 * using function() does not count as a reference, because the function is
2275 * looked up by name.
2276 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002277 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002278func_name_refcount(char_u *name)
2279{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002280 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002281}
2282
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002283/*
2284 * Unreference "fc": decrement the reference count and free it when it
2285 * becomes zero. "fp" is detached from "fc".
2286 * When "force" is TRUE we are exiting.
2287 */
2288 static void
2289funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2290{
2291 funccall_T **pfc;
2292 int i;
2293
2294 if (fc == NULL)
2295 return;
2296
2297 if (--fc->fc_refcount <= 0 && (force || (
2298 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2299 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2300 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2301 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2302 {
2303 if (fc == *pfc)
2304 {
2305 *pfc = fc->caller;
2306 free_funccal_contents(fc);
2307 return;
2308 }
2309 }
2310 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2311 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2312 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2313}
2314
2315/*
2316 * Remove the function from the function hashtable. If the function was
2317 * deleted while it still has references this was already done.
2318 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2319 */
2320 static int
2321func_remove(ufunc_T *fp)
2322{
2323 hashitem_T *hi;
2324
2325 // Return if it was already virtually deleted.
2326 if (fp->uf_flags & FC_DEAD)
2327 return FALSE;
2328
2329 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2330 if (!HASHITEM_EMPTY(hi))
2331 {
2332 // When there is a def-function index do not actually remove the
2333 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002334 // Do remove it when it's a copy.
2335 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002336 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002337 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002338 return FALSE;
2339 }
2340 hash_remove(&func_hashtab, hi);
2341 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002342 return TRUE;
2343 }
2344 return FALSE;
2345}
2346
2347 static void
2348func_clear_items(ufunc_T *fp)
2349{
2350 ga_clear_strings(&(fp->uf_args));
2351 ga_clear_strings(&(fp->uf_def_args));
2352 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002353 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002354 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002355 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002356 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002357
2358 // Increment the refcount of this function to avoid it being freed
2359 // recursively when the partial is freed.
2360 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002361 partial_unref(fp->uf_partial);
2362 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002363 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002364
2365#ifdef FEAT_LUA
2366 if (fp->uf_cb_free != NULL)
2367 {
2368 fp->uf_cb_free(fp->uf_cb_state);
2369 fp->uf_cb_free = NULL;
2370 }
2371
2372 fp->uf_cb_state = NULL;
2373 fp->uf_cb = NULL;
2374#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002375#ifdef FEAT_PROFILE
2376 VIM_CLEAR(fp->uf_tml_count);
2377 VIM_CLEAR(fp->uf_tml_total);
2378 VIM_CLEAR(fp->uf_tml_self);
2379#endif
2380}
2381
2382/*
2383 * Free all things that a function contains. Does not free the function
2384 * itself, use func_free() for that.
2385 * When "force" is TRUE we are exiting.
2386 */
2387 static void
2388func_clear(ufunc_T *fp, int force)
2389{
2390 if (fp->uf_cleared)
2391 return;
2392 fp->uf_cleared = TRUE;
2393
2394 // clear this function
2395 func_clear_items(fp);
2396 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002397 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002398}
2399
2400/*
2401 * Free a function and remove it from the list of functions. Does not free
2402 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002403 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002404 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002405 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002406 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002407func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002408{
2409 // Only remove it when not done already, otherwise we would remove a newer
2410 // version of the function with the same name.
2411 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2412 func_remove(fp);
2413
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002414 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002415 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002416 if (fp->uf_dfunc_idx > 0)
2417 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002418 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002419 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002420 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002421 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002422 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002423}
2424
2425/*
2426 * Free all things that a function contains and free the function itself.
2427 * When "force" is TRUE we are exiting.
2428 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002429 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002430func_clear_free(ufunc_T *fp, int force)
2431{
2432 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002433 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2434 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002435 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002436 else
2437 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002438}
2439
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002440/*
2441 * Copy already defined function "lambda" to a new function with name "global".
2442 * This is for when a compiled function defines a global function.
2443 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002444 int
2445copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002446{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002447 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002448 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002449
2450 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002451 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002452 semsg(_(e_lambda_function_not_found_str), lambda);
2453 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002454 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002455
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002456 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002457 if (fp != NULL)
2458 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002459 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002460 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002461 return FAIL;
2462 }
2463
2464 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2465 if (fp == NULL)
2466 return FAIL;
2467
2468 fp->uf_varargs = ufunc->uf_varargs;
2469 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2470 fp->uf_def_status = ufunc->uf_def_status;
2471 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2472 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2473 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2474 == FAIL
2475 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2476 goto failed;
2477
2478 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2479 : vim_strsave(ufunc->uf_name_exp);
2480 if (ufunc->uf_arg_types != NULL)
2481 {
2482 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2483 if (fp->uf_arg_types == NULL)
2484 goto failed;
2485 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2486 sizeof(type_T *) * fp->uf_args.ga_len);
2487 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002488 if (ufunc->uf_va_name != NULL)
2489 {
2490 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2491 if (fp->uf_va_name == NULL)
2492 goto failed;
2493 }
2494 fp->uf_ret_type = ufunc->uf_ret_type;
2495
2496 fp->uf_refcount = 1;
2497 STRCPY(fp->uf_name, global);
2498 hash_add(&func_hashtab, UF2HIKEY(fp));
2499
2500 // the referenced dfunc_T is now used one more time
2501 link_def_function(fp);
2502
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002503 // Create a partial to store the context of the function where it was
2504 // instantiated. Only needs to be done once. Do this on the original
2505 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002506 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2507 {
2508 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2509
2510 if (pt == NULL)
2511 goto failed;
2512 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002513 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002514 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002515 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002516 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002517 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002518 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002519 }
2520
2521 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002522
2523failed:
2524 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002525 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002526}
2527
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002528static int funcdepth = 0;
2529
2530/*
2531 * Increment the function call depth count.
2532 * Return FAIL when going over 'maxfuncdepth'.
2533 * Otherwise return OK, must call funcdepth_decrement() later!
2534 */
2535 int
2536funcdepth_increment(void)
2537{
2538 if (funcdepth >= p_mfd)
2539 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002540 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002541 return FAIL;
2542 }
2543 ++funcdepth;
2544 return OK;
2545}
2546
2547 void
2548funcdepth_decrement(void)
2549{
2550 --funcdepth;
2551}
2552
2553/*
2554 * Get the current function call depth.
2555 */
2556 int
2557funcdepth_get(void)
2558{
2559 return funcdepth;
2560}
2561
2562/*
2563 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002564 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002565 * times as funcdepth_increment().
2566 */
2567 void
2568funcdepth_restore(int depth)
2569{
2570 funcdepth = depth;
2571}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002572
2573/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 * Call a user function.
2575 */
2576 static void
2577call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002578 ufunc_T *fp, // pointer to function
2579 int argcount, // nr of args
2580 typval_T *argvars, // arguments
2581 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002582 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002583 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002585 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002586 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002587 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588 funccall_T *fc;
2589 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002590 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002591 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002592 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002593 int i;
2594 int ai;
2595 int islambda = FALSE;
2596 char_u numbuf[NUMBUFLEN];
2597 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002598 typval_T *tv_to_free[MAX_FUNC_ARGS];
2599 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002600#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002601 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002603 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002604
Bram Moolenaarb2049902021-01-24 12:53:53 +01002605#ifdef FEAT_PROFILE
2606 CLEAR_FIELD(profile_info);
2607#endif
2608
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002609 // If depth of calling is getting too high, don't execute the function.
2610 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002611 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002612 rettv->v_type = VAR_NUMBER;
2613 rettv->vval.v_number = -1;
2614 return;
2615 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616
Bram Moolenaare38eab22019-12-05 21:50:01 +01002617 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002619 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002620 if (fc == NULL)
2621 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 fc->caller = current_funccal;
2623 current_funccal = fc;
2624 fc->func = fp;
2625 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002627 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2629 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002630 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002631 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002632 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002634 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002635 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002636#ifdef FEAT_PROFILE
2637 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2638#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002639 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002640#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002641 if (do_profiling == PROF_YES)
2642 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002643#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002644 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002645 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002646 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002647#ifdef FEAT_PROFILE
2648 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002649 || (caller != NULL && caller->uf_profiling)))
2650 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002651#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002652 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002653 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002654 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002655 return;
2656 }
2657
Bram Moolenaar38453522021-11-28 22:00:12 +00002658 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659
2660 /*
2661 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2662 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2663 * each argument variable and saves a lot of time.
2664 */
2665 /*
2666 * Init l: variables.
2667 */
2668 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2669 if (selfdict != NULL)
2670 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002671 // Set l:self to "selfdict". Use "name" to avoid a warning from
2672 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 v = &fc->fixvar[fixvar_idx++].var;
2674 name = v->di_key;
2675 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002676 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2678 v->di_tv.v_type = VAR_DICT;
2679 v->di_tv.v_lock = 0;
2680 v->di_tv.vval.v_dict = selfdict;
2681 ++selfdict->dv_refcount;
2682 }
2683
2684 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002685 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002686 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 * Set a:000 to a list with room for the "..." arguments.
2688 */
2689 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002690 if ((fp->uf_flags & FC_NOARGS) == 0)
2691 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002692 (varnumber_T)(argcount >= fp->uf_args.ga_len
2693 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002694 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002695 if ((fp->uf_flags & FC_NOARGS) == 0)
2696 {
2697 // Use "name" to avoid a warning from some compiler that checks the
2698 // destination size.
2699 v = &fc->fixvar[fixvar_idx++].var;
2700 name = v->di_key;
2701 STRCPY(name, "000");
2702 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2703 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2704 v->di_tv.v_type = VAR_LIST;
2705 v->di_tv.v_lock = VAR_FIXED;
2706 v->di_tv.vval.v_list = &fc->l_varlist;
2707 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002708 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2710 fc->l_varlist.lv_lock = VAR_FIXED;
2711
2712 /*
2713 * Set a:firstline to "firstline" and a:lastline to "lastline".
2714 * Set a:name to named arguments.
2715 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002716 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002718 if ((fp->uf_flags & FC_NOARGS) == 0)
2719 {
2720 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002721 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002722 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002723 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002724 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002725 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002726 {
2727 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002728 typval_T def_rettv;
2729 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730
2731 ai = i - fp->uf_args.ga_len;
2732 if (ai < 0)
2733 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002734 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002735 name = FUNCARG(fp, i);
2736 if (islambda)
2737 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002738
2739 // evaluate named argument default expression
2740 isdefault = ai + fp->uf_def_args.ga_len >= 0
2741 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2742 && argvars[i].vval.v_number == VVAL_NONE));
2743 if (isdefault)
2744 {
2745 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002746
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002747 def_rettv.v_type = VAR_NUMBER;
2748 def_rettv.vval.v_number = -1;
2749
2750 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2751 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002752 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002753 {
2754 default_arg_err = 1;
2755 break;
2756 }
2757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 }
2759 else
2760 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002761 if ((fp->uf_flags & FC_NOARGS) != 0)
2762 // Bail out if no a: arguments used (in lambda).
2763 break;
2764
Bram Moolenaare38eab22019-12-05 21:50:01 +01002765 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 sprintf((char *)numbuf, "%d", ai + 1);
2767 name = numbuf;
2768 }
2769 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2770 {
2771 v = &fc->fixvar[fixvar_idx++].var;
2772 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002773 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 }
2775 else
2776 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002777 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 if (v == NULL)
2779 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002780 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002783 // Note: the values are copied directly to avoid alloc/free.
2784 // "argvars" must have VAR_FIXED for v_lock.
2785 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 v->di_tv.v_lock = VAR_FIXED;
2787
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002788 if (isdefault)
2789 // Need to free this later, no matter where it's stored.
2790 tv_to_free[tv_to_free_len++] = &v->di_tv;
2791
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 if (addlocal)
2793 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002794 // Named arguments should be accessed without the "a:" prefix in
2795 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002796 copy_tv(&v->di_tv, &v->di_tv);
2797 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002799 else
2800 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002801
2802 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2803 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002804 listitem_T *li = &fc->l_listitems[ai];
2805
2806 li->li_tv = argvars[i];
2807 li->li_tv.v_lock = VAR_FIXED;
2808 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 }
2810 }
2811
Bram Moolenaare38eab22019-12-05 21:50:01 +01002812 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002814
2815 if (fp->uf_flags & FC_SANDBOX)
2816 {
2817 using_sandbox = TRUE;
2818 ++sandbox;
2819 }
2820
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002821 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002822 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002823 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002825 ++no_wait_return;
2826 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002828 smsg(_("calling %s"), SOURCING_NAME);
2829 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002831 char_u buf[MSG_BUF_LEN];
2832 char_u numbuf2[NUMBUFLEN];
2833 char_u *tofree;
2834 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002836 msg_puts("(");
2837 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002839 if (i > 0)
2840 msg_puts(", ");
2841 if (argvars[i].v_type == VAR_NUMBER)
2842 msg_outnum((long)argvars[i].vval.v_number);
2843 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002845 // Do not want errors such as E724 here.
2846 ++emsg_off;
2847 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2848 --emsg_off;
2849 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002851 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002853 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2854 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002856 msg_puts((char *)s);
2857 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858 }
2859 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002861 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002863 msg_puts("\n"); // don't overwrite this either
2864
2865 verbose_leave_scroll();
2866 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 }
2868#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002869 if (do_profiling == PROF_YES)
2870 profile_may_start_func(&profile_info, fp,
2871 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872#endif
2873
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002874 // "legacy" does not apply to commands in the function
2875 sticky_cmdmod_flags = 0;
2876
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002877 save_current_sctx = current_sctx;
2878 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002879 save_did_emsg = did_emsg;
2880 did_emsg = FALSE;
2881
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002882 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2883 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002884 else if (islambda)
2885 {
2886 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2887
2888 // A Lambda always has the command "return {expr}". It is much faster
2889 // to evaluate {expr} directly.
2890 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002891 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002892 --ex_nesting_level;
2893 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002894 else
2895 // call do_cmdline() to execute the lines
2896 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2898
2899 --RedrawingDisabled;
2900
Bram Moolenaare38eab22019-12-05 21:50:01 +01002901 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2903 {
2904 clear_tv(rettv);
2905 rettv->v_type = VAR_NUMBER;
2906 rettv->vval.v_number = -1;
2907 }
2908
2909#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002910 if (do_profiling == PROF_YES)
2911 {
2912 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2913
2914 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2915 profile_may_end_func(&profile_info, fp, caller);
2916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917#endif
2918
Bram Moolenaare38eab22019-12-05 21:50:01 +01002919 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 if (p_verbose >= 12)
2921 {
2922 ++no_wait_return;
2923 verbose_enter_scroll();
2924
2925 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002926 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002928 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002929 (long)fc->rettv->vval.v_number);
2930 else
2931 {
2932 char_u buf[MSG_BUF_LEN];
2933 char_u numbuf2[NUMBUFLEN];
2934 char_u *tofree;
2935 char_u *s;
2936
Bram Moolenaare38eab22019-12-05 21:50:01 +01002937 // The value may be very long. Skip the middle part, so that we
2938 // have some idea how it starts and ends. smsg() would always
2939 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 ++emsg_off;
2941 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2942 --emsg_off;
2943 if (s != NULL)
2944 {
2945 if (vim_strsize(s) > MSG_BUF_CLEN)
2946 {
2947 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2948 s = buf;
2949 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002950 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 vim_free(tofree);
2952 }
2953 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002954 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955
2956 verbose_leave_scroll();
2957 --no_wait_return;
2958 }
2959
Bram Moolenaare31ee862020-01-07 20:59:34 +01002960 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002961 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002962 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963#ifdef FEAT_PROFILE
2964 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002965 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002967 if (using_sandbox)
2968 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002969 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002971 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 {
2973 ++no_wait_return;
2974 verbose_enter_scroll();
2975
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002976 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002977 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978
2979 verbose_leave_scroll();
2980 --no_wait_return;
2981 }
2982
2983 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002984 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002985 for (i = 0; i < tv_to_free_len; ++i)
2986 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002987 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988}
2989
2990/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002991 * Check the argument count for user function "fp".
2992 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2993 */
2994 int
2995check_user_func_argcount(ufunc_T *fp, int argcount)
2996{
2997 int regular_args = fp->uf_args.ga_len;
2998
2999 if (argcount < regular_args - fp->uf_def_args.ga_len)
3000 return FCERR_TOOFEW;
3001 else if (!has_varargs(fp) && argcount > regular_args)
3002 return FCERR_TOOMANY;
3003 return FCERR_UNKNOWN;
3004}
3005
3006/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003007 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003008 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003009 int
3010call_user_func_check(
3011 ufunc_T *fp,
3012 int argcount,
3013 typval_T *argvars,
3014 typval_T *rettv,
3015 funcexe_T *funcexe,
3016 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003017{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003019
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003020 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3021 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003022 error = check_user_func_argcount(fp, argcount);
3023 if (error != FCERR_UNKNOWN)
3024 return error;
3025 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003026 error = FCERR_DICT;
3027 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003028 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003029 int did_save_redo = FALSE;
3030 save_redo_T save_redo;
3031
3032 /*
3033 * Call the user function.
3034 * Save and restore search patterns, script variables and
3035 * redo buffer.
3036 */
3037 save_search_patterns();
3038 if (!ins_compl_active())
3039 {
3040 saveRedobuff(&save_redo);
3041 did_save_redo = TRUE;
3042 }
3043 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003044 call_user_func(fp, argcount, argvars, rettv, funcexe,
3045 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003046 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3047 // Function was unreferenced while being used, free it now.
3048 func_clear_free(fp, FALSE);
3049 if (did_save_redo)
3050 restoreRedobuff(&save_redo);
3051 restore_search_patterns();
3052 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003053 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003054 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003055}
3056
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003057static funccal_entry_T *funccal_stack = NULL;
3058
3059/*
3060 * Save the current function call pointer, and set it to NULL.
3061 * Used when executing autocommands and for ":source".
3062 */
3063 void
3064save_funccal(funccal_entry_T *entry)
3065{
3066 entry->top_funccal = current_funccal;
3067 entry->next = funccal_stack;
3068 funccal_stack = entry;
3069 current_funccal = NULL;
3070}
3071
3072 void
3073restore_funccal(void)
3074{
3075 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003076 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003077 else
3078 {
3079 current_funccal = funccal_stack->top_funccal;
3080 funccal_stack = funccal_stack->next;
3081 }
3082}
3083
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003084 funccall_T *
3085get_current_funccal(void)
3086{
3087 return current_funccal;
3088}
3089
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003090/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003091 * Return TRUE when currently at the script level:
3092 * - not in a function
3093 * - not executing an autocommand
3094 * Note that when an autocommand sources a script the result is FALSE;
3095 */
3096 int
3097at_script_level(void)
3098{
3099 return current_funccal == NULL && autocmd_match == NULL;
3100}
3101
3102/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003103 * Mark all functions of script "sid" as deleted.
3104 */
3105 void
3106delete_script_functions(int sid)
3107{
3108 hashitem_T *hi;
3109 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003110 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003111 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003112 size_t len;
3113
3114 buf[0] = K_SPECIAL;
3115 buf[1] = KS_EXTRA;
3116 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003117 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003118 len = STRLEN(buf);
3119
Bram Moolenaarce658352020-07-31 23:47:12 +02003120 while (todo > 0)
3121 {
3122 todo = func_hashtab.ht_used;
3123 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3124 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003125 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003126 fp = HI2UF(hi);
3127 if (STRNCMP(fp->uf_name, buf, len) == 0)
3128 {
3129 int changed = func_hashtab.ht_changed;
3130
3131 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003132
3133 if (fp->uf_calls > 0)
3134 {
3135 // Function is executing, don't free it but do remove
3136 // it from the hashtable.
3137 if (func_remove(fp))
3138 fp->uf_refcount--;
3139 }
3140 else
3141 {
3142 func_clear(fp, TRUE);
3143 // When clearing a function another function can be
3144 // cleared as a side effect. When that happens start
3145 // over.
3146 if (changed != func_hashtab.ht_changed)
3147 break;
3148 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003149 }
3150 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003151 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003152 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003153}
3154
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003155#if defined(EXITFREE) || defined(PROTO)
3156 void
3157free_all_functions(void)
3158{
3159 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003160 ufunc_T *fp;
3161 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003162 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003163 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164
Bram Moolenaare38eab22019-12-05 21:50:01 +01003165 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003166 while (current_funccal != NULL)
3167 {
3168 clear_tv(current_funccal->rettv);
3169 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003170 if (current_funccal == NULL && funccal_stack != NULL)
3171 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003172 }
3173
Bram Moolenaare38eab22019-12-05 21:50:01 +01003174 // First clear what the functions contain. Since this may lower the
3175 // reference count of a function, it may also free a function and change
3176 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003177 while (todo > 0)
3178 {
3179 todo = func_hashtab.ht_used;
3180 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3181 if (!HASHITEM_EMPTY(hi))
3182 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003183 // clear the def function index now
3184 fp = HI2UF(hi);
3185 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003186 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003187
Bram Moolenaare38eab22019-12-05 21:50:01 +01003188 // Only free functions that are not refcounted, those are
3189 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003190 if (func_name_refcount(fp->uf_name))
3191 ++skipped;
3192 else
3193 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003194 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003195 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003196 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003197 {
3198 skipped = 0;
3199 break;
3200 }
3201 }
3202 --todo;
3203 }
3204 }
3205
Bram Moolenaare38eab22019-12-05 21:50:01 +01003206 // Now actually free the functions. Need to start all over every time,
3207 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003208 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003209 while (func_hashtab.ht_used > skipped)
3210 {
3211 todo = func_hashtab.ht_used;
3212 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 if (!HASHITEM_EMPTY(hi))
3214 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003215 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003216 // Only free functions that are not refcounted, those are
3217 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003218 fp = HI2UF(hi);
3219 if (func_name_refcount(fp->uf_name))
3220 ++skipped;
3221 else
3222 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003223 if (func_free(fp, FALSE) == OK)
3224 {
3225 skipped = 0;
3226 break;
3227 }
3228 // did not actually free it
3229 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003230 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003232 }
3233 if (skipped == 0)
3234 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003235
3236 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237}
3238#endif
3239
3240/*
3241 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003242 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3243 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244 * "len" is the length of "name", or -1 for NUL terminated.
3245 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003246 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247builtin_function(char_u *name, int len)
3248{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003249 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250
Bram Moolenaara26b9702020-04-18 19:53:28 +02003251 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003253 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3254 {
3255 if (name[i] == AUTOLOAD_CHAR)
3256 return FALSE;
3257 if (!eval_isnamec(name[i]))
3258 {
3259 // "name.something" is not a builtin function
3260 if (name[i] == '.')
3261 return FALSE;
3262 break;
3263 }
3264 }
3265 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003266}
3267
3268 int
3269func_call(
3270 char_u *name,
3271 typval_T *args,
3272 partial_T *partial,
3273 dict_T *selfdict,
3274 typval_T *rettv)
3275{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003276 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 listitem_T *item;
3278 typval_T argv[MAX_FUNC_ARGS + 1];
3279 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 int r = 0;
3281
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003282 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003283 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 {
3285 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3286 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003287 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288 break;
3289 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003290 // Make a copy of each argument. This is needed to be able to set
3291 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 copy_tv(&item->li_tv, &argv[argc++]);
3293 }
3294
3295 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003296 {
3297 funcexe_T funcexe;
3298
Bram Moolenaara80faa82020-04-12 19:37:17 +02003299 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003300 funcexe.fe_firstline = curwin->w_cursor.lnum;
3301 funcexe.fe_lastline = curwin->w_cursor.lnum;
3302 funcexe.fe_evaluate = TRUE;
3303 funcexe.fe_partial = partial;
3304 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003305 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3306 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307
Bram Moolenaare38eab22019-12-05 21:50:01 +01003308 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 while (argc > 0)
3310 clear_tv(&argv[--argc]);
3311
3312 return r;
3313}
3314
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003315static int callback_depth = 0;
3316
3317 int
3318get_callback_depth(void)
3319{
3320 return callback_depth;
3321}
3322
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003324 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003325 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003326 */
3327 int
3328call_callback(
3329 callback_T *callback,
3330 int len, // length of "name" or -1 to use strlen()
3331 typval_T *rettv, // return value goes here
3332 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003333 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003334 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003335{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003336 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003337 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003338
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003339 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3340 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003341 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003342 funcexe.fe_evaluate = TRUE;
3343 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003344 ++callback_depth;
3345 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3346 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003347
3348 // When a :def function was called that uses :try an error would be turned
3349 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003350 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003351 {
3352 need_rethrow = FALSE;
3353 handle_did_throw();
3354 }
3355
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003356 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003357}
3358
3359/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003360 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003361 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003362 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3363 */
3364 varnumber_T
3365call_callback_retnr(
3366 callback_T *callback,
3367 int argcount, // number of "argvars"
3368 typval_T *argvars) // vars for arguments, must have "argcount"
3369 // PLUS ONE elements!
3370{
3371 typval_T rettv;
3372 varnumber_T retval;
3373
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003374 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003375 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003376
3377 retval = tv_get_number_chk(&rettv, NULL);
3378 clear_tv(&rettv);
3379 return retval;
3380}
3381
3382/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003383 * Give an error message for the result of a function.
3384 * Nothing if "error" is FCERR_NONE.
3385 */
3386 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003387user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003388{
3389 switch (error)
3390 {
3391 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003392 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003393 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003394 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003395 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396 break;
3397 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003398 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003399 break;
3400 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003401 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003402 break;
3403 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003404 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003405 break;
3406 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003407 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408 break;
3409 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003410 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003411 break;
3412 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003413 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3414 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003415 break;
3416 }
3417}
3418
3419/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003421 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 * Return FAIL when the function can't be called, OK otherwise.
3423 * Also returns OK when an error was encountered while executing the function.
3424 */
3425 int
3426call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003427 char_u *funcname, // name of the function
3428 int len, // length of "name" or -1 to use strlen()
3429 typval_T *rettv, // return value goes here
3430 int argcount_in, // number of "argvars"
3431 typval_T *argvars_in, // vars for arguments, must have "argcount"
3432 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003433 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434{
3435 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003436 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003437 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003438 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 char_u fname_buf[FLEN_FIXED + 1];
3440 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003441 char_u *fname = NULL;
3442 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 int argcount = argcount_in;
3444 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003445 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003446 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003447 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003449 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003450 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003451 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003452 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003454 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3455 // even when call_func() returns FAIL.
3456 rettv->v_type = VAR_UNKNOWN;
3457
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003458 if (partial != NULL)
3459 fp = partial->pt_func;
3460 if (fp == NULL)
3461 {
3462 // Make a copy of the name, if it comes from a funcref variable it
3463 // could be changed or deleted in the called function.
3464 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3465 if (name == NULL)
3466 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003468 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3469 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003471 if (funcexe->fe_doesrange != NULL)
3472 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473
3474 if (partial != NULL)
3475 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003476 // When the function has a partial with a dict and there is a dict
3477 // argument, use the dict argument. That is backwards compatible.
3478 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003479 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003481 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 {
3483 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003484 {
3485 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3486 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003487 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003488 goto theend;
3489 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003491 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 for (i = 0; i < argcount_in; ++i)
3493 argv[i + argv_clear] = argvars_in[i];
3494 argvars = argv;
3495 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003496
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003497 if (funcexe->fe_check_type != NULL
3498 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003499 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003500 // Now funcexe->fe_check_type is missing the added arguments,
3501 // make a copy of the type with the correction.
3502 check_type = *funcexe->fe_check_type;
3503 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003504 check_type.tt_args = check_type_args;
3505 CLEAR_FIELD(check_type_args);
3506 for (i = 0; i < check_type.tt_argcount; ++i)
3507 check_type_args[i + partial->pt_argc] =
3508 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003509 check_type.tt_argcount += partial->pt_argc;
3510 check_type.tt_min_argcount += partial->pt_argc;
3511 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512 }
3513 }
3514
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003515 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3516 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003517 {
3518 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003519 if (check_argument_types(funcexe->fe_check_type,
3520 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003521 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003522 error = FCERR_OTHER;
3523 }
3524
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003525 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 {
3527 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003528 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003529
Bram Moolenaar333894b2020-08-01 18:53:07 +02003530 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003531 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003532 {
3533 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003535 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536
Bram Moolenaare38eab22019-12-05 21:50:01 +01003537 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003539 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003541 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 {
3543 /*
3544 * User defined function.
3545 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003546 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003547 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003548 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003549 if (fp != NULL && !is_global && in_vim9script()
3550 && func_requires_g_prefix(fp))
3551 // In Vim9 script g: is required to find a global
3552 // non-autoload function.
3553 fp = NULL;
3554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555
Bram Moolenaare38eab22019-12-05 21:50:01 +01003556 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 if (fp == NULL
3558 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003559 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 && !aborting())
3561 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003562 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003563 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003565 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3567 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003568 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003569 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003571 if (fp == NULL)
3572 {
3573 char_u *p = untrans_function_name(rfname);
3574
3575 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003576 // Don't do this if the name starts with "s:".
3577 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003578 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003579 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003581 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003582 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003583#ifdef FEAT_LUA
3584 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3585 {
3586 cfunc_T cb = fp->uf_cb;
3587
3588 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3589 }
3590#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003591 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003593 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003594 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003595 argcount = funcexe->fe_argv_func(argcount, argvars,
3596 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003597
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003598 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003599 {
3600 // Method call: base->Method()
3601 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003602 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003603 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003604 argvars = argv;
3605 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003606 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003607
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003608 error = call_user_func_check(fp, argcount, argvars, rettv,
3609 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003610 }
3611 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003612 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003613 {
3614 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003615 * expr->method(): Find the method name in the table, call its
3616 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003617 */
3618 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003619 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003620 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 else
3622 {
3623 /*
3624 * Find the function name in the table, call its implementation.
3625 */
3626 error = call_internal_func(fname, argcount, argvars, rettv);
3627 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003628
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 /*
3630 * The function call (or "FuncUndefined" autocommand sequence) might
3631 * have been aborted by an error, an interrupt, or an explicitly thrown
3632 * exception that has not been caught so far. This situation can be
3633 * tested for by calling aborting(). For an error in an internal
3634 * function or for the "E132" error in call_user_func(), however, the
3635 * throw point at which the "force_abort" flag (temporarily reset by
3636 * emsg()) is normally updated has not been reached yet. We need to
3637 * update that flag first to make aborting() reliable.
3638 */
3639 update_force_abort();
3640 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003641 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 ret = OK;
3643
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003644theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 /*
3646 * Report an error unless the argument evaluation or function call has been
3647 * cancelled due to an aborting error, an interrupt, or an exception.
3648 */
3649 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003650 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003652 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003654 clear_tv(&argv[--argv_clear + argv_base]);
3655
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003656 vim_free(tofree);
3657 vim_free(name);
3658
3659 return ret;
3660}
3661
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003662 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003663printable_func_name(ufunc_T *fp)
3664{
3665 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3666}
3667
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003669 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 */
3671 static void
3672list_func_head(ufunc_T *fp, int indent)
3673{
3674 int j;
3675
3676 msg_start();
3677 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003678 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003679 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003680 msg_puts("def ");
3681 else
3682 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003683 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 msg_putchar('(');
3685 for (j = 0; j < fp->uf_args.ga_len; ++j)
3686 {
3687 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003688 msg_puts(", ");
3689 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003690 if (fp->uf_arg_types != NULL)
3691 {
3692 char *tofree;
3693
3694 msg_puts(": ");
3695 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3696 vim_free(tofree);
3697 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003698 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3699 {
3700 msg_puts(" = ");
3701 msg_puts(((char **)(fp->uf_def_args.ga_data))
3702 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3703 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 }
3705 if (fp->uf_varargs)
3706 {
3707 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003708 msg_puts(", ");
3709 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003711 if (fp->uf_va_name != NULL)
3712 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003713 if (!fp->uf_varargs)
3714 {
3715 if (j)
3716 msg_puts(", ");
3717 msg_puts("...");
3718 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003719 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003720 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003721 {
3722 char *tofree;
3723
3724 msg_puts(": ");
3725 msg_puts(type_name(fp->uf_va_type, &tofree));
3726 vim_free(tofree);
3727 }
3728 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003730
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003731 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003732 {
3733 if (fp->uf_ret_type != &t_void)
3734 {
3735 char *tofree;
3736
3737 msg_puts(": ");
3738 msg_puts(type_name(fp->uf_ret_type, &tofree));
3739 vim_free(tofree);
3740 }
3741 }
3742 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003743 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003745 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003746 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003747 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003748 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003749 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 msg_clr_eos();
3751 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003752 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753}
3754
3755/*
3756 * Get a function name, translating "<SID>" and "<SNR>".
3757 * Also handles a Funcref in a List or Dictionary.
3758 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003759 * Set "*is_global" to TRUE when the function must be global, unless
3760 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 * flags:
3762 * TFN_INT: internal function name OK
3763 * TFN_QUIET: be quiet
3764 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003765 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 * Advances "pp" to just after the function name (if no error).
3767 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003768 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769trans_function_name(
3770 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003771 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003772 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003773 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003774 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003775 partial_T **partial, // return: partial of a FuncRef
3776 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777{
3778 char_u *name = NULL;
3779 char_u *start;
3780 char_u *end;
3781 int lead;
3782 char_u sid_buf[20];
3783 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003784 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003785 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003787 int vim9script = in_vim9script();
3788 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789
3790 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003791 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 start = *pp;
3793
Bram Moolenaare38eab22019-12-05 21:50:01 +01003794 // Check for hard coded <SNR>: already translated function ID (from a user
3795 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3797 && (*pp)[2] == (int)KE_SNR)
3798 {
3799 *pp += 3;
3800 len = get_id_len(pp) + 3;
3801 return vim_strnsave(start, len);
3802 }
3803
Bram Moolenaare38eab22019-12-05 21:50:01 +01003804 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3805 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 lead = eval_fname_script(start);
3807 if (lead > 2)
3808 start += lead;
3809
Bram Moolenaare38eab22019-12-05 21:50:01 +01003810 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003811 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003813 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003814 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 {
3816 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003817 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 goto theend;
3819 }
3820 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3821 {
3822 /*
3823 * Report an invalid expression in braces, unless the expression
3824 * evaluation has been cancelled due to an aborting error, an
3825 * interrupt, or an exception.
3826 */
3827 if (!aborting())
3828 {
3829 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003830 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 }
3832 else
3833 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3834 goto theend;
3835 }
3836
3837 if (lv.ll_tv != NULL)
3838 {
3839 if (fdp != NULL)
3840 {
3841 fdp->fd_dict = lv.ll_dict;
3842 fdp->fd_newkey = lv.ll_newkey;
3843 lv.ll_newkey = NULL;
3844 fdp->fd_di = lv.ll_di;
3845 }
3846 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3847 {
3848 name = vim_strsave(lv.ll_tv->vval.v_string);
3849 *pp = end;
3850 }
3851 else if (lv.ll_tv->v_type == VAR_PARTIAL
3852 && lv.ll_tv->vval.v_partial != NULL)
3853 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003854 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 *pp = end;
3856 if (partial != NULL)
3857 *partial = lv.ll_tv->vval.v_partial;
3858 }
3859 else
3860 {
3861 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3862 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003863 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 else
3865 *pp = end;
3866 name = NULL;
3867 }
3868 goto theend;
3869 }
3870
3871 if (lv.ll_name == NULL)
3872 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003873 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874 *pp = end;
3875 goto theend;
3876 }
3877
Bram Moolenaare38eab22019-12-05 21:50:01 +01003878 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 if (lv.ll_exp_name != NULL)
3880 {
3881 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003882 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003883 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003884 if (name == lv.ll_exp_name)
3885 name = NULL;
3886 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003887 else if (lv.ll_sid > 0)
3888 {
3889 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3890 int cc = *lv.ll_name_end;
3891
3892 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3893 *lv.ll_name_end = NUL;
3894 if (si->sn_autoload_prefix != NULL)
3895 {
3896 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3897 }
3898 else
3899 {
3900 sid_buf[0] = K_SPECIAL;
3901 sid_buf[1] = KS_EXTRA;
3902 sid_buf[2] = (int)KE_SNR;
3903 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003904 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003905 name = concat_str(sid_buf, lv.ll_name);
3906 }
3907 *lv.ll_name_end = cc;
3908 *pp = end;
3909 goto theend;
3910 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003911 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912 {
3913 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003914 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003915 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916 if (name == *pp)
3917 name = NULL;
3918 }
3919 if (name != NULL)
3920 {
3921 name = vim_strsave(name);
3922 *pp = end;
3923 if (STRNCMP(name, "<SNR>", 5) == 0)
3924 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003925 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 name[0] = K_SPECIAL;
3927 name[1] = KS_EXTRA;
3928 name[2] = (int)KE_SNR;
3929 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3930 }
3931 goto theend;
3932 }
3933
3934 if (lv.ll_exp_name != NULL)
3935 {
3936 len = (int)STRLEN(lv.ll_exp_name);
3937 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3938 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3939 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003940 // When there was "s:" already or the name expanded to get a
3941 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003942 lv.ll_name += 2;
3943 len -= 2;
3944 lead = 2;
3945 }
3946 }
3947 else
3948 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003949 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003951 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003952 if (lv.ll_name[0] == 'g')
3953 {
3954 if (is_global != NULL)
3955 {
3956 *is_global = TRUE;
3957 }
3958 else
3959 {
3960 // dropping "g:" without setting "is_global" won't work in
3961 // Vim9script, put it back later
3962 prefix_g = TRUE;
3963 extra = 2;
3964 }
3965 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003967 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 len = (int)(end - lv.ll_name);
3969 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003970 if (len <= 0)
3971 {
3972 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003973 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003974 goto theend;
3975 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003977 // In Vim9 script a user function is script-local by default, unless it
3978 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003979 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003980
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 /*
3982 * Copy the function name to allocated memory.
3983 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3984 * Accept <SNR>123_name() outside a script.
3985 */
3986 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003987 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003988 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003990 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003991 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003992 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003993 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003994 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003995 ? e_function_name_must_start_with_capital_str
3996 : e_function_name_must_start_with_capital_or_s_str),
3997 start);
3998 goto theend;
3999 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004000 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004001 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004002 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004003 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 || eval_fname_sid(*pp))
4005 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004006 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004007 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004009 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 goto theend;
4011 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004012 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004013 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004014 extra = 3 + (int)STRLEN(sid_buf);
4015 else
4016 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 }
4018 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004019 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004020 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004022 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004023 : e_function_name_must_start_with_capital_or_s_str),
4024 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 goto theend;
4026 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004027 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028 {
4029 char_u *cp = vim_strchr(lv.ll_name, ':');
4030
4031 if (cp != NULL && cp < end)
4032 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004033 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 goto theend;
4035 }
4036 }
4037
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004038 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 if (name != NULL)
4040 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004041 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 {
4043 name[0] = K_SPECIAL;
4044 name[1] = KS_EXTRA;
4045 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004046 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 STRCPY(name + 3, sid_buf);
4048 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004049 else if (prefix_g)
4050 {
4051 name[0] = 'g';
4052 name[1] = ':';
4053 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004054 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4055 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 }
4057 *pp = end;
4058
4059theend:
4060 clear_lval(&lv);
4061 return name;
4062}
4063
4064/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004065 * Assuming "name" is the result of trans_function_name() and it was prefixed
4066 * to use the script-local name, return the unmodified name (points into
4067 * "name"). Otherwise return NULL.
4068 * This can be used to first search for a script-local function and fall back
4069 * to the global function if not found.
4070 */
4071 char_u *
4072untrans_function_name(char_u *name)
4073{
4074 char_u *p;
4075
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004076 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004077 {
4078 p = vim_strchr(name, '_');
4079 if (p != NULL)
4080 return p + 1;
4081 }
4082 return NULL;
4083}
4084
4085/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004086 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4087 * current script ID and returns the expanded function name. The caller should
4088 * free the returned name. If not called from a script context or the function
4089 * name doesn't start with these prefixes, then returns NULL.
4090 * This doesn't check whether the script-local function exists or not.
4091 */
4092 char_u *
4093get_scriptlocal_funcname(char_u *funcname)
4094{
4095 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004096 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004097 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004098 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004099
4100 if (funcname == NULL)
4101 return NULL;
4102
4103 if (STRNCMP(funcname, "s:", 2) != 0
4104 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004105 {
4106 ufunc_T *ufunc;
4107
4108 // The function name does not have a script-local prefix. Try finding
4109 // it when in a Vim9 script and there is no "g:" prefix.
4110 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4111 return NULL;
4112 ufunc = find_func(funcname, FALSE);
4113 if (ufunc == NULL || func_is_global(ufunc)
4114 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4115 return NULL;
4116 ++p;
4117 off = 0;
4118 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004119 else
4120 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004121
4122 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4123 {
4124 emsg(_(e_using_sid_not_in_script_context));
4125 return NULL;
4126 }
4127 // Expand s: prefix into <SNR>nr_<name>
4128 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4129 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004130 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004131 if (newname == NULL)
4132 return NULL;
4133 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004134 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004135
4136 return newname;
4137}
4138
4139/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004140 * Return script-local "fname" with the 3-byte sequence replaced by
4141 * printable <SNR> in allocated memory.
4142 */
4143 char_u *
4144alloc_printable_func_name(char_u *fname)
4145{
4146 char_u *n = alloc(STRLEN(fname + 3) + 6);
4147
4148 if (n != NULL)
4149 {
4150 STRCPY(n, "<SNR>");
4151 STRCPY(n + 5, fname + 3);
4152 }
4153 return n;
4154}
4155
4156/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004157 * Call trans_function_name(), except that a lambda is returned as-is.
4158 * Returns the name in allocated memory.
4159 */
4160 char_u *
4161save_function_name(
4162 char_u **name,
4163 int *is_global,
4164 int skip,
4165 int flags,
4166 funcdict_T *fudi)
4167{
4168 char_u *p = *name;
4169 char_u *saved;
4170
4171 if (STRNCMP(p, "<lambda>", 8) == 0)
4172 {
4173 p += 8;
4174 (void)getdigits(&p);
4175 saved = vim_strnsave(*name, p - *name);
4176 if (fudi != NULL)
4177 CLEAR_POINTER(fudi);
4178 }
4179 else
4180 saved = trans_function_name(&p, is_global, skip,
4181 flags, fudi, NULL, NULL);
4182 *name = p;
4183 return saved;
4184}
4185
4186/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004187 * List functions. When "regmatch" is NULL all of then.
4188 * Otherwise functions matching "regmatch".
4189 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004190 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004191list_functions(regmatch_T *regmatch)
4192{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004193 int changed = func_hashtab.ht_changed;
4194 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004195 hashitem_T *hi;
4196
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004197 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004198 {
4199 if (!HASHITEM_EMPTY(hi))
4200 {
4201 ufunc_T *fp = HI2UF(hi);
4202
4203 --todo;
4204 if ((fp->uf_flags & FC_DEAD) == 0
4205 && (regmatch == NULL
4206 ? !message_filtered(fp->uf_name)
4207 && !func_name_refcount(fp->uf_name)
4208 : !isdigit(*fp->uf_name)
4209 && vim_regexec(regmatch, fp->uf_name, 0)))
4210 {
4211 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004212 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004213 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004214 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004215 return;
4216 }
4217 }
4218 }
4219 }
4220}
4221
4222/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004223 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004224 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4225 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004226 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004227 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004228 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004229 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004230define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232 int j;
4233 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004234 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004235 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004236 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 char_u *p;
4238 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004239 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 char_u *line_arg = NULL;
4241 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004242 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004243 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004244 garray_T newlines;
4245 int varargs = FALSE;
4246 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004247 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004248 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004249 int fp_allocated = FALSE;
4250 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004251 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 dictitem_T *v;
4253 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004254 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004255 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004257 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004258 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004259 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260
4261 /*
4262 * ":function" without argument: list functions.
4263 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004264 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265 {
4266 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004267 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004268 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004269 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 }
4271
4272 /*
4273 * ":function /pat": list functions matching pattern.
4274 */
4275 if (*eap->arg == '/')
4276 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004277 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278 if (!eap->skip)
4279 {
4280 regmatch_T regmatch;
4281
4282 c = *p;
4283 *p = NUL;
4284 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4285 *p = c;
4286 if (regmatch.regprog != NULL)
4287 {
4288 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004289 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 vim_regfree(regmatch.regprog);
4291 }
4292 }
4293 if (*p == '/')
4294 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004295 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004296 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 }
4298
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004299 ga_init(&newargs);
4300 ga_init(&argtypes);
4301 ga_init(&default_args);
4302
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 /*
4304 * Get the function name. There are these situations:
4305 * func normal function name
4306 * "name" == func, "fudi.fd_dict" == NULL
4307 * dict.func new dictionary entry
4308 * "name" == NULL, "fudi.fd_dict" set,
4309 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4310 * dict.func existing dict entry with a Funcref
4311 * "name" == func, "fudi.fd_dict" set,
4312 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4313 * dict.func existing dict entry that's not a Funcref
4314 * "name" == NULL, "fudi.fd_dict" set,
4315 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4316 * s:func script-local function name
4317 * g:func global function name, same as "func"
4318 */
4319 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004320 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004322 // nested function, argument is (args).
4323 paren = TRUE;
4324 CLEAR_FIELD(fudi);
4325 }
4326 else
4327 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004328 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004329 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004330 if (p[0] == 's' && p[1] == ':')
4331 {
4332 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4333 return NULL;
4334 }
4335 p = to_name_end(p, TRUE);
4336 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4337 {
4338 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4339 eap->arg);
4340 return NULL;
4341 }
4342 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004343 }
4344
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004345 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004346 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004347 paren = (vim_strchr(p, '(') != NULL);
4348 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004350 /*
4351 * Return on an invalid expression in braces, unless the expression
4352 * evaluation has been cancelled due to an aborting error, an
4353 * interrupt, or an exception.
4354 */
4355 if (!aborting())
4356 {
4357 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004358 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004359 vim_free(fudi.fd_newkey);
4360 return NULL;
4361 }
4362 else
4363 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004364 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004365
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004366 // For "export def FuncName()" in an autoload script the function name
4367 // is stored with the legacy autoload name "dir#script#FuncName" so
4368 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004369 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004370 {
4371 char_u *prefixed = may_prefix_autoload(name);
4372
4373 if (prefixed != NULL && prefixed != name)
4374 {
4375 vim_free(name);
4376 name = prefixed;
4377 }
4378 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004379 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004380 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004381 {
4382 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4383 goto ret_free;
4384 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385 }
4386
Bram Moolenaare38eab22019-12-05 21:50:01 +01004387 // An error in a function call during evaluation of an expression in magic
4388 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389 saved_did_emsg = did_emsg;
4390 did_emsg = FALSE;
4391
4392 /*
4393 * ":function func" with only function name: list function.
4394 */
4395 if (!paren)
4396 {
4397 if (!ends_excmd(*skipwhite(p)))
4398 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004399 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 goto ret_free;
4401 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004402 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004403 if (eap->nextcmd != NULL)
4404 *p = NUL;
4405 if (!eap->skip && !got_int)
4406 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004407 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004408 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4409 {
4410 char_u *up = untrans_function_name(name);
4411
4412 // With Vim9 script the name was made script-local, if not
4413 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004414 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004415 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004416 }
4417
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 if (fp != NULL)
4419 {
4420 list_func_head(fp, TRUE);
4421 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4422 {
4423 if (FUNCLINE(fp, j) == NULL)
4424 continue;
4425 msg_putchar('\n');
4426 msg_outnum((long)(j + 1));
4427 if (j < 9)
4428 msg_putchar(' ');
4429 if (j < 99)
4430 msg_putchar(' ');
4431 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004432 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 ui_breakcheck();
4434 }
4435 if (!got_int)
4436 {
4437 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004438 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004439 msg_puts(" enddef");
4440 else
4441 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 }
4443 }
4444 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004445 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 }
4447 goto ret_free;
4448 }
4449
4450 /*
4451 * ":function name(arg1, arg2)" Define function.
4452 */
4453 p = skipwhite(p);
4454 if (*p != '(')
4455 {
4456 if (!eap->skip)
4457 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004458 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 goto ret_free;
4460 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004461 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462 if (vim_strchr(p, '(') != NULL)
4463 p = vim_strchr(p, '(');
4464 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004466 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4467 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004468 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004469 goto ret_free;
4470 }
4471
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004472 // In Vim9 script only global functions can be redefined.
4473 if (vim9script && eap->forceit && !is_global)
4474 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004475 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004476 goto ret_free;
4477 }
4478
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004479 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480
Bram Moolenaar04b12692020-05-04 23:24:44 +02004481 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004483 // Check the name of the function. Unless it's a dictionary function
4484 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 if (name != NULL)
4486 arg = name;
4487 else
4488 arg = fudi.fd_newkey;
4489 if (arg != NULL && (fudi.fd_di == NULL
4490 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4491 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4492 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004493 char_u *name_base = arg;
4494 int i;
4495
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004497 {
4498 name_base = vim_strchr(arg, '_');
4499 if (name_base == NULL)
4500 name_base = arg + 3;
4501 else
4502 ++name_base;
4503 }
4504 for (i = 0; name_base[i] != NUL && (i == 0
4505 ? eval_isnamec1(name_base[i])
4506 : eval_isnamec(name_base[i])); ++i)
4507 ;
4508 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004509 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004510
4511 // In Vim9 script a function cannot have the same name as a
4512 // variable.
4513 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004514 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4515 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004516 + EVAL_VAR_NO_FUNC) == OK)
4517 {
4518 semsg(_(e_redefining_script_item_str), name_base);
4519 goto ret_free;
4520 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004522 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004524 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004525 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004526 goto ret_free;
4527 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528 }
4529
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004530 // This may get more lines and make the pointers into the first line
4531 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004532 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004533 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004534 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004535 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004536 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004538 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004540 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004542 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004543 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004544 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004545 if (*p != ':')
4546 {
4547 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4548 p = skipwhite(p);
4549 }
4550 else if (!IS_WHITE_OR_NUL(p[1]))
4551 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004552 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004553 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004554 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004555 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004556 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004557 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004558 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004559 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004560 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004561 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004562 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004563 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004564 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004566 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004568 else
4569 // find extra arguments "range", "dict", "abort" and "closure"
4570 for (;;)
4571 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004572 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004573 p = skipwhite(p);
4574 if (STRNCMP(p, "range", 5) == 0)
4575 {
4576 flags |= FC_RANGE;
4577 p += 5;
4578 }
4579 else if (STRNCMP(p, "dict", 4) == 0)
4580 {
4581 flags |= FC_DICT;
4582 p += 4;
4583 }
4584 else if (STRNCMP(p, "abort", 5) == 0)
4585 {
4586 flags |= FC_ABORT;
4587 p += 5;
4588 }
4589 else if (STRNCMP(p, "closure", 7) == 0)
4590 {
4591 flags |= FC_CLOSURE;
4592 p += 7;
4593 if (current_funccal == NULL)
4594 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004595 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004596 name == NULL ? (char_u *)"" : name);
4597 goto erret;
4598 }
4599 }
4600 else
4601 break;
4602 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603
Bram Moolenaare38eab22019-12-05 21:50:01 +01004604 // When there is a line break use what follows for the function body.
4605 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004606 if (*p == '\n')
4607 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004608 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004609 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4610 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004611 && !(VIM_ISWHITE(*whitep) && *p == '#'
4612 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004613 && !eap->skip
4614 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004615 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616
4617 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004618 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4619 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620 */
4621 if (KeyTyped)
4622 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004623 // Check if the function already exists, don't let the user type the
4624 // whole function before telling him it doesn't work! For a script we
4625 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626 if (!eap->skip && !eap->forceit)
4627 {
4628 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004629 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004630 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004631 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632 }
4633
4634 if (!eap->skip && did_emsg)
4635 goto erret;
4636
Bram Moolenaare38eab22019-12-05 21:50:01 +01004637 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004638 cmdline_row = msg_row;
4639 }
4640
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004641 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004642 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004643
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004644 // Do not define the function when getting the body fails and when
4645 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004646 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004647 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004648 goto erret;
4649
4650 /*
4651 * If there are no errors, add the function
4652 */
4653 if (fudi.fd_dict == NULL)
4654 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004655 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004656 char_u *find_name = name;
4657 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004658 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004659
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004660 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004661 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004662 var_conflict = TRUE;
4663
4664 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4665 {
4666 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4667
4668 if (si->sn_autoload_prefix != NULL)
4669 {
4670 if (is_export)
4671 {
4672 find_name = name + STRLEN(si->sn_autoload_prefix);
4673 v = find_var(find_name, &ht, TRUE);
4674 if (v != NULL)
4675 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004676 // Only check if the function already exists in the script,
4677 // global functions can be shadowed.
4678 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004679 }
4680 else
4681 {
4682 char_u *prefixed = may_prefix_autoload(name);
4683
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004684 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004685 {
4686 v = find_var(prefixed, &ht, TRUE);
4687 if (v != NULL)
4688 var_conflict = TRUE;
4689 vim_free(prefixed);
4690 }
4691 }
4692 }
4693 }
4694 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004695 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004696 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697 goto erret;
4698 }
4699
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004700 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004701 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004703 char_u *uname = untrans_function_name(name);
4704
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004705 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004706 }
4707
4708 if (fp != NULL || import != NULL)
4709 {
4710 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004711
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004712 // Function can be replaced with "function!" and when sourcing the
4713 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004714 // A name that is used by an import can not be overruled.
4715 if (import != NULL
4716 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004717 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004718 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004720 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004721 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004722 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004723 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004724 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 goto erret;
4726 }
4727 if (fp->uf_calls > 0)
4728 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004729 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004730 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 goto erret;
4732 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004733 if (fp->uf_refcount > 1)
4734 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004735 // This function is referenced somewhere, don't redefine it but
4736 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004737 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004738 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004739 fp = NULL;
4740 overwrite = TRUE;
4741 }
4742 else
4743 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004744 char_u *exp_name = fp->uf_name_exp;
4745
4746 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004747 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004748 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004749 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004750 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004751 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004752#ifdef FEAT_PROFILE
4753 fp->uf_profiling = FALSE;
4754 fp->uf_prof_initialized = FALSE;
4755#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004756 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004758 }
4759 }
4760 else
4761 {
4762 char numbuf[20];
4763
4764 fp = NULL;
4765 if (fudi.fd_newkey == NULL && !eap->forceit)
4766 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004767 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 goto erret;
4769 }
4770 if (fudi.fd_di == NULL)
4771 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004772 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004773 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 goto erret;
4775 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004776 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004777 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 goto erret;
4779
Bram Moolenaare38eab22019-12-05 21:50:01 +01004780 // Give the function a sequential number. Can only be used with a
4781 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 vim_free(name);
4783 sprintf(numbuf, "%d", ++func_nr);
4784 name = vim_strsave((char_u *)numbuf);
4785 if (name == NULL)
4786 goto erret;
4787 }
4788
4789 if (fp == NULL)
4790 {
4791 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4792 {
4793 int slen, plen;
4794 char_u *scriptname;
4795
Bram Moolenaare38eab22019-12-05 21:50:01 +01004796 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004798 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004799 {
4800 scriptname = autoload_name(name);
4801 if (scriptname != NULL)
4802 {
4803 p = vim_strchr(scriptname, '/');
4804 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004805 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004807 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004808 j = OK;
4809 vim_free(scriptname);
4810 }
4811 }
4812 if (j == FAIL)
4813 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004814 linenr_T save_lnum = SOURCING_LNUM;
4815
4816 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004817 semsg(_(e_function_name_does_not_match_script_file_name_str),
4818 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004819 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820 goto erret;
4821 }
4822 }
4823
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004824 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 if (fp == NULL)
4826 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004827 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828
4829 if (fudi.fd_dict != NULL)
4830 {
4831 if (fudi.fd_di == NULL)
4832 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004833 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4835 if (fudi.fd_di == NULL)
4836 {
4837 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004838 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004839 goto erret;
4840 }
4841 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4842 {
4843 vim_free(fudi.fd_di);
4844 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004845 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004846 goto erret;
4847 }
4848 }
4849 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004850 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851 clear_tv(&fudi.fd_di->di_tv);
4852 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004853 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854
Bram Moolenaare38eab22019-12-05 21:50:01 +01004855 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004856 flags |= FC_DICT;
4857 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004858 }
4859 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004860 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004861 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004862 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004863
4864 if (eap->cmdidx == CMD_def)
4865 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004866 int lnum_save = SOURCING_LNUM;
4867 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004868
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004869 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004870
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004871 // error messages are for the first function line
4872 SOURCING_LNUM = sourcing_lnum_top;
4873
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004874 // The function may use script variables from the context.
4875 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004876
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004877 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004878 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004879 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004880 free_fp = fp_allocated;
4881 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004882 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004883 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004884
4885 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004886 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004887 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004888 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004889 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004890 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004891 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004892 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004893 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004894 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004895 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004896
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004897 if (fp_allocated)
4898 {
4899 // insert the new function in the function list
4900 set_ufunc_name(fp, name);
4901 if (overwrite)
4902 {
4903 hi = hash_find(&func_hashtab, name);
4904 hi->hi_key = UF2HIKEY(fp);
4905 }
4906 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4907 {
4908 free_fp = TRUE;
4909 goto erret;
4910 }
4911 fp->uf_refcount = 1;
4912 }
4913
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004915 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004916 if ((flags & FC_CLOSURE) != 0)
4917 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004918 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004919 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004920 }
4921 else
4922 fp->uf_scoped = NULL;
4923
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004924#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925 if (prof_def_func())
4926 func_do_profile(fp);
4927#endif
4928 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004929 if (sandbox)
4930 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004931 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004932 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004933 fp->uf_flags = flags;
4934 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004935 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004936 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004937 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004938 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004939 if (is_export)
4940 {
4941 fp->uf_flags |= FC_EXPORT;
4942 // let ex_export() know the export worked.
4943 is_export = FALSE;
4944 }
4945
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004946 if (eap->cmdidx == CMD_def)
4947 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004948 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4949 // :func does not use Vim9 script syntax, even in a Vim9 script file
4950 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004951
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004952 goto ret_free;
4953
4954erret:
4955 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004956 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004957 if (fp != NULL)
4958 {
4959 ga_init(&fp->uf_args);
4960 ga_init(&fp->uf_def_args);
4961 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962errret_2:
4963 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004964 if (fp != NULL)
4965 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004966 if (free_fp)
4967 {
4968 vim_free(fp);
4969 fp = NULL;
4970 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004972 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004974 if (name != name_arg)
4975 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004976 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004978
4979 return fp;
4980}
4981
4982/*
4983 * ":function"
4984 */
4985 void
4986ex_function(exarg_T *eap)
4987{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004988 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004989
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004990 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4991 (void)define_function(eap, NULL, &lines_to_free);
4992 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004993}
4994
4995/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004996 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004997 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004998 */
4999 void
5000ex_defcompile(exarg_T *eap UNUSED)
5001{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02005002 long todo = (long)func_hashtab.ht_used;
5003 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02005004 hashitem_T *hi;
5005 ufunc_T *ufunc;
5006
5007 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5008 {
5009 if (!HASHITEM_EMPTY(hi))
5010 {
5011 --todo;
5012 ufunc = HI2UF(hi);
5013 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005014 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5015 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005016 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02005017 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005018
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02005019 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005020 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02005021 // a function has been added or removed, need to start over
5022 todo = (long)func_hashtab.ht_used;
5023 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005024 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02005025 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005026 }
5027 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005028 }
5029 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005030}
5031
5032/*
5033 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5034 * Return 2 if "p" starts with "s:".
5035 * Return 0 otherwise.
5036 */
5037 int
5038eval_fname_script(char_u *p)
5039{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005040 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5041 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005042 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5043 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5044 return 5;
5045 if (p[0] == 's' && p[1] == ':')
5046 return 2;
5047 return 0;
5048}
5049
5050 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005051translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052{
5053 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005054 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005055 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005056}
5057
5058/*
5059 * Return TRUE when "ufunc" has old-style "..." varargs
5060 * or named varargs "...name: type".
5061 */
5062 int
5063has_varargs(ufunc_T *ufunc)
5064{
5065 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005066}
5067
5068/*
5069 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005070 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071 */
5072 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005073function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074{
5075 char_u *nm = name;
5076 char_u *p;
5077 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005078 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005079 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005081 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5082 if (no_deref)
5083 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005084 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 nm = skipwhite(nm);
5086
Bram Moolenaare38eab22019-12-05 21:50:01 +01005087 // Only accept "funcname", "funcname ", "funcname (..." and
5088 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005090 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091 vim_free(p);
5092 return n;
5093}
5094
Bram Moolenaar113e1072019-01-20 15:30:40 +01005095#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005096 char_u *
5097get_expanded_name(char_u *name, int check)
5098{
5099 char_u *nm = name;
5100 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005101 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005103 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005104 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005105
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005106 if (p != NULL && *nm == NUL
5107 && (!check || translated_function_exists(p, is_global)))
5108 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109
5110 vim_free(p);
5111 return NULL;
5112}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005113#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115/*
5116 * Function given to ExpandGeneric() to obtain the list of user defined
5117 * function names.
5118 */
5119 char_u *
5120get_user_func_name(expand_T *xp, int idx)
5121{
5122 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005123 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124 static hashitem_T *hi;
5125 ufunc_T *fp;
5126
5127 if (idx == 0)
5128 {
5129 done = 0;
5130 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005131 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005132 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005133 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005134 {
5135 if (done++ > 0)
5136 ++hi;
5137 while (HASHITEM_EMPTY(hi))
5138 ++hi;
5139 fp = HI2UF(hi);
5140
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005141 // don't show dead, dict and lambda functions
5142 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005143 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005144 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145
5146 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005147 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005148
5149 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005150 if (xp->xp_context != EXPAND_USER_FUNC
5151 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 {
5153 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005154 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155 STRCAT(IObuff, ")");
5156 }
5157 return IObuff;
5158 }
5159 return NULL;
5160}
5161
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162/*
5163 * ":delfunction {name}"
5164 */
5165 void
5166ex_delfunction(exarg_T *eap)
5167{
5168 ufunc_T *fp = NULL;
5169 char_u *p;
5170 char_u *name;
5171 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005172 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005173
5174 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005175 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5176 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 vim_free(fudi.fd_newkey);
5178 if (name == NULL)
5179 {
5180 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005181 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005182 return;
5183 }
5184 if (!ends_excmd(*skipwhite(p)))
5185 {
5186 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005187 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188 return;
5189 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005190 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005191 if (eap->nextcmd != NULL)
5192 *p = NUL;
5193
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005194 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005195 {
5196 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005197 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005198 vim_free(name);
5199 return;
5200 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005202 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 vim_free(name);
5204
5205 if (!eap->skip)
5206 {
5207 if (fp == NULL)
5208 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005209 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005210 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005211 return;
5212 }
5213 if (fp->uf_calls > 0)
5214 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005215 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 return;
5217 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005218 if (fp->uf_flags & FC_VIM9)
5219 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005220 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005221 return;
5222 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223
5224 if (fudi.fd_dict != NULL)
5225 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005226 // Delete the dict item that refers to the function, it will
5227 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005228 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5229 }
5230 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005231 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005232 // A normal function (not a numbered function or lambda) has a
5233 // refcount of 1 for the entry in the hashtable. When deleting
5234 // it and the refcount is more than one, it should be kept.
5235 // A numbered function and lambda should be kept if the refcount is
5236 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005237 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005238 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005239 // Function is still referenced somewhere. Don't free it but
5240 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005241 if (func_remove(fp))
5242 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005243 }
5244 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005245 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005246 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247 }
5248}
5249
5250/*
5251 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005252 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005253 */
5254 void
5255func_unref(char_u *name)
5256{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005257 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005259 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005261 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005262 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005263 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005264#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005265 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005266#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005267 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005269 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005270}
5271
5272/*
5273 * Unreference a Function: decrement the reference count and free it when it
5274 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005275 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005276 */
5277 void
5278func_ptr_unref(ufunc_T *fp)
5279{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005280 if (fp != NULL && (--fp->uf_refcount <= 0
5281 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5282 && fp->uf_partial->pt_refcount <= 1
5283 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005284 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005285 // Only delete it when it's not being used. Otherwise it's done
5286 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005287 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005288 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005289 }
5290}
5291
5292/*
5293 * Count a reference to a Function.
5294 */
5295 void
5296func_ref(char_u *name)
5297{
5298 ufunc_T *fp;
5299
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005300 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005301 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005302 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005303 if (fp != NULL)
5304 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005305 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005306 // Only give an error for a numbered function.
5307 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005308 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005309}
5310
5311/*
5312 * Count a reference to a Function.
5313 */
5314 void
5315func_ptr_ref(ufunc_T *fp)
5316{
5317 if (fp != NULL)
5318 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319}
5320
5321/*
5322 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5323 * referenced from anywhere that is in use.
5324 */
5325 static int
5326can_free_funccal(funccall_T *fc, int copyID)
5327{
5328 return (fc->l_varlist.lv_copyID != copyID
5329 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005330 && fc->l_avars.dv_copyID != copyID
5331 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005332}
5333
5334/*
5335 * ":return [expr]"
5336 */
5337 void
5338ex_return(exarg_T *eap)
5339{
5340 char_u *arg = eap->arg;
5341 typval_T rettv;
5342 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005343 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005344
5345 if (current_funccal == NULL)
5346 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005347 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 return;
5349 }
5350
Bram Moolenaar844fb642021-10-23 13:32:30 +01005351 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005352 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5353
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005354 if (eap->skip)
5355 ++emsg_skip;
5356
5357 eap->nextcmd = NULL;
5358 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005359 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005360 {
5361 if (!eap->skip)
5362 returning = do_return(eap, FALSE, TRUE, &rettv);
5363 else
5364 clear_tv(&rettv);
5365 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005366 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005367 else if (!eap->skip)
5368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005369 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005370 update_force_abort();
5371
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005372 /*
5373 * Return unless the expression evaluation has been cancelled due to an
5374 * aborting error, an interrupt, or an exception.
5375 */
5376 if (!aborting())
5377 returning = do_return(eap, FALSE, TRUE, NULL);
5378 }
5379
Bram Moolenaare38eab22019-12-05 21:50:01 +01005380 // When skipping or the return gets pending, advance to the next command
5381 // in this line (!returning). Otherwise, ignore the rest of the line.
5382 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005383 if (returning)
5384 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005385 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005386 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005387
5388 if (eap->skip)
5389 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005390 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005391}
5392
5393/*
5394 * ":1,25call func(arg1, arg2)" function call.
5395 */
5396 void
5397ex_call(exarg_T *eap)
5398{
5399 char_u *arg = eap->arg;
5400 char_u *startarg;
5401 char_u *name;
5402 char_u *tofree;
5403 int len;
5404 typval_T rettv;
5405 linenr_T lnum;
5406 int doesrange;
5407 int failed = FALSE;
5408 funcdict_T fudi;
5409 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005410 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005411 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005412 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005413 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005414
Bram Moolenaare6b53242020-07-01 17:28:33 +02005415 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005416 if (eap->skip)
5417 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005418 // trans_function_name() doesn't work well when skipping, use eval0()
5419 // instead to skip to any following command, e.g. for:
5420 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005421 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005422 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005423 clear_tv(&rettv);
5424 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005425 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005426 return;
5427 }
5428
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005429 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005430 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005431 if (fudi.fd_newkey != NULL)
5432 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005433 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005434 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005435 vim_free(fudi.fd_newkey);
5436 }
5437 if (tofree == NULL)
5438 return;
5439
Bram Moolenaare38eab22019-12-05 21:50:01 +01005440 // Increase refcount on dictionary, it could get deleted when evaluating
5441 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 if (fudi.fd_dict != NULL)
5443 ++fudi.fd_dict->dv_refcount;
5444
Bram Moolenaare38eab22019-12-05 21:50:01 +01005445 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5446 // contents. For VAR_PARTIAL get its partial, unless we already have one
5447 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005448 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005449 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005450 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005451 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005452
Bram Moolenaare38eab22019-12-05 21:50:01 +01005453 // Skip white space to allow ":call func ()". Not good, but required for
5454 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005455 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005456 if (*startarg != '(')
5457 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005458 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005459 goto end;
5460 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005461 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005462 {
5463 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5464 goto end;
5465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005466
5467 /*
5468 * When skipping, evaluate the function once, to find the end of the
5469 * arguments.
5470 * When the function takes a range, this is discovered after the first
5471 * call, and the loop is broken.
5472 */
5473 if (eap->skip)
5474 {
5475 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005476 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005477 }
5478 else
5479 lnum = eap->line1;
5480 for ( ; lnum <= eap->line2; ++lnum)
5481 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005482 funcexe_T funcexe;
5483
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005484 if (!eap->skip && eap->addr_count > 0)
5485 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005486 if (lnum > curbuf->b_ml.ml_line_count)
5487 {
5488 // If the function deleted lines or switched to another buffer
5489 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005490 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005491 break;
5492 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005493 curwin->w_cursor.lnum = lnum;
5494 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005495 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005496 }
5497 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005498
Bram Moolenaara80faa82020-04-12 19:37:17 +02005499 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005500 funcexe.fe_firstline = eap->line1;
5501 funcexe.fe_lastline = eap->line2;
5502 funcexe.fe_doesrange = &doesrange;
5503 funcexe.fe_evaluate = !eap->skip;
5504 funcexe.fe_partial = partial;
5505 funcexe.fe_selfdict = fudi.fd_dict;
5506 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005507 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005508 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005509 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005510 {
5511 failed = TRUE;
5512 break;
5513 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005514 if (has_watchexpr())
5515 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005516
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005517 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005518 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005519 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005520 {
5521 failed = TRUE;
5522 break;
5523 }
5524
5525 clear_tv(&rettv);
5526 if (doesrange || eap->skip)
5527 break;
5528
Bram Moolenaare38eab22019-12-05 21:50:01 +01005529 // Stop when immediately aborting on error, or when an interrupt
5530 // occurred or an exception was thrown but not caught.
5531 // get_func_tv() returned OK, so that the check for trailing
5532 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005533 if (aborting())
5534 break;
5535 }
5536 if (eap->skip)
5537 --emsg_skip;
5538
Bram Moolenaar1d341892021-09-18 15:25:52 +02005539 // When inside :try we need to check for following "| catch" or "| endtry".
5540 // Not when there was an error, but do check if an exception was thrown.
5541 if ((!aborting() || did_throw)
5542 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005543 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005544 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005545 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005546 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005547 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005548 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005549 {
5550 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005551 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005553 }
5554 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005555 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005556 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005557 // Must be after using "arg", it may point into memory cleared here.
5558 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005559
5560end:
5561 dict_unref(fudi.fd_dict);
5562 vim_free(tofree);
5563}
5564
5565/*
5566 * Return from a function. Possibly makes the return pending. Also called
5567 * for a pending return at the ":endtry" or after returning from an extra
5568 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5569 * when called due to a ":return" command. "rettv" may point to a typval_T
5570 * with the return rettv. Returns TRUE when the return can be carried out,
5571 * FALSE when the return gets pending.
5572 */
5573 int
5574do_return(
5575 exarg_T *eap,
5576 int reanimate,
5577 int is_cmd,
5578 void *rettv)
5579{
5580 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005581 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005582
5583 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005584 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005585 current_funccal->returned = FALSE;
5586
5587 /*
5588 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5589 * not in its finally clause (which then is to be executed next) is found.
5590 * In this case, make the ":return" pending for execution at the ":endtry".
5591 * Otherwise, return normally.
5592 */
5593 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5594 if (idx >= 0)
5595 {
5596 cstack->cs_pending[idx] = CSTP_RETURN;
5597
5598 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005599 // A pending return again gets pending. "rettv" points to an
5600 // allocated variable with the rettv of the original ":return"'s
5601 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005602 cstack->cs_rettv[idx] = rettv;
5603 else
5604 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005605 // When undoing a return in order to make it pending, get the stored
5606 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005607 if (reanimate)
5608 rettv = current_funccal->rettv;
5609
5610 if (rettv != NULL)
5611 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005612 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005613 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5614 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5615 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005616 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005617 }
5618 else
5619 cstack->cs_rettv[idx] = NULL;
5620
5621 if (reanimate)
5622 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005623 // The pending return value could be overwritten by a ":return"
5624 // without argument in a finally clause; reset the default
5625 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005626 current_funccal->rettv->v_type = VAR_NUMBER;
5627 current_funccal->rettv->vval.v_number = 0;
5628 }
5629 }
5630 report_make_pending(CSTP_RETURN, rettv);
5631 }
5632 else
5633 {
5634 current_funccal->returned = TRUE;
5635
Bram Moolenaare38eab22019-12-05 21:50:01 +01005636 // If the return is carried out now, store the return value. For
5637 // a return immediately after reanimation, the value is already
5638 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005639 if (!reanimate && rettv != NULL)
5640 {
5641 clear_tv(current_funccal->rettv);
5642 *current_funccal->rettv = *(typval_T *)rettv;
5643 if (!is_cmd)
5644 vim_free(rettv);
5645 }
5646 }
5647
5648 return idx < 0;
5649}
5650
5651/*
5652 * Free the variable with a pending return value.
5653 */
5654 void
5655discard_pending_return(void *rettv)
5656{
5657 free_tv((typval_T *)rettv);
5658}
5659
5660/*
5661 * Generate a return command for producing the value of "rettv". The result
5662 * is an allocated string. Used by report_pending() for verbose messages.
5663 */
5664 char_u *
5665get_return_cmd(void *rettv)
5666{
5667 char_u *s = NULL;
5668 char_u *tofree = NULL;
5669 char_u numbuf[NUMBUFLEN];
5670
5671 if (rettv != NULL)
5672 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5673 if (s == NULL)
5674 s = (char_u *)"";
5675
5676 STRCPY(IObuff, ":return ");
5677 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5678 if (STRLEN(s) + 8 >= IOSIZE)
5679 STRCPY(IObuff + IOSIZE - 4, "...");
5680 vim_free(tofree);
5681 return vim_strsave(IObuff);
5682}
5683
5684/*
5685 * Get next function line.
5686 * Called by do_cmdline() to get the next line.
5687 * Returns allocated string, or NULL for end of function.
5688 */
5689 char_u *
5690get_func_line(
5691 int c UNUSED,
5692 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005693 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005694 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005695{
5696 funccall_T *fcp = (funccall_T *)cookie;
5697 ufunc_T *fp = fcp->func;
5698 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005699 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005700
Bram Moolenaare38eab22019-12-05 21:50:01 +01005701 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005702 if (fcp->dbg_tick != debug_tick)
5703 {
5704 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005705 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005706 fcp->dbg_tick = debug_tick;
5707 }
5708#ifdef FEAT_PROFILE
5709 if (do_profiling == PROF_YES)
5710 func_line_end(cookie);
5711#endif
5712
5713 gap = &fp->uf_lines;
5714 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5715 || fcp->returned)
5716 retval = NULL;
5717 else
5718 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005719 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005720 while (fcp->linenr < gap->ga_len
5721 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5722 ++fcp->linenr;
5723 if (fcp->linenr >= gap->ga_len)
5724 retval = NULL;
5725 else
5726 {
5727 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005728 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005729#ifdef FEAT_PROFILE
5730 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005731 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005732#endif
5733 }
5734 }
5735
Bram Moolenaare38eab22019-12-05 21:50:01 +01005736 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005737 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005738 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005739 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005740 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005741 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005742 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005743 fcp->dbg_tick = debug_tick;
5744 }
5745
5746 return retval;
5747}
5748
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005749/*
5750 * Return TRUE if the currently active function should be ended, because a
5751 * return was encountered or an error occurred. Used inside a ":while".
5752 */
5753 int
5754func_has_ended(void *cookie)
5755{
5756 funccall_T *fcp = (funccall_T *)cookie;
5757
Bram Moolenaare38eab22019-12-05 21:50:01 +01005758 // Ignore the "abort" flag if the abortion behavior has been changed due to
5759 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005760 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5761 || fcp->returned);
5762}
5763
5764/*
5765 * return TRUE if cookie indicates a function which "abort"s on errors.
5766 */
5767 int
5768func_has_abort(
5769 void *cookie)
5770{
5771 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5772}
5773
5774
5775/*
5776 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5777 * Don't do this when "Func" is already a partial that was bound
5778 * explicitly (pt_auto is FALSE).
5779 * Changes "rettv" in-place.
5780 * Returns the updated "selfdict_in".
5781 */
5782 dict_T *
5783make_partial(dict_T *selfdict_in, typval_T *rettv)
5784{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005785 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005786 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005787 char_u fname_buf[FLEN_FIXED + 1];
5788 int error;
5789 dict_T *selfdict = selfdict_in;
5790
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005791 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
5792 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005793 fp = rettv->vval.v_partial->pt_func;
5794 else
5795 {
5796 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005797 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005798 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005799 if (fname == NULL)
5800 {
5801 // There is no point binding a dict to a NULL function, just create
5802 // a function reference.
5803 rettv->v_type = VAR_FUNC;
5804 rettv->vval.v_string = NULL;
5805 }
5806 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00005807 {
5808 char_u *tofree = NULL;
5809
5810 // Translate "s:func" to the stored function name.
5811 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5812 fp = find_func(fname, FALSE);
5813 vim_free(tofree);
5814 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005815 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005816
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005817 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005818 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005819 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005820
5821 if (pt != NULL)
5822 {
5823 pt->pt_refcount = 1;
5824 pt->pt_dict = selfdict;
5825 pt->pt_auto = TRUE;
5826 selfdict = NULL;
5827 if (rettv->v_type == VAR_FUNC)
5828 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005829 // Just a function: Take over the function name and use
5830 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005831 pt->pt_name = rettv->vval.v_string;
5832 }
5833 else
5834 {
5835 partial_T *ret_pt = rettv->vval.v_partial;
5836 int i;
5837
Bram Moolenaare38eab22019-12-05 21:50:01 +01005838 // Partial: copy the function name, use selfdict and copy
5839 // args. Can't take over name or args, the partial might
5840 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005841 if (ret_pt->pt_name != NULL)
5842 {
5843 pt->pt_name = vim_strsave(ret_pt->pt_name);
5844 func_ref(pt->pt_name);
5845 }
5846 else
5847 {
5848 pt->pt_func = ret_pt->pt_func;
5849 func_ptr_ref(pt->pt_func);
5850 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005851 if (ret_pt->pt_argc > 0)
5852 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005853 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005854 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005855 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005856 pt->pt_argc = 0;
5857 else
5858 {
5859 pt->pt_argc = ret_pt->pt_argc;
5860 for (i = 0; i < pt->pt_argc; i++)
5861 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5862 }
5863 }
5864 partial_unref(ret_pt);
5865 }
5866 rettv->v_type = VAR_PARTIAL;
5867 rettv->vval.v_partial = pt;
5868 }
5869 }
5870 return selfdict;
5871}
5872
5873/*
5874 * Return the name of the executed function.
5875 */
5876 char_u *
5877func_name(void *cookie)
5878{
5879 return ((funccall_T *)cookie)->func->uf_name;
5880}
5881
5882/*
5883 * Return the address holding the next breakpoint line for a funccall cookie.
5884 */
5885 linenr_T *
5886func_breakpoint(void *cookie)
5887{
5888 return &((funccall_T *)cookie)->breakpoint;
5889}
5890
5891/*
5892 * Return the address holding the debug tick for a funccall cookie.
5893 */
5894 int *
5895func_dbg_tick(void *cookie)
5896{
5897 return &((funccall_T *)cookie)->dbg_tick;
5898}
5899
5900/*
5901 * Return the nesting level for a funccall cookie.
5902 */
5903 int
5904func_level(void *cookie)
5905{
5906 return ((funccall_T *)cookie)->level;
5907}
5908
5909/*
5910 * Return TRUE when a function was ended by a ":return" command.
5911 */
5912 int
5913current_func_returned(void)
5914{
5915 return current_funccal->returned;
5916}
5917
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005918 int
5919free_unref_funccal(int copyID, int testing)
5920{
5921 int did_free = FALSE;
5922 int did_free_funccal = FALSE;
5923 funccall_T *fc, **pfc;
5924
5925 for (pfc = &previous_funccal; *pfc != NULL; )
5926 {
5927 if (can_free_funccal(*pfc, copyID))
5928 {
5929 fc = *pfc;
5930 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005931 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005932 did_free = TRUE;
5933 did_free_funccal = TRUE;
5934 }
5935 else
5936 pfc = &(*pfc)->caller;
5937 }
5938 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005939 // When a funccal was freed some more items might be garbage
5940 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005941 (void)garbage_collect(testing);
5942
5943 return did_free;
5944}
5945
5946/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005947 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005948 */
5949 static funccall_T *
5950get_funccal(void)
5951{
5952 int i;
5953 funccall_T *funccal;
5954 funccall_T *temp_funccal;
5955
5956 funccal = current_funccal;
5957 if (debug_backtrace_level > 0)
5958 {
5959 for (i = 0; i < debug_backtrace_level; i++)
5960 {
5961 temp_funccal = funccal->caller;
5962 if (temp_funccal)
5963 funccal = temp_funccal;
5964 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005965 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005966 debug_backtrace_level = i;
5967 }
5968 }
5969 return funccal;
5970}
5971
5972/*
5973 * Return the hashtable used for local variables in the current funccal.
5974 * Return NULL if there is no current funccal.
5975 */
5976 hashtab_T *
5977get_funccal_local_ht()
5978{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005979 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005980 return NULL;
5981 return &get_funccal()->l_vars.dv_hashtab;
5982}
5983
5984/*
5985 * Return the l: scope variable.
5986 * Return NULL if there is no current funccal.
5987 */
5988 dictitem_T *
5989get_funccal_local_var()
5990{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005991 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005992 return NULL;
5993 return &get_funccal()->l_vars_var;
5994}
5995
5996/*
5997 * Return the hashtable used for argument in the current funccal.
5998 * Return NULL if there is no current funccal.
5999 */
6000 hashtab_T *
6001get_funccal_args_ht()
6002{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006003 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006004 return NULL;
6005 return &get_funccal()->l_avars.dv_hashtab;
6006}
6007
6008/*
6009 * Return the a: scope variable.
6010 * Return NULL if there is no current funccal.
6011 */
6012 dictitem_T *
6013get_funccal_args_var()
6014{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006015 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006016 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01006017 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006018}
6019
6020/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006021 * List function variables, if there is a function.
6022 */
6023 void
6024list_func_vars(int *first)
6025{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006026 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006027 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006028 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006029}
6030
6031/*
6032 * If "ht" is the hashtable for local variables in the current funccal, return
6033 * the dict that contains it.
6034 * Otherwise return NULL.
6035 */
6036 dict_T *
6037get_current_funccal_dict(hashtab_T *ht)
6038{
6039 if (current_funccal != NULL
6040 && ht == &current_funccal->l_vars.dv_hashtab)
6041 return &current_funccal->l_vars;
6042 return NULL;
6043}
6044
6045/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006046 * Search hashitem in parent scope.
6047 */
6048 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006049find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006050{
6051 funccall_T *old_current_funccal = current_funccal;
6052 hashtab_T *ht;
6053 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006054 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006055
6056 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6057 return NULL;
6058
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006059 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006060 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006061 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006062 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006063 ht = find_var_ht(name, &varname);
6064 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006065 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006066 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006067 if (!HASHITEM_EMPTY(hi))
6068 {
6069 *pht = ht;
6070 break;
6071 }
6072 }
6073 if (current_funccal == current_funccal->func->uf_scoped)
6074 break;
6075 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006076 }
6077 current_funccal = old_current_funccal;
6078
6079 return hi;
6080}
6081
6082/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006083 * Search variable in parent scope.
6084 */
6085 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006086find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006087{
6088 dictitem_T *v = NULL;
6089 funccall_T *old_current_funccal = current_funccal;
6090 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006091 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006092
6093 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6094 return NULL;
6095
Bram Moolenaare38eab22019-12-05 21:50:01 +01006096 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006097 current_funccal = current_funccal->func->uf_scoped;
6098 while (current_funccal)
6099 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006100 ht = find_var_ht(name, &varname);
6101 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006102 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006103 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006104 if (v != NULL)
6105 break;
6106 }
6107 if (current_funccal == current_funccal->func->uf_scoped)
6108 break;
6109 current_funccal = current_funccal->func->uf_scoped;
6110 }
6111 current_funccal = old_current_funccal;
6112
6113 return v;
6114}
6115
6116/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006117 * Set "copyID + 1" in previous_funccal and callers.
6118 */
6119 int
6120set_ref_in_previous_funccal(int copyID)
6121{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006122 funccall_T *fc;
6123
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006124 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006125 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006126 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006127 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6128 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6129 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6130 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006131 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006132 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006133}
6134
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006135 static int
6136set_ref_in_funccal(funccall_T *fc, int copyID)
6137{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006138 if (fc->fc_copyID != copyID)
6139 {
6140 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006141 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6142 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6143 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6144 || set_ref_in_func(NULL, fc->func, copyID))
6145 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006146 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006147 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006148}
6149
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006150/*
6151 * Set "copyID" in all local vars and arguments in the call stack.
6152 */
6153 int
6154set_ref_in_call_stack(int copyID)
6155{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006156 funccall_T *fc;
6157 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006158
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006159 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6160 if (set_ref_in_funccal(fc, copyID))
6161 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006162
6163 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006164 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6165 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6166 if (set_ref_in_funccal(fc, copyID))
6167 return TRUE;
6168 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006169}
6170
6171/*
6172 * Set "copyID" in all functions available by name.
6173 */
6174 int
6175set_ref_in_functions(int copyID)
6176{
6177 int todo;
6178 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006179 ufunc_T *fp;
6180
6181 todo = (int)func_hashtab.ht_used;
6182 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006183 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006184 if (!HASHITEM_EMPTY(hi))
6185 {
6186 --todo;
6187 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006188 if (!func_name_refcount(fp->uf_name)
6189 && set_ref_in_func(NULL, fp, copyID))
6190 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006191 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006192 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006193 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006194}
6195
6196/*
6197 * Set "copyID" in all function arguments.
6198 */
6199 int
6200set_ref_in_func_args(int copyID)
6201{
6202 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006203
6204 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006205 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6206 copyID, NULL, NULL))
6207 return TRUE;
6208 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006209}
6210
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006211/*
6212 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006213 * Returns TRUE if setting references failed somehow.
6214 */
6215 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006216set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006217{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006218 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006219 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006220 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006221 char_u fname_buf[FLEN_FIXED + 1];
6222 char_u *tofree = NULL;
6223 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006224 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006225
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006226 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006227 return FALSE;
6228
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006229 if (fp_in == NULL)
6230 {
6231 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006232 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006233 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006234 if (fp != NULL)
6235 {
6236 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006237 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006238 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006239
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006240 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006241 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006242}
6243
Bram Moolenaare38eab22019-12-05 21:50:01 +01006244#endif // FEAT_EVAL